Add dual support for ESM and CommonJS

- Convert from CommonJS to ESM
- Generate CommonJS from ESM at build time
- Test using CommonJS
- Remains compatible with Node.js 14 onwards

Co-authored-by: Lovell Fuller <[email protected]>

Author: salomaosnff

.gitignore

@@ -2,3 +2,4 @@ coverage
 node_modules
 package-lock.json
 .nyc_output
+lib/limax.cjs

lib/index.cjs

@@ -0,0 +1 @@
+module.exports = require("./limax.cjs").default;

lib/limax.js renamed to lib/limax.mjs

@@ -3,17 +3,17 @@
 
 'use strict';
 
-const speakingurl = require('speakingurl');
-const hepburn = require('hepburn');
-const deburr = require('lodash.deburr');
-const { pinyin } = require('pinyin-pro');
+import speakingurl from 'speakingurl';
+import hepburn from 'hepburn';
+import deburr from 'lodash.deburr';
+import { pinyin } from 'pinyin-pro';
 
 function customCharsAsArray (custom) {
   custom = custom || [];
   return Array.isArray(custom) ? custom : Object.keys(custom);
 }
 
-module.exports = function (text, opt) {
+export default function limax (text, opt) {
   const options = typeof opt === 'string'
     ? { separator: opt }
     : opt || {};
@@ -70,4 +70,4 @@ module.exports = function (text, opt) {
   return mergeDigitSuffixes
     ? slug.replace(/([^0-9])-([0-9])/g, '$1$2')
     : slug;
-};
+}

package.json

@@ -6,7 +6,7 @@
   "description": "Node.js module to generate URL slugs. Another one? This one cares about i18n and transliterates non-Latin scripts to conform to the RFC3986 standard. Mostly API-compatible with similar modules.",
   "repository": {
     "type": "git",
-    "url": "git://github.com/lovell/limax"
+    "url": "git://github.com/lovell/limax.git"
   },
   "engines": {
     "node": ">=14"
@@ -16,8 +16,14 @@
     "index.d.ts",
     "lib/"
   ],
+  "exports": {
+    "import": "./lib/limax.mjs",
+    "require": "./lib/index.cjs"
+  },
+  "type": "module",
   "scripts": {
-    "test": "semistandard && nyc --reporter=html ava",
+    "build": "esbuild lib/limax.mjs --format=cjs --outfile=lib/limax.cjs",
+    "test": "semistandard lib/limax.mjs && npm run build && nyc --reporter=html ava test/unit.cjs",
     "changelog": "conventional-changelog -i CHANGELOG.md -s"
   },
   "keywords": [
@@ -55,6 +61,7 @@
   "devDependencies": {
     "ava": "^5.2.0",
     "conventional-changelog-cli": "^2.2.2",
+    "esbuild": "^0.25.10",
     "nyc": "^15.1.0",
     "semistandard": "^16.0.1"
   }

test/unit.js renamed to test/unit.cjs

@@ -4,7 +4,7 @@
 'use strict';
 
 const ava = require('ava');
-const limax = require('../lib/limax');
+const limax = require('../lib/index');
 
 const tests = {
   'i ♥ latin': 'i-love-latin',