@knighted/duel 1.0.0-rc.9 → 1.0.1

package/README.md

@@ -21,7 +21,7 @@ Node.js tool for building a TypeScript dual package.
 First, install this package to create the `duel` executable inside your `node_modules/.bin` directory.
 
 ```console
-user@comp ~ $ npm i @knighted/duel
+user@comp ~ $ npm i @knighted/duel --save-dev
 ```
 
 Then, given a `package.json` that defines `"type": "module"` and  a `tsconfig.json` file that looks something like the following:
@@ -86,7 +86,7 @@ The available options are limited, because you should define most of them inside
 
 * `--project, -p` The path to the project's configuration file. Defaults to `tsconfig.json`.
 * `--pkg-dir, -k` The directory to start looking for a package.json file. Defaults to the cwd.
-* `--dirs, -d` Outputs both builds to directories inside of `outDir`. Defalts to `false`.
+* `--dirs, -d` Outputs both builds to directories inside of `outDir`. Defaults to `false`.
 * `--parallel, -l` Run the builds in parallel. Defaults to `false`.
 
 You can run `duel --help` to get the same info. Below is the output of that:
@@ -106,7 +106,7 @@ Options:
 
 These are definitely edge cases, and would only really come up if your project mixes file extensions. For example, if you have `.ts` files combined with `.mts`, and/or `.cts`. For most projects, things should just work as expected.
 
