feat: publish hybrid package: CommonJS and ESM modules

mdevils · mdevils · commit 16fd8a1b1b4b · 2023-06-24T23:47:06.000+02:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -16,4 +16,4 @@ jobs:
       - run: npm run lint
       - run: npm run test
       - run: npm run build
-      - run: npm run test:lib
+      - run: npm run test:dist
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,3 @@
 npm-debug.log
 node_modules
-/lib
+/dist
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -29,11 +29,9 @@
   "devDependencies": {
     "@commitlint/cli": "^17.6.6",
     "@commitlint/config-conventional": "^17.6.6",
-    "@types/colors": "^1.2.1",
     "@types/jest": "^29.5.2",
     "@typescript-eslint/eslint-plugin": "^5.60.0",
     "@typescript-eslint/parser": "^5.60.0",
-    "colors": "*",
     "eslint": "^8.43.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-import": "^2.27.5",
@@ -52,15 +50,22 @@
     "type": "git",
     "url": "https://github.com/mdevils/css-selector-parser.git"
   },
-  "main": "./lib/index.js",
-  "typings": "./lib/index",
-  "types": "./lib/index",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/mjs/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/mjs/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "typings": "./dist/cjs/index",
+  "types": "./dist/cjs/index",
   "license": "MIT",
   "scripts": {
-    "build": "tsc",
+    "build": "rm -Rf dist && tsc -p tsconfig.json && tsc -p tsconfig.mjs.json && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json && echo '{\"type\": \"module\"}' > dist/mjs/package.json",
     "build:docs": "rm -Rf docs && typedoc --excludeInternal --excludeExternals --disableSources --plugin typedoc-plugin-markdown --entryDocument ../README.md --out docs src/index.ts && ts-node tools/cleanup-docs.ts",
     "test": "jest test",
-    "test:lib": "TEST_LIB=1 npm run test",
+    "test:dist": "TEST_DIST=cjs npm run test",
     "lint": "eslint src/**.ts",
     "lint:fix": "eslint --fix src/**.ts",
     "benchmark": "ts-node benchmark/benchmark.ts",
diff --git a/test/import.ts b/test/import.ts
@@ -1,6 +1,8 @@
 import * as Lib from '../src';
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const {ast, render, createParser} = require(process.env.TEST_LIB ? '../lib' : '../src') as typeof Lib;
+const {ast, render, createParser} = require(process.env.TEST_DIST
+    ? `../dist/${process.env.TEST_DIST}`
+    : '../src') as typeof Lib;
 
 export {ast, render, createParser};
diff --git a/tsconfig.json b/tsconfig.json
@@ -3,7 +3,7 @@
     "target": "es5",
     "module": "commonjs",
     "declaration": true,
-    "outDir": "./lib",
+    "outDir": "dist/cjs",
     "strict": true
   },
   "include": ["src"],
diff --git a/tsconfig.mjs.json b/tsconfig.mjs.json
@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist/mjs",
+    "module": "esnext",
+    "target": "esnext",
+    "skipLibCheck": true
+  }
+}
