Build es6 modules (ESM) with rollup

.github/workflows/nodejs.yml

@@ -2,7 +2,7 @@
 
 name: Node CI
 
-on: 
+on:
   push:
     branches: [ main ]
   pull_request:
@@ -78,7 +78,7 @@ jobs:
           - "16"      # active LTS
           - "14"
           - "14.0.0"  # lowest supported
-        os: 
+        os:
           - ubuntu-latest
           - macos-latest
           - windows-latest

.npmignore

@@ -160,9 +160,11 @@ dist
 # TypeScript source files are intended to be shipped,
 # as they provide definition context and typing for downstream users.
 # The compiler configs are shipped, so downstream users can inherit from them.
+# So the result is a mix of binary- and source-distribution.
 !/src/
 !/tsconfig.*
 !/webpack.*
+!/rollup.*
 
 /test/
 /tests/

libs/universal-node-xml/index.js → libs/universal-node-xml/index.cjs

@@ -27,7 +27,7 @@ module.exports.stringify = undefined
 let possibleStringifier
 for (const file of possibleStringifiers) {
   try {
-    possibleStringifier = require(`./stringifiers/${file}`)
+    possibleStringifier = require(`./stringifiers/${file}.cjs`)
     if (typeof possibleStringifier === 'function') {
       module.exports.stringify = possibleStringifier
       break

libs/universal-node-xml/package.json

@@ -0,0 +1,9 @@
+{
+  "private": true,
+  "type": "commonjs",
+  "main": "./index.cjs",
+  "types": "./index.d.ts",
+  "optionalDependencies": {
+    "xmlbuilder2": "^3.0.2"
+  }
+}

libs/universal-node-xml/stringifiers/xmlbuilder2.js → libs/universal-node-xml/stringifiers/xmlbuilder2.cjs

@@ -19,7 +19,7 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
 */
 
 const { create } = require('xmlbuilder2')
-const { getNS, makeIndent } = require('./helpers')
+const { getNS, makeIndent } = require('./helpers.cjs')
 
 module.exports = typeof create === 'function'
   ? stringify

libs/universal-node-xml/stringifiers/xmlbuilder2.spec.js → libs/universal-node-xml/stringifiers/xmlbuilder2.spec.cjs

@@ -21,7 +21,7 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
 const assert = require('assert')
 const { suite, test } = require('mocha')
 
-const stringify = require('./xmlbuilder2')
+const stringify = require('./xmlbuilder2.cjs')
 
 suite('stringify with xmlbuilder2', () => {
   assert.strictEqual(typeof stringify, 'function')

package.json

@@ -45,6 +45,7 @@
     "xmlbuilder2": "^3.0.2"
   },
   "devDependencies": {
+    "@rollup/plugin-typescript": "^8.5.0",
     "@types/mocha": "^9.1.1",
     "@types/node": ">=14",
     "@types/webpack": "^5.28.0",
@@ -54,16 +55,18 @@
     "eslint-plugin-simple-import-sort": "^8.0.0",
     "mocha": "10.0.0",
     "npm-run-all": "^4.1.5",
+    "rollup": "^2.79.0",
     "ts-loader": "9.3.1",
+    "tslib": "^2.4.0",
     "typescript": "4.8.2",
     "webpack": "5.74.0",
     "webpack-cli": "4.10.0",
     "xmlbuilder2": "^3.0.2"
   },
   "browser": "./dist.web/lib.js",
   "types": "./src/index.node.ts",
-  "main": "./dist.node/index.node.js",
-  "exports": "./dist.node/index.node.js",
+  "main": "./dist.node/lib.cjs",
+  "module": "./dist.node/lib.mjs",
   "directories": {
     "doc": "./docs",
     "src": "./src",
@@ -77,7 +80,7 @@
     "lint": "tsc --noEmit",
     "build": "run-p --aggregate-output -l build:*",
     "prebuild:node": "node -r fs -e 'fs.rmSync(\"dist.node\",{recursive:true,force:true})'",
-    "build:node": "tsc -b ./tsconfig.node.json",
+    "build:node": "rollup -c rollup.config.js",
     "prebuild:web": "node -r fs -e 'fs.rmSync(\"dist.web\",{recursive:true,force:true})'",
     "build:web": "webpack build",
     "cs-fix": "eslint --fix .",

rollup.config.js

@@ -0,0 +1,54 @@
+const typescript = require('@rollup/plugin-typescript')
+
+/**
+ * @see {@link https://rollupjs.org}
+ * @type {import('rollup').RollupOptions}
+ */
+module.exports = {
+  input: 'src/index.node.ts',
+  external: [
+    // region own shipped
+    /\.\/(?:libs|res)\//,
+    // endregion own shipped
+    // region externals dependencies
+    'packageurl-js'
+    // endregion externals dependencies
+  ],
+  treeshake: false,
+  output: [
+    {
+      file: 'dist.node/lib.cjs',
+      format: 'cjs',
+      strict: true,
+      sourcemap: false,
+      compact: true
+    },
+    {
+      file: 'dist.node/lib.dev.cjs',
+      format: 'cjs',
+      strict: true,
+      sourcemap: true,
+      compact: false
+    },
+    {
+      file: 'dist.node/lib.mjs',
+      format: 'esm',
+      strict: true,
+      sourcemap: false,
+      compact: true
+    },
+    {
+      file: 'dist.node/lib.dev.mjs',
+      format: 'esm',
+      strict: true,
+      sourcemap: true,
+      compact: false
+    }
+  ],
+  plugins: [
+    typescript({
+      tsconfig: 'tsconfig.node.json',
+      sourceMap: true
+    })
+  ]
+}