Merge branch 'release/6.2.0'

Author: tuananh

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"

.github/workflows/ci.yaml

@@ -9,7 +9,7 @@ jobs:
             fail-fast: false
             matrix:
                 os: [ubuntu-latest, macos-latest, windows-latest]
-                node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x]
+                node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x, 18.x]
         runs-on: ${{matrix.os}}
         steps:
             - uses: actions/checkout@v2
@@ -20,4 +20,4 @@ jobs:
             - name: Install Dependencies
               run: npm install
             - name: Test
-              run: npm test
+              run: npm test

README.md

@@ -2,11 +2,10 @@
 
 > camaro is an utility to transform XML to JSON, using Node.js binding to native XML parser [pugixml](http://pugixml.org/), one of the fastest XML parser around.
 
-[![npm](https://webadge.dev/npm/v/camaro)](https://npm.im/camaro)
-![npm bundle size](https://webadge.dev/packagephobia/publish/camaro)
+[![npm](https://raster.shields.io/npm/v/camaro)](https://npm.im/camaro)
 ![Build status](https://github.com/tuananh/camaro/workflows/CI/badge.svg)
-[![TypeScript definitions on DefinitelyTyped](https://webadge.dev/badge/DefinitelyTyped/.d.ts)](http://definitelytyped.org)
-[![npm](https://webadge.dev/npm/dt/camaro)](https://npm.im/camaro)
+[![npm](https://raster.shields.io/npm/dt/camaro)](https://npm.im/camaro)
+[![license](https://raster.shields.io/npm/l/camaro)](https://npm.im/camaro)
 
 ## 🤘 Features
 
@@ -185,6 +184,10 @@ And output of `prettyPrint()`
 
 ...
 
+## Stargazers over time
+
+[![Stargazers over time](https://starchart.cc/tuananh/camaro.svg)](https://starchart.cc/tuananh/camaro)
+
 ## Licence
 
 [The MIT License](LICENSE)

benchmark/index.md benchmark/README.mdbenchmark/index.md renamed to benchmark/README.md

@@ -2,22 +2,17 @@
 
 Never mind about the actual number. You can check the percentage differences between package for reference.
 
-Benchmark ran on Macbook 16".
-
 ## transform()
 
 `node benchmark/transform`
 
-```
-camaro v6: 1,395.6 ops/sec
-fast-xml-parser: 153 ops/sec
-xml2js: 47.6 ops/sec
-xml-js: 51 ops/sec
-```
+Benchmark scenario:
+- 10,000 iterations
+- 4 different input size: 7KB/ 60KB / 100KB and 300KB. Test inputs are included in `fixtures` folder.
+- Output is average no. of ops per second.
+- Machine specs: AMD 4650G 6 cores - 12 threads/ 32GB memory
 
-I have included the test for various XML file sizes: 300KB/ 100KB / 60KB and 7KB. As you can see `camaro` is not very good with small XML file. However, it excels with big XML file.
-
-The tested XML files are included in `benchmarks/fixtures` folder.
+As you can see `camaro` is not very good with small XML file. However, it excels with big XML file.
 
 300 KB XML file            |  100 KB XML file
 :-------------------------:|:-------------------------:
@@ -37,4 +32,4 @@ The tested XML files are included in `benchmarks/fixtures` folder.
 camaro v6: 62,363.2 ops/sec
 pretty-data: 141,257.8 ops/sec
 prettifyXml: 258,408 ops/sec
-```
+```

benchmark/chart.html

@@ -13,17 +13,19 @@
                 data: {
                     labels: [
                         'camaro v6',
+                        'txml w/ piscina',
+                        'fast-xml-parser w/ piscina',
                         'fast-xml-parser',
                         'xml2js',
                         'xml-js',
                     ],
                     datasets: [
                         {
                             label: 'ops/sec',
-                            // data: [1820, 295, 52, 52], // 306kb
-                            data: [3539, 864, 148, 144], // 109kb
-                            // data: [4840, 1542, 266, 265], // 60kb
-                            // data: [6215, 9328, 2108, 2099], // 7kb
+                            data: [1780, 1356, 565, 129, 50, 55], // 306kb
+                            // data: [4237, 3320, 1586, 392, 137, 142], // 109kb
+                            // data: [6112, 5757, 2637, 766, 260, 282], // 60kb
+                            // data: [13193, 17422, 11148, 6720, 1955, 1990], // 7kb
                             backgroundColor: [
                                 'rgba(255, 99, 132, 0.2)',
                                 'rgba(54, 162, 235, 0.2)',

benchmark/fixtures/100kb.png

@@ -1,8 +1,14 @@
 const fs = require('fs')
+const { resolve } = require('path')
 const { transform } = require('..')
-const fastXmlParser = require('fast-xml-parser')
+const { XMLParser } = require('fast-xml-parser')
 const xml2js = require('xml2js')
 const xmljs = require('xml-js')
+const WorkerPool = require('piscina')
+const fastXmlParser = new XMLParser()
+
+const txmlWorkerPool = new WorkerPool({ filename: resolve(__dirname, 'workers/txml.js') });
+const fxpWorkerPool = new WorkerPool({ filename: resolve(__dirname, 'workers/fast-xml-parser.js') });
 
 /**
  *
@@ -36,7 +42,7 @@ async function bench({ name = '', fn, iterations = 10000, async = false } = {})
     }
 }
 
-const xml = fs.readFileSync(__dirname + '/./fixtures/100kb.xml', 'utf-8')
+const xml = fs.readFileSync(__dirname + '/./fixtures/300kb.xml', 'utf-8')
 const template = {
     cache_key: '/HotelListResponse/cacheKey',
     hotels: [
@@ -67,10 +73,14 @@ const template = {
 async function runBenchmarks() {
     await bench({
         name: 'camaro v6',
-        fn: () => transform(xml, template),
+        fn: async () => transform(xml, template),
         async: true,
     })
 
+    await bench({name: 'txml worker', async: true, fn: async () => txmlWorkerPool.run(xml) });
+
+    await bench({name: 'fast-xml-parser worker', async: true, fn: async () => fxpWorkerPool.run(xml)});
+
     await bench({name: 'fast-xml-parser', fn: () => fastXmlParser.parse(xml)})
 
     await bench({name: 'xml2js', fn: () => xml2js.parseString(xml) })