feat: migrate to publishing ES-modules with a CommonJS fallback. Improve emit-behavior. Fix bugs related to inclusion of module specifiers

Author: wessberg

.github/workflows/workflow.yml

@@ -10,8 +10,8 @@ jobs:
 
     strategy:
       matrix:
-        os: [windows-latest, macos-latest, ubuntu-18.04]
-        node: [14, 16, 17]
+        os: [windows-latest, macos-latest, ubuntu-latest]
+        node: [14.19.0, 16, 17, 18]
 
     steps:
       - name: Checkout code

README.md

@@ -224,6 +224,10 @@ $ npx -p typescript -p cjstoesm cjstoesm
 
 <!-- SHADOW_SECTION_INSTALL_END -->
 
+## Engine
+
+`cjstoesm` requires Node.js v14.19.0 or newer to function correctly.
+
 <!-- SHADOW_SECTION_USAGE_START -->
 
 ## Usage
@@ -236,17 +240,29 @@ $ npx -p typescript -p cjstoesm cjstoesm
 
 You can use this library as a CLI to convert your project files from using CommonJS to using ESM.
 
-The following command transforms all files matched by the glob `**/*.*` and emits them to the folder `dist` from the current working directory:
+The following command transforms all files matched by the glob `**/*.*` and overwrites them in-place:
+
+```
+cjstoesm **/*.*
+```
+
+You can also just pass in a folder name, in which case all direct descendents of that folder will be transformed and overwritten:
 
 ```
-cjstoesm "**/*.*" dist
+cjstoesm some-folder
+```
+
+You can also pass in a second argument, `outDir`, to avoid overwriting the source files. The following command transforms all files matched by the glob `**/*.*` and emits them to the folder `dist` from the current working directory:
+
+```
+cjstoesm **/*.* dist
 ```
 
 Here's an overview of the options that can be passed via the CLI:
 
 ```
 $ cjstoesm --help
-Usage: cjstoesm transform [options] <input> <outDir>
+Usage: cjstoesm [options] <input> <outDir>
 
 Transforms CJS to ESM modules based on the input glob
 
@@ -260,9 +276,6 @@ Options:
   -h, --help                              display help for command
 ```
 
