@knighted/duel 1.0.0-alpha.0

package/README.md

@@ -0,0 +1,43 @@
+# [`@knighted/duel`](https://www.npmjs.com/package/@knighted/duel)
+
+![CI](https://github.com/knightedcodemonkey/duel/actions/workflows/ci.yml/badge.svg)
+[![codecov](https://codecov.io/gh/knightedcodemonkey/duel/branch/main/graph/badge.svg?token=7K74BRLHFy)](https://codecov.io/gh/knightedcodemonkey/duel)
+[![NPM version](https://img.shields.io/npm/v/@knighted/duel.svg)](https://www.npmjs.com/package/@knighted/duel)
+
+Node.js tool for creating a TypeScript dual package.
+
+Early stages of development. Inspired by https://github.com/microsoft/TypeScript/issues/49462.
+
+## Example
+
+Consider a project that is ESM-first, i.e. `"type": "module"` in package.json, that also wants to create a separate CJS build. It might have a tsconfig.json file that looks like the following.
+
+**tsconfig.json**
+
+```json
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "declaration": true,
+    "strict": true,
+    "outDir": "dist"
+  },
+  "include": ["src/*.ts"]
+}
+```
+
+Running the following will use the tsconfig.json defined above and create a separate CJS build in `dist/cjs`.
+
+```console
+user@comp ~ $ duel -p tsconfig.json -x .cjs
+```
+
+Now you can update your `exports` in package.json to match the build output.
+
+It should work similarly for a CJS first project. Except, your tsconfig.json would be slightly different and you'd want to pass `-x .mjs`.
+
+## Gotchas
+
+Unfortunately, TypeScript doesn't really understand dual packages very well. For instance, it will **always** create CJS exports when `--module commonjs` is used, even on files with an `.mts` extension. One reference issue is https://github.com/microsoft/TypeScript/issues/54573.

package/dist/duel.cjs

@@ -0,0 +1,111 @@
+#!/usr/bin/env node
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.duel = void 0;
+var _nodeProcess = require("node:process");
+var _nodeUrl = require("node:url");
+var _nodePath = require("node:path");
+var _nodeChild_process = require("node:child_process");
+var _promises = require("node:fs/promises");
+var _nodeCrypto = require("node:crypto");
+var _nodePerf_hooks = require("node:perf_hooks");
+var _glob = require("glob");
+var _specifier = require("@knighted/specifier");
+var _init = require("./init.cjs");
+var _util = require("./util.cjs");
+const _filename = (0, _nodeUrl.fileURLToPath)(import.meta.url);
+const _dirname = (0, _nodePath.dirname)(_filename);
+const root = (0, _nodePath.join)(_dirname, '..');
+const tsc = (0, _nodePath.join)(root, 'node_modules', '.bin', 'tsc');
+const runBuild = project => {
+  const {
+    status,
+    error
+  } = (0, _nodeChild_process.spawnSync)(tsc, ['-p', project], {
+    stdio: 'inherit'
+  });
+  if (error) {
+    (0, _util.logError)(`Failed to compile: ${error.message}`);
+    return false;
+  }
+  if (status === null) {
+    (0, _util.logError)(`Failed to compile. The process was terminated.`);
+    return false;
+  }
+  if (status > 0) {
+    (0, _util.logError)('Compilation errors found.');
+    return false;
+  }
+  return true;
+};
+const duel = async args => {
+  const ctx = await (0, _init.init)(args);
+  if (ctx) {
+    const {
+      projectDir,
+      tsconfig,
+      targetExt,
+      configPath
+    } = ctx;
+    const startTime = _nodePerf_hooks.performance.now();
+    (0, _util.log)('Starting primary build...\n');
+    let success = runBuild(configPath);
+    if (success) {
+      const isCjsBuild = targetExt === '.cjs';
+      const hex = (0, _nodeCrypto.randomBytes)(4).toString('hex');
+      const {
+        outDir
+      } = tsconfig.compilerOptions;
+      const dualConfigPath = (0, _nodePath.join)(projectDir, `tsconfig.${hex}.json`);
+      const dualOutDir = isCjsBuild ? (0, _nodePath.join)(outDir, 'cjs') : (0, _nodePath.join)(outDir, 'mjs');
+      const tsconfigDual = {
+        ...tsconfig,
+        compilerOptions: {
+          ...tsconfig.compilerOptions,
+          outDir: dualOutDir,
+          module: isCjsBuild ? 'CommonJS' : 'NodeNext',
+          moduleResolution: isCjsBuild ? 'Node' : 'NodeNext'
+        }
+      };
+      await (0, _promises.writeFile)(dualConfigPath, JSON.stringify(tsconfigDual, null, 2));
+      (0, _util.log)('Starting dual build...\n');
+      success = runBuild(dualConfigPath);
+      await (0, _promises.rm)(dualConfigPath, {
+        force: true
+      });
+      if (success) {
+        const filenames = await (0, _glob.glob)(`${(0, _nodePath.join)(projectDir, dualOutDir)}/**/*{.js,.d.ts}`, {
+          ignore: 'node_modules/**'
+        });
+        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, ({
+            value
+          }) => {
+            // Collapse any BinaryExpression or NewExpression to test for a relative specifier
+            const collapsed = value.replace(/['"`+)\s]|new String\(/g, '');
+            const relative = /^(?:\.|\.\.)\//i;
+            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
+          });
+        }
+        (0, _util.log)(`Successfully created a dual ${targetExt.replace('.', '').toUpperCase()} build in ${Math.round(_nodePerf_hooks.performance.now() - startTime)}ms.`);
+      }
+    }
+  }
+};
+exports.duel = duel;
+const realFileUrlArgv1 = await (0, _util.getRealPathAsFileUrl)(_nodeProcess.argv[1]);
+if (import.meta.url === realFileUrlArgv1) {
+  await duel();
+}

package/dist/duel.js

@@ -0,0 +1,105 @@
+#!/usr/bin/env node
+import { argv } from 'node:process';
+import { fileURLToPath } from 'node:url';
+import { dirname, join } from 'node:path';
+import { spawnSync } from 'node:child_process';
+import { writeFile, rm } from 'node:fs/promises';
+import { randomBytes } from 'node:crypto';
+import { performance } from 'node:perf_hooks';
+import { glob } from 'glob';
+import { specifier } from '@knighted/specifier';
+import { init } from './init.js';
+import { getRealPathAsFileUrl, logError, log } from './util.js';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+const root = join(__dirname, '..');
+const tsc = join(root, 'node_modules', '.bin', 'tsc');
+const runBuild = project => {
+  const {
+    status,
+    error
+  } = spawnSync(tsc, ['-p', project], {
+    stdio: 'inherit'
+  });
+  if (error) {
+    logError(`Failed to compile: ${error.message}`);
+    return false;
+  }
+  if (status === null) {
+    logError(`Failed to compile. The process was terminated.`);
+    return false;
+  }
+  if (status > 0) {
+    logError('Compilation errors found.');
+    return false;
+  }
+  return true;
+};
+const duel = async args => {
+  const ctx = await init(args);
+  if (ctx) {
+    const {
+      projectDir,
+      tsconfig,
+      targetExt,
+      configPath
+    } = ctx;
+    const startTime = performance.now();
+    log('Starting primary build...\n');
+    let success = runBuild(configPath);
+    if (success) {
+      const isCjsBuild = targetExt === '.cjs';
+      const hex = randomBytes(4).toString('hex');
+      const {
+        outDir
+      } = tsconfig.compilerOptions;
+      const dualConfigPath = join(projectDir, `tsconfig.${hex}.json`);
+      const dualOutDir = isCjsBuild ? join(outDir, 'cjs') : join(outDir, 'mjs');
+      const tsconfigDual = {
+        ...tsconfig,
+        compilerOptions: {
+          ...tsconfig.compilerOptions,
+          outDir: dualOutDir,
+          module: isCjsBuild ? 'CommonJS' : 'NodeNext',
+          moduleResolution: isCjsBuild ? 'Node' : 'NodeNext'
+        }
+      };
+      await writeFile(dualConfigPath, JSON.stringify(tsconfigDual, null, 2));
+      log('Starting dual build...\n');
+      success = runBuild(dualConfigPath);
+      await rm(dualConfigPath, {
+        force: true
+      });
+      if (success) {
+        const filenames = await glob(`${join(projectDir, dualOutDir)}/**/*{.js,.d.ts}`, {
+          ignore: 'node_modules/**'
+        });
+        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, ({
+            value
+          }) => {
+            // Collapse any BinaryExpression or NewExpression to test for a relative specifier
+            const collapsed = value.replace(/['"`+)\s]|new String\(/g, '');
+            const relative = /^(?:\.|\.\.)\//i;
+            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
+          });
+        }
+        log(`Successfully created a dual ${targetExt.replace('.', '').toUpperCase()} build in ${Math.round(performance.now() - startTime)}ms.`);
+      }
+    }
+  }
+};
+const realFileUrlArgv1 = await getRealPathAsFileUrl(argv[1]);
+if (import.meta.url === realFileUrlArgv1) {
+  await duel();
+}
+export { duel };

package/dist/init.cjs

@@ -0,0 +1,98 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.init = void 0;
+var _nodeUtil = require("node:util");
+var _nodePath = require("node:path");
+var _promises = require("node:fs/promises");
+var _util = require("./util.cjs");
+const init = async args => {
+  const validTargetExts = ['.cjs', '.mjs'];
+  let parsed = null;
+  try {
+    const {
+      values
+    } = (0, _nodeUtil.parseArgs)({
+      args,
+      options: {
+        project: {
+          type: 'string',
+          short: 'p',
+          default: 'tsconfig.json'
+        },
+        'target-extension': {
+          type: 'string',
+          short: 'x',
+          default: '.cjs'
+        },
+        help: {
+          type: 'boolean',
+          short: 'h',
+          default: false
+        }
+      }
+    });
+    parsed = values;
+  } catch (err) {
+    (0, _util.logError)(err.message);
+    return false;
+  }
+  if (parsed.help) {
+    (0, _util.log)('Usage: duel [options]\n');
+    (0, _util.log)('Options:');
+    (0, _util.log)("--project, -p \t\t\t Compile the project given the path to its configuration file, or to a folder with a 'tsconfig.json'.");
+    (0, _util.log)('--target-extension, -x \t\t Sets the file extension for the dual build. [.cjs,.mjs]');
+    (0, _util.log)('--help, -h \t\t\t Print this message.');
+  } else {
+    const {
+      project,
+      'target-extension': targetExt
+    } = parsed;
+    let configPath = (0, _nodePath.resolve)(project);
+    let stats = null;
+    if (!validTargetExts.includes(targetExt)) {
+      (0, _util.logError)(`Invalid arg '${targetExt}' for --target-extension. Must be one of ${validTargetExts.toString()}`);
+      return false;
+    }
+    try {
+      stats = await (0, _promises.stat)(configPath);
+    } catch {
+      (0, _util.logError)(`Provided --project '${project}' resolves to ${configPath} which is not a file or directory.`);
+      return false;
+    }
+    if (stats.isDirectory()) {
+      configPath = (0, _nodePath.join)(configPath, 'tsconfig.json');
+      try {
+        stats = await (0, _promises.stat)(configPath);
+      } catch {
+        (0, _util.logError)(`Provided --project '${project}' resolves to a directory ${(0, _nodePath.dirname)(configPath)} with no tsconfig.json.`);
+        return false;
+      }
+    }
+    if (stats.isFile()) {
+      let tsconfig = null;
+      try {
+        tsconfig = JSON.parse((await (0, _promises.readFile)(configPath)).toString());
+      } catch (err) {
+        (0, _util.logError)(`The config file found at ${configPath} is not parsable as JSON.`);
+        return false;
+      }
+      if (!tsconfig.compilerOptions?.outDir) {
+        (0, _util.logError)('You must define an `outDir` in your project config.');
+        return false;
+      }
+      const projectDir = (0, _nodePath.dirname)(configPath);
+      return {
+        tsconfig,
+        targetExt,
+        projectDir,
+        configPath,
+        absoluteOutDir: (0, _nodePath.resolve)(projectDir, tsconfig.compilerOptions.outDir)
+      };
+    }
+  }
+  return false;
+};
+exports.init = init;

package/dist/init.js

@@ -0,0 +1,92 @@
+import { parseArgs } from 'node:util';
+import { resolve, join, dirname } from 'node:path';
+import { stat, readFile } from 'node:fs/promises';
+import { logError, log } from './util.js';
+const init = async args => {
+  const validTargetExts = ['.cjs', '.mjs'];
+  let parsed = null;
+  try {
+    const {
+      values
+    } = parseArgs({
+      args,
+      options: {
+        project: {
+          type: 'string',
+          short: 'p',
+          default: 'tsconfig.json'
+        },
+        'target-extension': {
+          type: 'string',
+          short: 'x',
+          default: '.cjs'
+        },
+        help: {
+          type: 'boolean',
+          short: 'h',
+          default: false
+        }
+      }
+    });
+    parsed = values;
+  } catch (err) {
+    logError(err.message);
+    return false;
+  }
+  if (parsed.help) {
+    log('Usage: duel [options]\n');
+    log('Options:');
+    log("--project, -p \t\t\t Compile the project given the path to its configuration file, or to a folder with a 'tsconfig.json'.");
+    log('--target-extension, -x \t\t Sets the file extension for the dual build. [.cjs,.mjs]');
+    log('--help, -h \t\t\t Print this message.');
+  } else {
+    const {
+      project,
+      'target-extension': targetExt
+    } = parsed;
+    let configPath = resolve(project);
+    let stats = null;
+    if (!validTargetExts.includes(targetExt)) {
+      logError(`Invalid arg '${targetExt}' for --target-extension. Must be one of ${validTargetExts.toString()}`);
+      return false;
+    }
+    try {
+      stats = await stat(configPath);
+    } catch {
+      logError(`Provided --project '${project}' resolves to ${configPath} which is not a file or directory.`);
+      return false;
+    }
+    if (stats.isDirectory()) {
+      configPath = join(configPath, 'tsconfig.json');
+      try {
+        stats = await stat(configPath);
+      } catch {
+        logError(`Provided --project '${project}' resolves to a directory ${dirname(configPath)} with no tsconfig.json.`);
+        return false;
+      }
+    }
+    if (stats.isFile()) {
+      let tsconfig = null;
+      try {
+        tsconfig = JSON.parse((await readFile(configPath)).toString());
+      } catch (err) {
+        logError(`The config file found at ${configPath} is not parsable as JSON.`);
+        return false;
+      }
+      if (!tsconfig.compilerOptions?.outDir) {
+        logError('You must define an `outDir` in your project config.');
+        return false;
+      }
+      const projectDir = dirname(configPath);
+      return {
+        tsconfig,
+        targetExt,
+        projectDir,
+        configPath,
+        absoluteOutDir: resolve(projectDir, tsconfig.compilerOptions.outDir)
+      };
+    }
+  }
+  return false;
+};
+export { init };

package/dist/util.cjs

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+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;
+const logError = log.bind(null, '\x1b[31m');
+exports.logError = logError;
+const getRealPathAsFileUrl = async path => {
+  const realPath = await (0, _promises.realpath)(path);
+  const asFileUrl = (0, _nodeUrl.pathToFileURL)(realPath).href;
+  return asFileUrl;
+};
+exports.getRealPathAsFileUrl = getRealPathAsFileUrl;

package/dist/util.js

@@ -0,0 +1,13 @@
+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');
+const getRealPathAsFileUrl = async path => {
+  const realPath = await realpath(path);
+  const asFileUrl = pathToFileURL(realPath).href;
+  return asFileUrl;
+};
+export { log, logError, getRealPathAsFileUrl };

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@knighted/duel",
+  "version": "1.0.0-alpha.0",
+  "description": "TypeScript dual packages.",
+  "type": "module",
+  "main": "dist",
+  "bin": "dist/duel.js",
+  "exports": {
+    ".": {
+      "import": "./dist/duel.js",
+      "require": "./dist/duel.cjs",
+      "default": "./dist/duel.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "engines": {
+    "node": ">=16.19.0"
+  },
+  "engineStrict": true,
+  "scripts": {
+    "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",
+    "prepack": "npm run build"
+  },
+  "keywords": [
+    "tsc",
+    "typescript",
+    "dual package",
+    "cjs",
+    "mjs"
+  ],
+  "files": [
+    "dist"
+  ],
+  "author": "KCM <knightedcodemonkey@gmail.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/knightedcodemonkey/duel.git"
+  },
+  "bugs": {
+    "url": "https://github.com/knightedcodemonkey/duel/issues"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "devDependencies": {
+    "babel-dual-package": "^1.0.0-rc.5",
+    "c8": "^8.0.1",
+    "eslint": "^8.45.0",
+    "eslint-plugin-n": "^16.0.1",
+    "prettier": "^3.0.0",
+    "typescript": "^5.2.0-dev.20230727"
+  },
+  "dependencies": {
+    "@knighted/specifier": "^1.0.0-alpha.5",
+    "glob": "^10.3.3",
+    "magic-string": "^0.30.1"
+  },
+  "prettier": {
+    "arrowParens": "avoid",
+    "printWidth": 90,
+    "semi": false,
+    "singleQuote": true
+  }
+}