feat: provide an ESM build with and without debug

darrachequesne · darrachequesne · commit 388c616a9221 · 2021-10-11T22:35:12.000+02:00
See also: socketio/engine.io-client@00d7e7d
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 node_modules
 dist/
+build/
diff --git a/lib/binary.ts b/lib/binary.ts
@@ -1,4 +1,4 @@
-import { isBinary } from "./is-binary";
+import { isBinary } from "./is-binary.js";
 
 /**
  * Replaces every Buffer | ArrayBuffer | Blob | File in packet with a numbered placeholder.
diff --git a/lib/index.ts b/lib/index.ts
@@ -1,8 +1,9 @@
-import Emitter = require("component-emitter");
-import { deconstructPacket, reconstructPacket } from "./binary";
-import { isBinary, hasBinary } from "./is-binary";
+import Emitter from "@socket.io/component-emitter";
+import { deconstructPacket, reconstructPacket } from "./binary.js";
+import { isBinary, hasBinary } from "./is-binary.js";
+import debugModule from "debug"; // debug()
 
-const debug = require("debug")("socket.io-parser");
+const debug = debugModule("socket.io-parser"); // debug()
 
 /**
  * Protocol version.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -7,13 +7,20 @@
     "url": "https://github.com/socketio/socket.io-parser.git"
   },
   "files": [
-    "dist/"
+    "build/"
   ],
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "main": "./build/cjs/index.js",
+  "module": "./build/esm/index.js",
+  "types": "./build/esm/index.d.ts",
+  "exports": {
+    "import": {
+      "node": "./build/esm-debug/index.js",
+      "default": "./build/esm/index.js"
+    },
+    "require": "./build/cjs/index.js"
+  },
   "dependencies": {
-    "@types/component-emitter": "^1.2.10",
-    "component-emitter": "~1.3.0",
+    "@socket.io/component-emitter": "~2.0.0",
     "debug": "~4.3.1"
   },
   "devDependencies": {
@@ -33,7 +40,7 @@
     "zuul-ngrok": "4.0.0"
   },
   "scripts": {
-    "compile": "rimraf ./dist && tsc",
+    "compile": "rimraf ./build && tsc && tsc -p tsconfig.esm.json && ./postcompile.sh",
     "test": "npm run format:check && npm run compile && if test \"$BROWSERS\" = \"1\" ; then npm run test:browser; else npm run test:node; fi",
     "test:node": "mocha --reporter dot --bail test/index.js",
     "test:browser": "zuul test/index.js --no-coverage",
diff --git a/postcompile.sh b/postcompile.sh
@@ -0,0 +1,8 @@
+#!/bin/bash
+
+cp ./support/package.cjs.json ./build/cjs/package.json
+cp ./support/package.esm.json ./build/esm/package.json
+
+cp -r ./build/esm/ ./build/esm-debug/
+
+sed -i '/debug(/d' ./build/esm/*.js
diff --git a/support/package.cjs.json b/support/package.cjs.json
@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}
diff --git a/support/package.esm.json b/support/package.esm.json
@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}
diff --git a/tsconfig.esm.json b/tsconfig.esm.json
@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "outDir": "build/esm/",
+    "target": "es2018",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "declaration": true
+  },
+  "include": [
+    "./lib/**/*"
+  ]
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,10 +1,9 @@
 {
   "compilerOptions": {
-    "outDir": "./dist",
-    "allowJs": false,
-    "target": "es2017",
+    "outDir": "build/cjs/",
+    "target": "es2018", // Node.js 10 (https://github.com/microsoft/TypeScript/wiki/Node-Target-Mapping)
     "module": "commonjs",
-    "declaration": true
+    "declaration": false
   },
   "include": [
     "./lib/**/*"

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`node_modules`
`2`	`2`	`dist/`
	`3`	`+build/`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { isBinary } from "./is-binary";`
	`1`	`+import { isBinary } from "./is-binary.js";`
`2`	`2`
`3`	`3`	`/**`
`4`	`4`	`* Replaces every Buffer \| ArrayBuffer \| Blob \| File in packet with a numbered placeholder.`