-For example, you can run `cjstoesm transform "**/*.*" dist` to transform all files matched by the glob `**/*.*` and emit them to the folder `dist` from the current working directory.
-You can also just run `cjstoesm "**/*.*" dist` which is an alias for the `transform` command.
-
 The default behavior is to add file extensions to module specifiers to align with the implementation in [node.js](https://nodejs.org/dist/latest-v12.x/docs/api/esm.html#esm_mandatory_file_extensions) and across browsers.
 You can customize this with the `--preserve-module-specifiers` command line option. See the [API Options](#api-options) for documentation for the possible values you can pass for it.
 
@@ -288,7 +301,6 @@ import {writeFileSync} from "fs";
 
 const result = await transform({
 	input: "src/**/*.*",
-	outDir: "dist",
 	write: false
 });
 
@@ -307,9 +319,9 @@ interface TransformOptions {
 	 */
 	input: string[] | string;
 	/**
-	 * The output directory to use
+	 * Optionally, the output directory to use. Defaults to inheriting that of the matched input files`
 	 */
-	outDir: string;
+	outDir?: string;
 	/**
 	 * If write is false, no files will be written to disk
 	 */

bin/cjstoesm

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+'use strict';
+import "../dist/cli/index.js";
+process.title = 'cjstoesm';

bin/cjstoesm.js

@@ -8,19 +8,20 @@
 		"generate:all": "pnpm run generate:sandhog && pnpm run generate:changelog",
 		"clean": "rimraf dist",
 		"lint": "tsc --noEmit && eslint \"src/**/*.ts\" --color",
-		"prettier": "prettier --write '{src,test,documentation}/**/*.{js,ts,json,html,xml,css,md}'",
+		"prettier": "prettier --write \"{src,test,documentation}/**/*.{js,ts,json,html,xml,css,md}\"",
 		"test": "ava",
 		"prebuild": "pnpm run clean",
 		"build": "pnpm run prebuild && pnpm run rollup",
 		"build:built_in_module_map": "ts-node script/generate-built-in-module-map.ts",
 		"prewatch": "pnpm run clean",
-		"watch": "pnpm run prewatch && pnpm run rollup -- --watch",
+		"watch": "pnpm run prewatch && pnpm run rollup:watch",
 		"rollup": "rollup -c rollup.config.js",
-		"preversion": "pnpm run lint && pnpm run build:built_in_module_map && pnpm run build",
+		"rollup:watch": "rollup -c rollup.config.js --watch",
+		"preversion": "pnpm run lint && pnpm run build:built_in_module_map && pnpm run build && dotcjs dist/cjs",
 		"version": "pnpm run preversion && pnpm run generate:all && git add .",
 		"release": "np --no-cleanup --no-yarn",
-		"update:check": "pnpx npm-check-updates -x typescript-*,chalk,ava,@types/resolve --dep dev,prod",
-		"update:commit": "pnpx npm-check-updates -u -x typescript-*,chalk,ava,@types/resolve --dep dev,prod && pnpm update && pnpm install"
+		"update:check": "pnpx npm-check-updates -x typescript-*,ava,@types/resolve --dep dev,prod",
+		"update:commit": "pnpx npm-check-updates -u -x typescript-*,ava,@types/resolve --dep dev,prod && pnpm update && pnpm install"
 	},
 	"keywords": [
 		"typescript",
@@ -54,35 +55,37 @@
 	"license": "MIT",
 	"devDependencies": {
 		"@rollup/plugin-node-resolve": "^13.3.0",
-		"@types/node": "^17.0.35",
-		"@types/prettier": "^2.6.1",
+		"@types/node": "^17.0.36",
+		"@types/prettier": "^2.6.3",
 		"@types/reserved-words": "^0.1.0",
 		"@types/resolve": "1.20.0",
 		"@types/semver": "^7.3.9",
 		"@typescript-eslint/eslint-plugin": "^5.26.0",
 		"@typescript-eslint/parser": "^5.26.0",
 		"@wessberg/ts-config": "2.0.2",
+		"@wessberg/prettier-config": "1.0.0",
+		"dotcjs": "1.0.0",
 		"rollup-plugin-ts": "2.0.7",
 		"ava": "3.15.0",
 		"eslint": "^8.16.0",
 		"eslint-config-prettier": "^8.5.0",
 		"eslint-plugin-import": "^2.26.0",
-		"eslint-plugin-jsdoc": "^39.3.1",
+		"eslint-plugin-jsdoc": "^39.3.2",
 		"husky": "^8.0.1",
-		"memfs": "^3.4.3",
+		"memfs": "^3.4.4",
 		"np": "7.6.1",
 		"npm-check-updates": "^13.0.3",
-		"pnpm": "^7.1.5",
+		"pnpm": "^7.1.7",
 		"prettier": "^2.6.2",
 		"pretty-quick": "^3.1.3",
 		"rimraf": "^3.0.2",
-		"rollup": "^2.74.1",
-		"sandhog": "^1.0.43",
+		"rollup": "^2.75.1",
+		"sandhog": "^2.0.1",
 		"semver": "7.3.7",
 		"standard-changelog": "^2.0.27",
 		"ts-node": "^10.8.0",
 		"tslib": "^2.4.0",
-		"typescript": "4.6.4",
+		"typescript": "4.7.2",
 		"typescript-3-2-1": "npm:[email protected]",
 		"typescript-3-3-1": "npm:[email protected]",
 		"typescript-3-4-1": "npm:[email protected]",
@@ -101,8 +104,8 @@
 	},
 	"dependencies": {
 		"@wessberg/stringutil": "^1.0.19",
-		"chalk": "^4.1.2",
-		"commander": "^9.2.0",
+		"chalk": "^5.0.1",
+		"commander": "^9.3.0",
 		"compatfactory": "^0.0.13",
 		"crosspath": "^1.0.0",
 		"fast-glob": "^3.2.11",
@@ -113,12 +116,14 @@
 	"peerDependencies": {
 		"typescript": ">=3.2.x || >= 4.x"
 	},
-	"main": "./dist/lib/cjs/index.js",
-	"module": "./dist/lib/esm/index.js",
-	"browser": "./dist/lib/esm/index.js",
-	"types": "./dist/lib/esm/index.d.ts",
-	"typings": "./dist/lib/esm/index.d.ts",
-	"es2015": "./dist/lib/esm/index.js",
+	"exports": {
+		"import": "./dist/esm/index.js",
+		"require": "./dist/cjs/index.cjs"
+	},
+	"type": "module",
+	"types": "./dist/esm/index.d.ts",
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.js",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/wessberg/cjstoesm.git"
@@ -127,23 +132,25 @@
 		"url": "https://github.com/wessberg/cjstoesm/issues"
 	},
 	"engines": {
-		"node": ">=10.0.0"
+		"node": ">=14.9.0"
 	},
+	"prettier": "@wessberg/prettier-config",
 	"ava": {
 		"files": [
 			"test/**.test.ts"
 		],
 		"verbose": true,
-		"timeout": "400s",
-		"extensions": [
-			"ts"
+		"nonSemVerExperiments": {
+			"configurableModuleFormat": true
+		},
+		"extensions": {
+			"ts": "module"
+		},
+		"nodeArguments": [
+			"--loader=ts-node/esm"
 		],
 		"environmentVariables": {
-			"NODE_OPTIONS": "--max_old_space_size=4096",
 			"FORCE_COLOR": "3"
-		},
-		"require": [
-			"ts-node/register/transpile-only"
-		]
+		}
 	}
 }