feat!: Add esm named export support (closes #160 closes #139)

Added wrapper for esm over CJS module and removed nonworking separate ESM build (per advice from url below).

Note: Essentially a breaking change as `exports` package.json property prevents direct import from files in dist

see: https://redfin.engineering/node-modules-at-war-why-commonjs-and-es-modules-cant-get-along-9617135eeca1

Author: nonara

.eslintignore

@@ -1,3 +1,4 @@
 test/
 dist/
 node_modules/
+esm/

esm/index.js

@@ -0,0 +1,11 @@
+import nhp from '../dist/index.js'
+
+export const CommentNode = nhp.CommentNode;
+export const HTMLElement = nhp.HTMLElement;
+export const parse = nhp.parse;
+export const valid = nhp.valid;
+export const Node = nhp.Node;
+export const TextNode = nhp.TextNode;
+export const NodeType = nhp.NodeType;
+
+export default nhp;

esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package.json

@@ -3,18 +3,16 @@
 	"version": "4.1.5",
 	"description": "A very fast HTML parser, generating a simplified DOM, with basic element query support.",
 	"main": "dist/index.js",
-	"module": "dist/esm/index.js",
 	"types": "dist/index.d.ts",
 	"scripts": {
 		"test": "mocha",
 		"lint": "eslint ./src/*.ts ./src/**/*.ts",
 		"clean": "del-cli ./dist/",
 		"ts:cjs": "tsc -m commonjs",
 		"ts:amd": "tsc -t es5 -m amd -d false --outFile ./dist/main.js",
-		"ts:esm": "tsc -t es2019 -m esnext -d false --outDir ./dist/esm/",
-		"build": "npm run lint && npm run clean && npm run ts:cjs && npm run ts:amd && npm run ts:esm",
+		"build": "npm run lint && npm run clean && npm run ts:cjs && npm run ts:amd",
 		"dev": "tsc -w & mocha -w ./test/*.js",
-		"pretest": "tsc -m commonjs",
+		"pretest": "tsc -m commonjs && cd test/assets && yarn install",
 		"release": "yarn build && np",
 		"prepare": "npm run build"
 	},
@@ -60,6 +58,7 @@
 		"should": "latest",
 		"spec": "latest",
 		"travis-cov": "latest",
+		"ts-node": "^10.2.1",
 		"typescript": "next"
 	},
 	"config": {
@@ -84,5 +83,9 @@
 		"url": "https://github.com/taoqf/node-fast-html-parser/issues"
 	},
 	"homepage": "https://github.com/taoqf/node-fast-html-parser",
-	"sideEffects": false
+	"sideEffects": false,
+	"exports": {
+		"require": "./dist/index.js",
+		"import": "./esm/index.js"
+	}
 }

test/assets/cjs/index.ts

@@ -0,0 +1,4 @@
+import { parse } from 'node-html-parser'
+
+const res = parse('<a href="#">parse succeeded</a>');
+console.log(res.firstChild.text);

test/assets/cjs/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "cjs-test",
+  "private": true,
+  "type": "commonjs",
+  "peerDependencies": {
+    "node-html-parser": "*"
+  }
+}

test/assets/cjs/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "files": [ "index.ts" ],
+  "extends": "../tsconfig.base.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "module": "CommonJS",
+    "moduleResolution": "node"
+  }
+}

test/assets/esm/index.ts

@@ -0,0 +1,4 @@
+import { parse } from 'node-html-parser'
+
+const res = parse('<a href="#">parse succeeded</a>');
+console.log(res.firstChild.text);

test/assets/esm/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "esm-test",
+  "private": true,
+  "type": "module",
+  "peerDependencies": {
+    "node-html-parser": "*"
+  }
+}

test/assets/esm/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "files": [ "index.ts" ],
+  "extends": "../tsconfig.base.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "module": "ESNext",
+    "moduleResolution": "node"
+  }
+}

test/assets/package.json

@@ -0,0 +1,9 @@
+{
+  "private": true,
+  "workspaces": [
+    "assets/*"
+  ],
+  "dependencies": {
+    "node-html-parser": "link:../.."
+  }
+}

test/assets/tsconfig.base.json

@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "skipDefaultLibCheck": true,
+    "skipLibCheck": true,
+    "noLib": true
+  }
+}

test/import.js

@@ -0,0 +1,20 @@
+const { execSync }  = require('child_process');
+const path  = require('path');
+
+describe(`Module Import`, function () {
+  this.timeout(20000);
+
+  it(`ESM project can import and use named exports`, () => {
+    execSync('node --loader ts-node/esm index.ts', {
+      cwd: path.resolve(__dirname, 'assets/esm'),
+      stdio: "pipe"
+    }).toString().should.eql('parse succeeded\n')
+  });
+
+  it(`CommonJS project can import and use named exports`, () => {
+    execSync('node -r ts-node/register index.ts', {
+      cwd: path.resolve(__dirname, 'assets/cjs'),
+      stdio: "pipe"
+    }).toString().should.eql('parse succeeded\n')
+  });
+});