refactor: Organized tests + added ability to test src or dist

Author: nonara

.mocharc.yaml

@@ -1 +1 @@
-require: blanket,should,spec
+require: blanket,should,spec,"ts-node/register"

package.json

@@ -5,16 +5,21 @@
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"scripts": {
-		"test": "mocha",
+        "compile": "tsc",
+        "build": "npm run lint && npm run clean && npm run compile:cjs && npm run compile:amd",
+        "compile:cjs": "tsc -m commonjs",
+        "compile:amd": "tsc -t es5 -m amd -d false --outFile ./dist/main.js",
+        "---------------": "",
+		"test": "mocha ./test/tests/**/*.js",
+		"test:src": "cross-env TEST_TARGET=src mocha ./test/tests",
+		"test:dist": "cross-env TEST_TARGET=dist mocha ./test/tests",
+        "benchmark": "node ./test/benchmark/compare.mjs",
+        "---------------  ": "",
 		"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",
-		"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 && cd test/assets && yarn install",
-		"release": "yarn build && np",
-		"prepare": "npm run build"
+        "--------------- ": "",
+        "posttest": "yarn run benchmark",
+		"prepare": "cd test && yarn install"
 	},
 	"keywords": [
 		"parser",
@@ -60,7 +65,8 @@
 		"standard-version": "^9.3.1",
 		"travis-cov": "latest",
 		"ts-node": "^10.2.1",
-		"typescript": "next"
+		"typescript": "latest",
+        "cross-env": "^7.0.3"
 	},
 	"config": {
 		"blanket": {

test/html/ffmpeg.html renamed to test/assets/html/ffmpeg.html

@@ -4875,10 +4875,10 @@ <h2>
 
 </main>
 <footer class="footer" id="footer-block">
- <div><style>
-.card[_ngcontent-serverApp-c65] .card__info[_ngcontent-serverApp-c65] .card__superstars[_ngcontent-serverApp-c65] .card__superstars-comment[_ngcontent-serverApp-c65] .custom-icon[_ngcontent-serverApp-c65] {
-    fill: #bbbbbb;
-}
+ <div><style>
+.card[_ngcontent-serverApp-c65] .card__info[_ngcontent-serverApp-c65] .card__superstars[_ngcontent-serverApp-c65] .card__superstars-comment[_ngcontent-serverApp-c65] .custom-icon[_ngcontent-serverApp-c65] {
+    fill: #bbbbbb;
+}
 </style></div>
  <div class="footer__blue container">
 <div class="footer__container">

test/html/gmail.html renamed to test/assets/html/gmail.html

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

test/html/google.html renamed to test/assets/html/google.html

@@ -1,5 +1,6 @@
 {
   "name": "cjs-test",
+  "version": "0.0.0",
   "private": true,
   "type": "commonjs",
   "peerDependencies": {

test/html/hillcrestpartyrentals.html renamed to test/assets/html/hillcrestpartyrentals.html

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

test/html/incomplete-script renamed to test/assets/html/incomplete-script

@@ -1,6 +1,7 @@
 {
   "name": "esm-test",
   "private": true,
+  "version": "0.0.0",
   "type": "module",
   "peerDependencies": {
     "node-html-parser": "*"

test/html/nice.html renamed to test/assets/html/nice.html

@@ -0,0 +1 @@
+export * from 'nhp/src'

test/html/tables.html renamed to test/assets/html/tables.html

@@ -0,0 +1,8 @@
+/**
+ * The following dynamically loads either the built or uncompiled source code (based on TEST_TARGET env var) when require'd
+ */
+const path = require('path');
+
+const target = process.env.TEST_TARGET === 'dist' || process.env.CI ? 'dist' : 'src';
+
+module.exports = require(`../../../../${target}`);

test/html/view-source_https___epicentrk.ua_shop_kirpich-ogneupornyy_.html renamed to test/assets/html/view-source_https___epicentrk.ua_shop_kirpich-ogneupornyy_.html

@@ -0,0 +1,8 @@
+{
+  "name": "node-html-parser",
+  "description": "wrapper",
+  "version": "0.0.0",
+  "private": true,
+  "main": "index.js",
+  "types": "index.d.ts"
+}

test/assets/package.json

@@ -0,0 +1,11 @@
+import benchmark from 'htmlparser-benchmark';
+import node_html_parser from '@test/last-release';
+
+var bench = benchmark(function (html, callback) {
+    node_html_parser.parse(html);
+    callback();
+});
+
+bench.on('result', function (stat) {
+    console.log('node-html-parser (last release):' + stat.mean().toPrecision(6) + ' ms/file ± ' + stat.sd().toPrecision(6));
+});

test/assets/cjs/index.ts renamed to test/assets/packages/cjs/index.ts

@@ -1,5 +1,5 @@
 import benchmark from 'htmlparser-benchmark';
-import node_html_parser from '../dist/index.js';
+import node_html_parser from '@test/root';
 
 // const { parse } = node_html_parser;
 

test/assets/cjs/package.json renamed to test/assets/packages/cjs/package.json

@@ -1,5 +1,7 @@
 import './compare-node-html-parser.mjs'
+import './compare-nhp-last.mjs'
 import './compare-high5.mjs'
 import './compare-htmlparser.mjs'
 import './compare-htmlparser2.mjs'
 import './compare-parse5.mjs'
+import './compare-cheerio.mjs'

test/assets/cjs/tsconfig.json renamed to test/assets/packages/cjs/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "private": true,
+  "workspaces": [
+    "packages/*"
+  ],
+  "dependencies": {
+    "@test/test-target": "link:assets/packages/wrapper",
+    "@test/root": "link:../",
+    "@test/last-release": "npm:node-html-parser@latest"
+  }
+}

test/assets/esm/index.ts renamed to test/assets/packages/esm/index.ts

@@ -1,4 +1,4 @@
-const { parse } = require('../dist');
+const { parse } = require('@test/test-target');
 
 // https://github.com/taoqf/node-html-parser/issues/75
 describe('query should be case insensitive', function () {

test/assets/esm/package.json renamed to test/assets/packages/esm/package.json

@@ -1,4 +1,4 @@
-const { parse } = require('../dist');
+const { parse } = require('@test/test-target');
 
 // https://github.com/taoqf/node-html-parser/issues/95
 describe('empty attribute', function () {

test/assets/esm/tsconfig.json renamed to test/assets/packages/esm/tsconfig.json

@@ -1,14 +1,9 @@
 const should = require('should');
 const fs = require('fs');
 
-const HTMLParser = require('../dist');
-const HTMLElement = require('../dist/nodes/html').default;
-const TextNode = require('../dist/nodes/text').default;
-const CommentNode = require('../dist/nodes/comment').default;
+const { parse: parseHTML, HTMLElement, TextNode, CommentNode } = require('@test/test-target');
 
 describe('HTML Parser', function () {
-	const parseHTML = HTMLParser.parse;
-
 	describe('parse()', function () {
 		it('should parse "<p id=\\"id\\"><a class=\'cls\'>Hello</a><ul><li><li></ul><span></span></p>" and return root element', function () {
 
@@ -135,7 +130,7 @@ describe('HTML Parser', function () {
 
 		it('should be able to parse "html/incomplete-script" file', function () {
 
-			const root = parseHTML(fs.readFileSync(__dirname + '/html/incomplete-script').toString(), {
+			const root = parseHTML(fs.readFileSync(__dirname + '/../assets/html/incomplete-script').toString(), {
 				script: true
 			});
 
@@ -165,11 +160,11 @@ describe('HTML Parser', function () {
 		// Test for broken tags. <h3>something<h3>
 
 		it('should parse "<div><h3>content<h3> <span> other <span></div>" (fix h3, span closing tag) very fast', function () {
-			const root = parseHTML(fs.readFileSync(__dirname + '/html/incomplete-script').toString());
+			const root = parseHTML(fs.readFileSync(__dirname + '/../assets/html/incomplete-script').toString());
 		});
 
 		it('should parse table currect', function () {
-			const root = parseHTML(fs.readFileSync(__dirname + '/html/tables.html').toString(), {
+			const root = parseHTML(fs.readFileSync(__dirname + '/../assets/html/tables.html').toString(), {
 				script: true
 			});
 			const tables = root.querySelectorAll('table');

test/assets/tsconfig.base.json renamed to test/assets/packages/tsconfig.base.json

@@ -6,14 +6,14 @@ describe(`Module Import`, function () {
 
   it(`ESM project can import and use named exports`, () => {
     execSync('node --loader ts-node/esm index.ts', {
-      cwd: path.resolve(__dirname, 'assets/esm'),
+      cwd: path.resolve(__dirname, '../assets/packages/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'),
+      cwd: path.resolve(__dirname, '../assets/packages/cjs'),
       stdio: "pipe"
     }).toString().should.eql('parse succeeded\n')
   });

test/assets/packages/wrapper/index.d.ts

@@ -1,4 +1,4 @@
-const { parse } = require('../dist');
+const { parse } = require('@test/test-target');
 
 describe('#querySelectorAll', function () {
 	it('nothing mached', function () {

test/assets/packages/wrapper/index.js

@@ -1,4 +1,4 @@
-const { parse } = require('../dist');
+const { parse } = require('@test/test-target');
 const fs = require('fs');
 
 describe.skip('Memory leak', function () {
@@ -8,7 +8,7 @@ describe.skip('Memory leak', function () {
 		let i = 0;
 		const cat = {};
 		// const cat = {};
-		const content = fs.readFileSync(__dirname + '/html/view-source_https___epicentrk.ua_shop_kirpich-ogneupornyy_.html', 'utf-8');
+		const content = fs.readFileSync(__dirname + '/../assets/html/view-source_https___epicentrk.ua_shop_kirpich-ogneupornyy_.html', 'utf-8');
 		while (++i < 10000) {
 			let root = parse(content);
 			const parent = Math.random().toString();

test/assets/packages/wrapper/package.json

@@ -1,4 +1,4 @@
-const { parse } = require('../dist');
+const { parse } = require('@test/test-target');
 
 describe('self-close tag', function () {
 	it('should not teat textarea as self-colse tag', async function () {

test/compare-cheerio.mjs renamed to test/benchmark/compare-cheerio.mjs

@@ -1,4 +1,4 @@
-const { parse, HTMLElement } = require('../dist');
+const { parse, HTMLElement } = require('@test/test-target');
 
 // https://github.com/taoqf/node-html-parser/pull/112
 describe('pull/112', function () {

test/compare-high5.mjs renamed to test/benchmark/compare-high5.mjs

@@ -1,4 +1,4 @@
-const { parse } = require('../dist');
+const { parse } = require('@test/test-target');
 
 describe('issue 115', function () {
 	it('parse html', async function () {

test/compare-htmlparser.mjs renamed to test/benchmark/compare-htmlparser.mjs

@@ -1,4 +1,4 @@
-const { parse } = require('../dist');
+const { parse } = require('@test/test-target');
 
 // https://github.com/taoqf/node-html-parser/pull/112
 describe('issue 119 closest', function () {

test/compare-htmlparser2.mjs renamed to test/benchmark/compare-htmlparser2.mjs

@@ -1,4 +1,4 @@
-const { parse } = require('../dist');
+const { parse } = require('@test/test-target');
 
 // see: https://github.com/taoqf/node-html-parser/issues/129
 describe('Prototype pollution', () => {

test/benchmark/compare-nhp-last.mjs

@@ -1,4 +1,4 @@
-const { parse } = require('../dist');
+const { parse } = require('@test/test-target');
 
 describe('pr 135', function () {
 	it('shoud not decode text', function () {

test/compare-node-html-parser.mjs renamed to test/benchmark/compare-node-html-parser.mjs

@@ -1,4 +1,4 @@
-const { parse } = require('../dist');
+const { parse } = require('@test/test-target');
 
 describe('issue 136', function () {
 	it('parse the parent html tag when its attributes has an html tag on it', function () {

test/compare-parse5.mjs renamed to test/benchmark/compare-parse5.mjs

@@ -1,4 +1,4 @@
-const { parse, NodeType } = require('../dist');
+const { parse, NodeType } = require('@test/test-target');
 
 // Also see comments on https://github.com/taoqf/node-html-parser/pull/148 for additional issues corrected
 describe('issue 144', function () {

test/compare.mjs renamed to test/benchmark/compare.mjs

@@ -1,4 +1,4 @@
-const { parse } = require('../dist');
+const { parse } = require('@test/test-target');
 
 describe('issue 145', function () {
 	it('shoud parse attributes right', function () {

test/package.json

@@ -1,4 +1,4 @@
-const { parse } = require('../dist');
+const { parse } = require('@test/test-target');
 
 describe.skip('issue 152', function () {
 	it('shoud parse attributes right', function () {

test/caseinsensitive.js renamed to test/tests/caseinsensitive.js

@@ -1,4 +1,4 @@
-const { parse } = require('../dist');
+const { parse } = require('@test/test-target');
 
 describe('issues/28', function () {
 	it('query with dl > dt', function () {

test/emptyattribute.js renamed to test/tests/emptyattribute.js

@@ -1,4 +1,4 @@
-const { parse } = require('../dist');
+const { parse } = require('@test/test-target');
 
 // https://github.com/taoqf/node-html-parser/issues/41
 describe('#exchangeChild()', function () {

test/html.js renamed to test/tests/html.js

@@ -1,4 +1,4 @@
-const { parse } = require('../dist');
+const { parse } = require('@test/test-target');
 
 describe('issue 42', function () {
 	it('svg attribute', function () {

test/import.js renamed to test/tests/import.js

@@ -1,4 +1,4 @@
-const { parse } = require('../dist');
+const { parse } = require('@test/test-target');
 
 describe('issue 48', function () {
 	it('get decoded text', function () {

test/100.js renamed to test/tests/issues/100.js

@@ -1,4 +1,4 @@
-const { parse } = require('../dist');
+const { parse } = require('@test/test-target');
 
 describe('issue 51', function () {
 	it('vue: > in attibute value', function () {