fix: update benchmark so it's buildable (#731)

- move files from .js to .mjs so they are usable as modules
- shim __dirname using fileURLToPath
- add a benchmark/README.md explaining the build process (such as it is)
- update CONTRIBUTING.md to link to the new README.md
- fix backslashes in CONTRIBUTING.md

Fixes: #730

Author: srl295

benchmark/README.md

@@ -0,0 +1,33 @@
+# fast-xml-parser benchmarks
+
+Part of [fast-xml-parser](../README.md)
+
+## Building
+
+```shell
+$ npm i
+```
+
+## Testing
+
+### All Benchmarks
+
+```shell
+$ npm t
+```
+
+### Parser Benchmars
+
+```shell
+$ npm run parser
+```
+
+### Builder Benchmarks
+
+```shell
+$ npm run builder
+```
+
+## License
+
+See [../README.md](../README.md#license)

benchmark/XmlBuilder.js benchmark/XmlBuilder.mjsbenchmark/XmlBuilder.js renamed to benchmark/XmlBuilder.mjs

@@ -6,6 +6,11 @@ const suite = new Benchmark.Suite("XML Builder benchmark");
 import {XMLBuilder} from "../src/fxp.js";
 import xml2js from "xml2js";
 const xml2jsBuilder = new xml2js.Builder();
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+    
+// compatibility
+const __dirname = dirname(fileURLToPath(import.meta.url));
 
 import fs from "fs";
 import path from "path";

benchmark/XmlParser.js benchmark/XmlParser.mjsbenchmark/XmlParser.js renamed to benchmark/XmlParser.mjs

@@ -5,6 +5,11 @@ import {XMLParser} from "../src/fxp.js";
 import xml2js from "xml2js";
 import fxpv3 from "fast-xml-parser";
 import { convert } from 'xmlbuilder2';
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+    
+// compatibility
+const __dirname = dirname(fileURLToPath(import.meta.url));
 
 const suite = new Benchmark.Suite("XML Parser benchmark");
 

benchmark/package.json

@@ -4,7 +4,9 @@
   "private": true,
   "description": "Performance test",
   "scripts": {
-    "perf": "node perfTest3.js"
+    "parser": "node XmlParser.mjs",
+    "builder": "node XmlBuilder.mjs",
+    "test": "npm run parser && npm run builder && node try.mjs"
   },
   "devDependencies": {
     "benchmark": "^2.1.4",

benchmark/try.js benchmark/try.mjsbenchmark/try.js renamed to benchmark/try.mjs

@@ -2,6 +2,11 @@ import fs from "fs";
 import path from "path";
 // const fileNamePath = path.join(__dirname, "../spec/assets/test.json");//1.5k
 // const jsonData = JSON.parse(fs.readFileSync(fileNamePath).toString());
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+    
+// compatibility
+const __dirname = dirname(fileURLToPath(import.meta.url));
 
 
 // const xml2js = require("xml2js");
@@ -16,4 +21,4 @@ const xmlData = fs.readFileSync(fileNamePath).toString();
 const fxpParserForOrderedJs = new XMLParser({preserveOrder: true});
 console.log( 
     JSON.stringify(fxpParserForOrderedJs.parse(xmlData), null, 4)
-);
+);

docs/CONTRIBUTING.md

@@ -14,7 +14,8 @@ Here is the check list to publish any change
 * Changes are well discussed by raising github issue. So they are well known by other contributors and users
 * Echoing the above point. The purpose / goal for the PR should be mentioned in the description.
 * Multiple unrelated changes should not be clubbed in single PR.
-* Please run perf tests  `$ node benchmark\XmlParser.js` or `$ node benchmark\XmlBuilder.js` before and after the changes. And mention it in PR description.
+* Please run perf tests  `$ node benchmark/XmlParser.mjs` or `$ node benchmark/XmlBuilder.mjs` before and after the changes. And mention it in PR description.
+  * See [benchmark/README.md](../benchmark/README.md) for details
 * If you are adding any dependency (specially if it is not the dev dependency) please check that 
   * it is not dependent on other language packages like c/c++
   * the package is not very old, very new, discontinued, or has any vulnerability etc.