-* This is going to work best if your CJS-first project uses file extensions in their _relative_ specifiers. This is completely acceptable in CJS projects, and [required in ESM projects](https://nodejs.org/api/esm.html#import-specifiers). This package makes no attempt to rewrite bare specifiers, or remap any relative specifiers to a directory index.
+* This is going to work best if your CJS-first project uses file extensions in _relative_ specifiers. This is completely acceptable in CJS projects, and [required in ESM projects](https://nodejs.org/api/esm.html#import-specifiers). This package makes no attempt to rewrite bare specifiers, or remap any relative specifiers to a directory index.
 
 * Unfortunately, TypeScript doesn't really build [dual packages](https://nodejs.org/api/packages.html#dual-commonjses-module-packages) very well in regards to preserving module system by file extension. For instance, there doesn't appear to be a way to convert an arbitrary `.ts` file into another module system, _while also preserving the module system of `.mts` and `.cts` files_, without requiring **multiple** package.json files. In my opinion, the `tsc` compiler is fundamentally broken in this regard, and at best is enforcing usage patterns it shouldn't.  This is only mentioned for transparency, `duel` will correct for this and produce files with the module system you would expect based on the file's extension, so that it works with [how Node.js determines module systems](https://nodejs.org/api/packages.html#determining-module-system).
 

package/dist/duel.cjs

@@ -12,10 +12,16 @@ var _promises = require("node:fs/promises");
 var _nodeCrypto = require("node:crypto");
 var _nodePerf_hooks = require("node:perf_hooks");
 var _glob = require("glob");
+var _findUp = require("find-up");
 var _specifier = require("@knighted/specifier");
 var _init = require("./init.cjs");
 var _util = require("./util.cjs");
-const tsc = (0, _nodePath.join)((0, _nodeProcess.cwd)(), 'node_modules', '.bin', 'tsc');
+const tsc = await (0, _findUp.findUp)(async dir => {
+  const tscBin = (0, _nodePath.join)(dir, 'node_modules', '.bin', 'tsc');
+  if (await (0, _findUp.pathExists)(tscBin)) {
+    return tscBin;
+  }
+});
 const runBuild = (project, outDir) => {
   return new Promise((resolve, reject) => {
     const args = outDir ? ['-p', project, '--outDir', outDir] : ['-p', project];
@@ -71,21 +77,24 @@ const duel = async args => {
       for (const filename of filenames) {
         const dts = /(\.d\.ts)$/;
         const outFilename = dts.test(filename) ? filename.replace(dts, isCjsBuild ? '.d.cts' : '.d.mts') : filename.replace(/\.js$/, targetExt);
-        const code = await _specifier.specifier.update(filename, ({
+        const {
+          code,
+          error
+        } = await _specifier.specifier.update(filename, ({
           value
         }) => {
-          // Collapse any BinaryExpression or NewExpression to test for a relative specifier
           const collapsed = value.replace(/['"`+)\s]|new String\(/g, '');
           const relative = /^(?:\.|\.\.)\//;
           if (relative.test(collapsed)) {
-            // $2 is for any closing quotation/parens around BE or NE
             return value.replace(/(.+)\.js([)'"`]*)?$/, `$1${targetExt}$2`);
           }
         });
-        await (0, _promises.writeFile)(outFilename, code);
-        await (0, _promises.rm)(filename, {
-          force: true
-        });
+        if (code && !error) {
+          await (0, _promises.writeFile)(outFilename, code);
+          await (0, _promises.rm)(filename, {
+            force: true
+          });
+        }
       }
     };
     const logSuccess = start => {
@@ -114,13 +123,7 @@ const duel = async args => {
       const prepStart = _nodePerf_hooks.performance.now();
       await (0, _promises.cp)(projectDir, paraTempDir, {
         recursive: true,
-        /**
-         * Ignore common .gitignored directories in Node.js projects.
-         * Except node_modules.
-         *
-         * @see https://github.com/github/gitignore/blob/main/Node.gitignore
-         */
-        filter: src => !/logs|pids|lib-cov|coverage|bower_components|build|dist|jspm_packages|web_modules|out|\.next|\.tsbuildinfo|\.npm|\.node_repl_history|\.tgz|\.yarn|\.pnp|\.nyc_output|\.grunt/i.test(src)
+        filter: src => !/logs|pids|lib-cov|coverage|bower_components|build|dist|jspm_packages|web_modules|out|\.next|\.tsbuildinfo|\.npm|\.node_repl_history|\.tgz|\.yarn|\.pnp|\.nyc_output|\.grunt|\.DS_Store/i.test(src)
       });
       const dualConfigPath = (0, _nodePath.join)(paraTempDir, 'tsconfig.json');
       const absoluteDualOutDir = (0, _nodePath.join)(paraTempDir, isCjsBuild ? (0, _nodePath.join)(outDir, 'cjs') : (0, _nodePath.join)(outDir, 'esm'));
@@ -146,7 +149,6 @@ const duel = async args => {
           ignore: 'node_modules/**'
         });
         await updateSpecifiersAndFileExtensions(filenames);
-        // Copy over and cleanup
         await (0, _promises.cp)(absoluteDualOutDir, (0, _nodePath.join)(absoluteOutDir, isCjsBuild ? 'cjs' : 'esm'), {
           recursive: true
         });
@@ -173,21 +175,11 @@ const duel = async args => {
         const absoluteDualOutDir = (0, _nodePath.join)(projectDir, isCjsBuild ? (0, _nodePath.join)(outDir, 'cjs') : (0, _nodePath.join)(outDir, 'esm'));
         const tsconfigDual = getOverrideTsConfig();
         const pkgRename = 'package.json.bak';
-
-        /**
-         * Create a new package.json with updated `type` field.
-         * Create a new tsconfig.json.
-         *
-         * The need to create a new package.json makes doing
-         * the builds in parallel difficult.
-         */
         await (0, _promises.rename)(pkg.path, (0, _nodePath.join)(pkgDir, pkgRename));
         await (0, _promises.writeFile)(pkg.path, JSON.stringify({
           type: isCjsBuild ? 'commonjs' : 'module'
         }));
         await (0, _promises.writeFile)(dualConfigPath, JSON.stringify(tsconfigDual));
-
-        // Build dual
         (0, _util.log)('Starting dual build...');
         try {
           await runBuild(dualConfigPath, absoluteDualOutDir);
@@ -197,8 +189,6 @@ const duel = async args => {
           success = false;
           (0, _util.logError)(message);
         }
-
-        // Cleanup and restore
         await (0, _promises.rm)(dualConfigPath, {
           force: true
         });

package/dist/duel.js

@@ -1,15 +1,21 @@
 #!/usr/bin/env node
-import { argv, cwd } from 'node:process';
+import { argv } from 'node:process';
 import { join, dirname, resolve } from 'node:path';
 import { spawn } from 'node:child_process';
 import { writeFile, rm, cp, rename, stat, access, constants } from 'node:fs/promises';
 import { randomBytes } from 'node:crypto';
 import { performance } from 'node:perf_hooks';
 import { glob } from 'glob';
+import { findUp, pathExists } from 'find-up';
 import { specifier } from '@knighted/specifier';
 import { init } from './init.js';
 import { getRealPathAsFileUrl, logError, log } from './util.js';
-const tsc = join(cwd(), 'node_modules', '.bin', 'tsc');
+const tsc = await findUp(async dir => {
+  const tscBin = join(dir, 'node_modules', '.bin', 'tsc');
+  if (await pathExists(tscBin)) {
+    return tscBin;
+  }
+});
 const runBuild = (project, outDir) => {
   return new Promise((resolve, reject) => {
     const args = outDir ? ['-p', project, '--outDir', outDir] : ['-p', project];
@@ -65,21 +71,24 @@ const duel = async args => {
       for (const filename of filenames) {
         const dts = /(\.d\.ts)$/;
         const outFilename = dts.test(filename) ? filename.replace(dts, isCjsBuild ? '.d.cts' : '.d.mts') : filename.replace(/\.js$/, targetExt);
-        const code = await specifier.update(filename, ({
+        const {
+          code,
+          error
+        } = await specifier.update(filename, ({
           value
         }) => {
-          // Collapse any BinaryExpression or NewExpression to test for a relative specifier
           const collapsed = value.replace(/['"`+)\s]|new String\(/g, '');
           const relative = /^(?:\.|\.\.)\//;
           if (relative.test(collapsed)) {
-            // $2 is for any closing quotation/parens around BE or NE
             return value.replace(/(.+)\.js([)'"`]*)?$/, `$1${targetExt}$2`);
           }
         });
-        await writeFile(outFilename, code);
-        await rm(filename, {
-          force: true
-        });
+        if (code && !error) {
+          await writeFile(outFilename, code);
+          await rm(filename, {
+            force: true
+          });
+        }
       }
     };
     const logSuccess = start => {
@@ -108,13 +117,7 @@ const duel = async args => {
       const prepStart = performance.now();
       await cp(projectDir, paraTempDir, {
         recursive: true,
-        /**
-         * Ignore common .gitignored directories in Node.js projects.
-         * Except node_modules.
-         *
-         * @see https://github.com/github/gitignore/blob/main/Node.gitignore
-         */
-        filter: src => !/logs|pids|lib-cov|coverage|bower_components|build|dist|jspm_packages|web_modules|out|\.next|\.tsbuildinfo|\.npm|\.node_repl_history|\.tgz|\.yarn|\.pnp|\.nyc_output|\.grunt/i.test(src)
+        filter: src => !/logs|pids|lib-cov|coverage|bower_components|build|dist|jspm_packages|web_modules|out|\.next|\.tsbuildinfo|\.npm|\.node_repl_history|\.tgz|\.yarn|\.pnp|\.nyc_output|\.grunt|\.DS_Store/i.test(src)
       });
       const dualConfigPath = join(paraTempDir, 'tsconfig.json');
       const absoluteDualOutDir = join(paraTempDir, isCjsBuild ? join(outDir, 'cjs') : join(outDir, 'esm'));
@@ -140,7 +143,6 @@ const duel = async args => {
           ignore: 'node_modules/**'
         });
         await updateSpecifiersAndFileExtensions(filenames);
-        // Copy over and cleanup
         await cp(absoluteDualOutDir, join(absoluteOutDir, isCjsBuild ? 'cjs' : 'esm'), {
           recursive: true
         });
@@ -167,21 +169,11 @@ const duel = async args => {
         const absoluteDualOutDir = join(projectDir, isCjsBuild ? join(outDir, 'cjs') : join(outDir, 'esm'));
         const tsconfigDual = getOverrideTsConfig();
         const pkgRename = 'package.json.bak';
-
-        /**
-         * Create a new package.json with updated `type` field.
-         * Create a new tsconfig.json.
-         *
-         * The need to create a new package.json makes doing
-         * the builds in parallel difficult.
-         */
         await rename(pkg.path, join(pkgDir, pkgRename));
         await writeFile(pkg.path, JSON.stringify({
           type: isCjsBuild ? 'commonjs' : 'module'
         }));
         await writeFile(dualConfigPath, JSON.stringify(tsconfigDual));
-
-        // Build dual
         log('Starting dual build...');
         try {
           await runBuild(dualConfigPath, absoluteDualOutDir);
@@ -191,8 +183,6 @@ const duel = async args => {
           success = false;
           logError(message);
         }
-
-        // Cleanup and restore
         await rm(dualConfigPath, {
           force: true
         });

package/dist/init.cjs

@@ -8,8 +8,10 @@ var _nodeProcess = require("node:process");
 var _nodeUtil = require("node:util");
 var _nodePath = require("node:path");
 var _promises = require("node:fs/promises");
+var _stripJsonComments = _interopRequireDefault(require("strip-json-comments"));
 var _readPkgUp = require("read-pkg-up");
 var _util = require("./util.cjs");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const init = async args => {
   let parsed = null;
   try {
@@ -103,7 +105,7 @@ const init = async args => {
     if (stats.isFile()) {
       let tsconfig = null;
       try {
-        tsconfig = JSON.parse((await (0, _promises.readFile)(configPath)).toString());
+        tsconfig = JSON.parse((0, _stripJsonComments.default)((await (0, _promises.readFile)(configPath)).toString()));
       } catch (err) {
         (0, _util.logError)(`The config file found at ${configPath} is not parsable as JSON.`);
         return false;

package/dist/init.js

@@ -2,6 +2,7 @@ import { cwd } from 'node:process';
 import { parseArgs } from 'node:util';
 import { resolve, join, dirname } from 'node:path';
 import { stat, readFile } from 'node:fs/promises';
+import stripJsonComments from 'strip-json-comments';
 import { readPackageUp } from 'read-pkg-up';
 import { logError, log } from './util.js';
 const init = async args => {
@@ -97,7 +98,7 @@ const init = async args => {
     if (stats.isFile()) {
       let tsconfig = null;
       try {
-        tsconfig = JSON.parse((await readFile(configPath)).toString());
+        tsconfig = JSON.parse(stripJsonComments((await readFile(configPath)).toString()));
       } catch (err) {
         logError(`The config file found at ${configPath} is not parsable as JSON.`);
         return false;

package/dist/util.cjs

@@ -7,7 +7,6 @@ exports.logError = exports.log = exports.getRealPathAsFileUrl = void 0;
 var _nodeUrl = require("node:url");
 var _promises = require("node:fs/promises");
 const log = (color = '\x1b[30m', msg = '') => {
-  // eslint-disable-next-line no-console
   console.log(`${color}%s\x1b[0m`, msg);
 };
 exports.log = log;

package/dist/util.js

@@ -1,7 +1,6 @@
 import { pathToFileURL } from 'node:url';
 import { realpath } from 'node:fs/promises';
 const log = (color = '\x1b[30m', msg = '') => {
-  // eslint-disable-next-line no-console
   console.log(`${color}%s\x1b[0m`, msg);
 };
 const logError = log.bind(null, '\x1b[31m');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knighted/duel",
-  "version": "1.0.0-rc.9",
+  "version": "1.0.1",
   "description": "TypeScript dual packages.",
   "type": "module",
   "main": "dist",
@@ -21,7 +21,7 @@
     "prettier": "prettier -w src/*.js test/*.js",
     "lint": "eslint src/*.js test/*.js",
     "test": "c8 --reporter=text --reporter=text-summary --reporter=lcov node --test --test-reporter=spec test/*.js",
-    "build": "babel-dual-package --no-cjs-dir src",
+    "build": "babel-dual-package --no-cjs-dir --no-comments src",
     "prepack": "npm run build"
   },
   "keywords": [
@@ -44,22 +44,24 @@
     "url": "https://github.com/knightedcodemonkey/duel/issues"
   },
   "peerDependencies": {
-    "typescript": ">=4.0.0 || >=4.8.0-dev || >=4.9.0-dev || >=5.0.0-dev || >=5.1.0-dev || >=5.2.0-dev"
+    "typescript": ">=4.0.0 || >=4.9.0-dev || >=5.2.0-dev || >=5.3.0-dev"
   },
   "devDependencies": {
     "@types/node": "^20.4.6",
-    "babel-dual-package": "^1.0.0",
+    "babel-dual-package": "^1.1.2",
     "c8": "^8.0.1",
     "eslint": "^8.45.0",
     "eslint-plugin-n": "^16.0.1",
     "prettier": "^3.0.1",
-    "typescript": "^5.2.0-dev.20230727",
+    "typescript": "^5.3.0-dev.20230906",
     "vite": "^4.4.8"
   },
   "dependencies": {
-    "@knighted/specifier": "^1.0.0-rc.1",
+    "@knighted/specifier": "^1.0.1",
+    "find-up": "^6.3.0",
     "glob": "^10.3.3",
-    "read-pkg-up": "^10.0.0"
+    "read-pkg-up": "^10.0.0",
+    "strip-json-comments": "^5.0.1"
   },
   "prettier": {
     "arrowParens": "avoid",