@knighted/duel 1.0.3 → 1.0.5

package/dist/esm/init.js

@@ -0,0 +1,120 @@
+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 { readPackageUp } from 'read-pkg-up';
+import JSONC from 'jsonc-parser';
+import { logError, log } from './util.js';
+const init = async (args) => {
+    let parsed = null;
+    try {
+        const { values } = parseArgs({
+            args,
+            options: {
+                project: {
+                    type: 'string',
+                    short: 'p',
+                    default: 'tsconfig.json',
+                },
+                'target-extension': {
+                    type: 'string',
+                    short: 'x',
+                    default: '',
+                },
+                'pkg-dir': {
+                    type: 'string',
+                    short: 'k',
+                    default: cwd(),
+                },
+                parallel: {
+                    type: 'boolean',
+                    short: 'l',
+                    default: false,
+                },
+                dirs: {
+                    type: 'boolean',
+                    short: 'd',
+                    default: false,
+                },
+                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 [path] \t Compile the project given the path to its configuration file, or to a folder with a 'tsconfig.json'.");
+        log('--pkg-dir, -k [path] \t The directory to start looking for a package.json file. Defaults to cwd.');
+        log('--dirs, -d \t\t Output both builds to directories inside of outDir. [esm, cjs].');
+        log('--parallel, -l \t\t Run the builds in parallel.');
+        log('--help, -h \t\t Print this message.');
+    }
+    else {
+        const { project, 'target-extension': targetExt, 'pkg-dir': pkgDir, parallel, dirs, } = parsed;
+        let configPath = resolve(project);
+        let stats = null;
+        let pkg = null;
+        if (targetExt) {
+            logError('--target-extension is deprecated. Define "type" in your package.json instead and the dual build will be inferred from that.');
+            return false;
+        }
+        pkg = await readPackageUp({ cwd: pkgDir });
+        if (!pkg) {
+            logError('No package.json file found.');
+            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;
+            const errors = [];
+            const jsonText = (await readFile(configPath)).toString();
+            tsconfig = JSONC.parse(jsonText, errors, {
+                disallowComments: false,
+                allowTrailingComma: true,
+            });
+            if (errors.length) {
+                logError(`The config file found at ${configPath} is not parsable as JSONC.`);
+                return false;
+            }
+            if (!tsconfig.compilerOptions?.outDir) {
+                log('No outDir defined in tsconfig.json. Build output will be in "dist".');
+            }
+            const projectDir = dirname(configPath);
+            return {
+                pkg,
+                dirs,
+                parallel,
+                tsconfig,
+                projectDir,
+                configPath,
+            };
+        }
+    }
+    return false;
+};
+export { init };

package/dist/esm/util.d.ts

@@ -0,0 +1,3 @@
+export function log(color?: string, msg?: string): void;
+export const logError: (msg?: string | undefined) => void;
+export function getRealPathAsFileUrl(path: any): Promise<string>;

package/dist/esm/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

@@ -1,15 +1,15 @@
 {
   "name": "@knighted/duel",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "TypeScript dual packages.",
   "type": "module",
   "main": "dist",
-  "bin": "dist/duel.js",
+  "bin": "dist/esm/duel.js",
   "exports": {
     ".": {
-      "import": "./dist/duel.js",
-      "require": "./dist/duel.cjs",
-      "default": "./dist/duel.js"
+      "import": "./dist/esm/duel.js",
+      "require": "./dist/cjs/duel.cjs",
+      "default": "./dist/esm/duel.js"
     },
     "./package.json": "./package.json"
   },
@@ -21,16 +21,17 @@
     "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 --no-comments src",
+    "build": "node src/duel.js --dirs",
     "prepack": "npm run build"
   },
   "keywords": [
     "node",
     "typescript",
+    "dual package",
+    "es module",
+    "commonjs",
     "esm",
     "cjs",
-    "commonjs",
-    "dual package",
     "build",
     "tsc",
     "cts",
@@ -54,20 +55,19 @@
   },
   "devDependencies": {
     "@types/node": "^20.4.6",
-    "babel-dual-package": "^1.1.2",
     "c8": "^8.0.1",
     "eslint": "^8.45.0",
     "eslint-plugin-n": "^16.0.1",
-    "prettier": "^3.0.1",
+    "prettier": "^3.2.4",
     "typescript": "^5.4.0-dev.20231206",
-    "vite": "^4.4.8"
+    "vite": "^5.0.12"
   },
   "dependencies": {
     "@knighted/specifier": "^1.0.1",
     "find-up": "^6.3.0",
     "glob": "^10.3.3",
-    "read-pkg-up": "^10.0.0",
-    "strip-json-comments": "^5.0.1"
+    "jsonc-parser": "^3.2.0",
+    "read-pkg-up": "^10.0.0"
   },
   "prettier": {
     "arrowParens": "avoid",

package/dist/duel.cjs

@@ -1,214 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.duel = void 0;
-var _nodeProcess = require("node:process");
-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 _findUp = require("find-up");
-var _specifier = require("@knighted/specifier");
-var _init = require("./init.cjs");
-var _util = require("./util.cjs");
-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];
-    const build = (0, _nodeChild_process.spawn)(tsc, args, {
-      stdio: 'inherit'
-    });
-    build.on('error', err => {
-      reject(new Error(`Failed to compile: ${err.message}`));
-    });
-    build.on('close', code => {
-      if (code === null) {
-        return reject(new Error('Failed to compile.'));
-      }
-      if (code > 0) {
-        return reject(new Error('Compilation errors found.'));
-      }
-      resolve(code);
-    });
-  });
-};
-const duel = async args => {
-  const ctx = await (0, _init.init)(args);
-  if (ctx) {
-    const {
-      projectDir,
-      tsconfig,
-      configPath,
-      parallel,
-      dirs,
-      pkg
-    } = ctx;
-    const pkgDir = (0, _nodePath.dirname)(pkg.path);
-    const outDir = tsconfig.compilerOptions?.outDir ?? 'dist';
-    const absoluteOutDir = (0, _nodePath.resolve)(projectDir, outDir);
-    const originalType = pkg.packageJson.type ?? 'commonjs';
-    const isCjsBuild = originalType !== 'commonjs';
-    const targetExt = isCjsBuild ? '.cjs' : '.mjs';
-    const hex = (0, _nodeCrypto.randomBytes)(4).toString('hex');
-    const getOverrideTsConfig = () => {
-      return {
-        ...tsconfig,
-        compilerOptions: {
-          ...tsconfig.compilerOptions,
-          module: 'NodeNext',
-          moduleResolution: 'NodeNext'
-        }
-      };
-    };
-    const runPrimaryBuild = () => {
-      return runBuild(configPath, dirs ? isCjsBuild ? (0, _nodePath.join)(absoluteOutDir, 'esm') : (0, _nodePath.join)(absoluteOutDir, 'cjs') : absoluteOutDir);
-    };
-    const updateSpecifiersAndFileExtensions = async filenames => {
-      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,
-          error
-        } = await _specifier.specifier.update(filename, ({
-          value
-        }) => {
-          const collapsed = value.replace(/['"`+)\s]|new String\(/g, '');
-          const relative = /^(?:\.|\.\.)\//;
-          if (relative.test(collapsed)) {
-            return value.replace(/(.+)\.js([)'"`]*)?$/, `$1${targetExt}$2`);
-          }
-        });
-        if (code && !error) {
-          await (0, _promises.writeFile)(outFilename, code);
-          await (0, _promises.rm)(filename, {
-            force: true
-          });
-        }
-      }
-    };
-    const logSuccess = start => {
-      (0, _util.log)(`Successfully created a dual ${isCjsBuild ? 'CJS' : 'ESM'} build in ${Math.round(_nodePerf_hooks.performance.now() - start)}ms.`);
-    };
-    if (parallel) {
-      const paraName = `_${hex}_`;
-      const paraParent = (0, _nodePath.join)(projectDir, '..');
-      const paraTempDir = (0, _nodePath.join)(paraParent, paraName);
-      let isDirWritable = true;
-      try {
-        const stats = await (0, _promises.stat)(paraParent);
-        if (stats.isDirectory()) {
-          await (0, _promises.access)(paraParent, _promises.constants.W_OK);
-        } else {
-          isDirWritable = false;
-        }
-      } catch {
-        isDirWritable = false;
-      }
-      if (!isDirWritable) {
-        (0, _util.logError)('No writable directory to prepare parallel builds. Exiting.');
-        return;
-      }
-      (0, _util.log)('Preparing parallel build...');
-      const prepStart = _nodePerf_hooks.performance.now();
-      await (0, _promises.cp)(projectDir, paraTempDir, {
-        recursive: true,
-        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'));
-      const tsconfigDual = getOverrideTsConfig();
-      await (0, _promises.writeFile)(dualConfigPath, JSON.stringify(tsconfigDual));
-      await (0, _promises.writeFile)((0, _nodePath.join)(paraTempDir, 'package.json'), JSON.stringify({
-        type: isCjsBuild ? 'commonjs' : 'module'
-      }));
-      (0, _util.log)(`Prepared in ${Math.round(_nodePerf_hooks.performance.now() - prepStart)}ms.`);
-      (0, _util.log)('Starting parallel dual builds...');
-      let success = false;
-      const startTime = _nodePerf_hooks.performance.now();
-      try {
-        await Promise.all([runPrimaryBuild(), runBuild(dualConfigPath, absoluteDualOutDir)]);
-        success = true;
-      } catch ({
-        message
-      }) {
-        (0, _util.logError)(message);
-      }
-      if (success) {
-        const filenames = await (0, _glob.glob)(`${absoluteDualOutDir}/**/*{.js,.d.ts}`, {
-          ignore: 'node_modules/**'
-        });
-        await updateSpecifiersAndFileExtensions(filenames);
-        await (0, _promises.cp)(absoluteDualOutDir, (0, _nodePath.join)(absoluteOutDir, isCjsBuild ? 'cjs' : 'esm'), {
-          recursive: true
-        });
-        await (0, _promises.rm)(paraTempDir, {
-          force: true,
-          recursive: true
-        });
-        logSuccess(startTime);
-      }
-    } else {
-      (0, _util.log)('Starting primary build...');
-      let success = false;
-      const startTime = _nodePerf_hooks.performance.now();
-      try {
-        await runPrimaryBuild();
-        success = true;
-      } catch ({
-        message
-      }) {
-        (0, _util.logError)(message);
-      }
-      if (success) {
-        const dualConfigPath = (0, _nodePath.join)(projectDir, `tsconfig.${hex}.json`);
-        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';
-        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));
-        (0, _util.log)('Starting dual build...');
-        try {
-          await runBuild(dualConfigPath, absoluteDualOutDir);
-        } catch ({
-          message
-        }) {
-          success = false;
-          (0, _util.logError)(message);
-        }
-        await (0, _promises.rm)(dualConfigPath, {
-          force: true
-        });
-        await (0, _promises.rm)(pkg.path, {
-          force: true
-        });
-        await (0, _promises.rename)((0, _nodePath.join)(pkgDir, pkgRename), pkg.path);
-        if (success) {
-          const filenames = await (0, _glob.glob)(`${absoluteDualOutDir}/**/*{.js,.d.ts}`, {
-            ignore: 'node_modules/**'
-          });
-          await updateSpecifiersAndFileExtensions(filenames);
-          logSuccess(startTime);
-        }
-      }
-    }
-  }
-};
-exports.duel = duel;
-const realFileUrlArgv1 = await (0, _util.getRealPathAsFileUrl)(_nodeProcess.argv[1]);
-if (import.meta.url === realFileUrlArgv1) {
-  await duel();
-}

package/dist/duel.js

@@ -1,208 +0,0 @@
-#!/usr/bin/env node
-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 = 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];
-    const build = spawn(tsc, args, {
-      stdio: 'inherit'
-    });
-    build.on('error', err => {
-      reject(new Error(`Failed to compile: ${err.message}`));
-    });
-    build.on('close', code => {
-      if (code === null) {
-        return reject(new Error('Failed to compile.'));
-      }
-      if (code > 0) {
-        return reject(new Error('Compilation errors found.'));
-      }
-      resolve(code);
-    });
-  });
-};
-const duel = async args => {
-  const ctx = await init(args);
-  if (ctx) {
-    const {
-      projectDir,
-      tsconfig,
-      configPath,
-      parallel,
-      dirs,
-      pkg
-    } = ctx;
-    const pkgDir = dirname(pkg.path);
-    const outDir = tsconfig.compilerOptions?.outDir ?? 'dist';
-    const absoluteOutDir = resolve(projectDir, outDir);
-    const originalType = pkg.packageJson.type ?? 'commonjs';
-    const isCjsBuild = originalType !== 'commonjs';
-    const targetExt = isCjsBuild ? '.cjs' : '.mjs';
-    const hex = randomBytes(4).toString('hex');
-    const getOverrideTsConfig = () => {
-      return {
-        ...tsconfig,
-        compilerOptions: {
-          ...tsconfig.compilerOptions,
-          module: 'NodeNext',
-          moduleResolution: 'NodeNext'
-        }
-      };
-    };
-    const runPrimaryBuild = () => {
-      return runBuild(configPath, dirs ? isCjsBuild ? join(absoluteOutDir, 'esm') : join(absoluteOutDir, 'cjs') : absoluteOutDir);
-    };
-    const updateSpecifiersAndFileExtensions = async filenames => {
-      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,
-          error
-        } = await specifier.update(filename, ({
-          value
-        }) => {
-          const collapsed = value.replace(/['"`+)\s]|new String\(/g, '');
-          const relative = /^(?:\.|\.\.)\//;
-          if (relative.test(collapsed)) {
-            return value.replace(/(.+)\.js([)'"`]*)?$/, `$1${targetExt}$2`);
-          }
-        });
-        if (code && !error) {
-          await writeFile(outFilename, code);
-          await rm(filename, {
-            force: true
-          });
-        }
-      }
-    };
-    const logSuccess = start => {
-      log(`Successfully created a dual ${isCjsBuild ? 'CJS' : 'ESM'} build in ${Math.round(performance.now() - start)}ms.`);
-    };
-    if (parallel) {
-      const paraName = `_${hex}_`;
-      const paraParent = join(projectDir, '..');
-      const paraTempDir = join(paraParent, paraName);
-      let isDirWritable = true;
-      try {
-        const stats = await stat(paraParent);
-        if (stats.isDirectory()) {
-          await access(paraParent, constants.W_OK);
-        } else {
-          isDirWritable = false;
-        }
-      } catch {
-        isDirWritable = false;
-      }
-      if (!isDirWritable) {
-        logError('No writable directory to prepare parallel builds. Exiting.');
-        return;
-      }
-      log('Preparing parallel build...');
-      const prepStart = performance.now();
-      await cp(projectDir, paraTempDir, {
-        recursive: true,
-        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'));
-      const tsconfigDual = getOverrideTsConfig();
-      await writeFile(dualConfigPath, JSON.stringify(tsconfigDual));
-      await writeFile(join(paraTempDir, 'package.json'), JSON.stringify({
-        type: isCjsBuild ? 'commonjs' : 'module'
-      }));
-      log(`Prepared in ${Math.round(performance.now() - prepStart)}ms.`);
-      log('Starting parallel dual builds...');
-      let success = false;
-      const startTime = performance.now();
-      try {
-        await Promise.all([runPrimaryBuild(), runBuild(dualConfigPath, absoluteDualOutDir)]);
-        success = true;
-      } catch ({
-        message
-      }) {
-        logError(message);
-      }
-      if (success) {
-        const filenames = await glob(`${absoluteDualOutDir}/**/*{.js,.d.ts}`, {
-          ignore: 'node_modules/**'
-        });
-        await updateSpecifiersAndFileExtensions(filenames);
-        await cp(absoluteDualOutDir, join(absoluteOutDir, isCjsBuild ? 'cjs' : 'esm'), {
-          recursive: true
-        });
-        await rm(paraTempDir, {
-          force: true,
-          recursive: true
-        });
-        logSuccess(startTime);
-      }
-    } else {
-      log('Starting primary build...');
-      let success = false;
-      const startTime = performance.now();
-      try {
-        await runPrimaryBuild();
-        success = true;
-      } catch ({
-        message
-      }) {
-        logError(message);
-      }
-      if (success) {
-        const dualConfigPath = join(projectDir, `tsconfig.${hex}.json`);
-        const absoluteDualOutDir = join(projectDir, isCjsBuild ? join(outDir, 'cjs') : join(outDir, 'esm'));
-        const tsconfigDual = getOverrideTsConfig();
-        const pkgRename = 'package.json.bak';
-        await rename(pkg.path, join(pkgDir, pkgRename));
-        await writeFile(pkg.path, JSON.stringify({
-          type: isCjsBuild ? 'commonjs' : 'module'
-        }));
-        await writeFile(dualConfigPath, JSON.stringify(tsconfigDual));
-        log('Starting dual build...');
-        try {
-          await runBuild(dualConfigPath, absoluteDualOutDir);
-        } catch ({
-          message
-        }) {
-          success = false;
-          logError(message);
-        }
-        await rm(dualConfigPath, {
-          force: true
-        });
-        await rm(pkg.path, {
-          force: true
-        });
-        await rename(join(pkgDir, pkgRename), pkg.path);
-        if (success) {
-          const filenames = await glob(`${absoluteDualOutDir}/**/*{.js,.d.ts}`, {
-            ignore: 'node_modules/**'
-          });
-          await updateSpecifiersAndFileExtensions(filenames);
-          logSuccess(startTime);
-        }
-      }
-    }
-  }
-};
-const realFileUrlArgv1 = await getRealPathAsFileUrl(argv[1]);
-if (import.meta.url === realFileUrlArgv1) {
-  await duel();
-}
-export { duel };