@knighted/duel 3.1.0 → 3.1.1

package/README.md

@@ -90,6 +90,10 @@ Note, there is a slight performance penalty since your project needs to be copie
 
 This feature is still a work in progress regarding transforming `exports` when targeting an ES module build (relies on [`@knighted/module`](https://github.com/knightedcodemonkey/module)).
 
+#### Pre-`tsc` transform (TypeScript 58658)
+
+When you pass `--modules`, `duel` copies your sources and runs [`@knighted/module`](https://github.com/knightedcodemonkey/module) **before** `tsc` so the transformed files no longer trigger TypeScript’s asymmetrical module-global errors (see [TypeScript#58658](https://github.com/microsoft/TypeScript/issues/58658)). No extra setup is needed: `--modules` is the pre-`tsc` mitigation.
+
 ## Options
 
 The available options are limited, because you should define most of them inside your project's `tsconfig.json` file.
@@ -122,7 +126,7 @@ These are definitely edge cases, and would only really come up if your project m
 
 - 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, `tsc` doesn't support [dual packages](https://nodejs.org/api/packages.html#dual-commonjses-module-packages) completely. One instance of unexpected behavior is when the compiler throws errors for ES module globals when running a dual CJS build, but not for the inverse case, despite both causing runtime errors in Node.js. See the [open issue](https://github.com/microsoft/TypeScript/issues/58658). You can circumvent this with `duel` by using the `--modules` option if your project uses module globals such as `import.meta` properties or `__dirname`, `__filename`, etc. in a CommonJS project.
+- Unfortunately, `tsc` doesn't support [dual packages](https://nodejs.org/api/packages.html#dual-commonjses-module-packages) completely. For mitigation details, see the pre-`tsc` transform note above (`--modules`).
 
 - If running `duel` with your project's package.json file open in your editor, you may temporarily see the content replaced. This is because `duel` dynamically creates a new package.json using the `type` necessary for the dual build. Your original package.json will be restored after the build completes.
 

package/dist/cjs/duel.cjs

@@ -258,6 +258,7 @@ const duel = async (args) => {
                 const writeOptions = {
                     target,
                     rewriteSpecifier,
+                    transformSyntax: 'globals-only',
                     ...(outFilename === filename ? { inPlace: true } : { out: outFilename }),
                 };
                 await (0, module_1.transform)(filename, writeOptions);
@@ -267,7 +268,7 @@ const duel = async (args) => {
             }
         };
         const logSuccess = start => {
-            (0, util_js_1.log)(`Successfully created a dual ${isCjsBuild ? 'CJS' : 'ESM'} build in ${Math.round(node_perf_hooks_1.performance.now() - start)}ms.`);
+            (0, util_js_1.logSuccess)(`Successfully created a dual ${isCjsBuild ? 'CJS' : 'ESM'} build in ${Math.round(node_perf_hooks_1.performance.now() - start)}ms.`);
         };
         (0, util_js_1.log)('Starting primary build...');
         let success = false;
@@ -314,7 +315,7 @@ const duel = async (args) => {
                     await (0, module_1.transform)(file, {
                         out: file,
                         target: isCjsBuild ? 'commonjs' : 'module',
-                        transformSyntax: false,
+                        transformSyntax: 'globals-only',
                     });
                 }
             }

package/dist/cjs/init.cjs

@@ -55,14 +55,15 @@ const init = async (args) => {
         return false;
     }
     if (parsed.help) {
-        (0, util_js_1.log)('Usage: duel [options]\n');
-        (0, util_js_1.log)('Options:');
-        (0, util_js_1.log)("--project, -p [path] \t Compile the project given the path to its configuration file, or to a folder with a 'tsconfig.json'.");
-        (0, util_js_1.log)('--pkg-dir, -k [path] \t The directory to start looking for a package.json file. Defaults to --project directory.');
-        (0, util_js_1.log)('--modules, -m \t\t Transform module globals for dual build target. Defaults to false.');
-        (0, util_js_1.log)('--dirs, -d \t\t Output both builds to directories inside of outDir. [esm, cjs].');
-        (0, util_js_1.log)('--exports, -e \t Generate package.json exports. Values: wildcard | dir | name.');
-        (0, util_js_1.log)('--help, -h \t\t Print this message.');
+        const bare = { bare: true };
+        (0, util_js_1.log)('Usage: duel [options]\n', 'info', bare);
+        (0, util_js_1.log)('Options:', 'info', bare);
+        (0, util_js_1.log)("--project, -p [path] \t Compile the project given the path to its configuration file, or to a folder with a 'tsconfig.json'.", 'info', bare);
+        (0, util_js_1.log)('--pkg-dir, -k [path] \t The directory to start looking for a package.json file. Defaults to --project directory.', 'info', bare);
+        (0, util_js_1.log)('--modules, -m \t\t Transform module globals for dual build target. Defaults to false.', 'info', bare);
+        (0, util_js_1.log)('--dirs, -d \t\t Output both builds to directories inside of outDir. [esm, cjs].', 'info', bare);
+        (0, util_js_1.log)('--exports, -e \t Generate package.json exports. Values: wildcard | dir | name.', 'info', bare);
+        (0, util_js_1.log)('--help, -h \t\t Print this message.', 'info', bare);
     }
     else {
         const { project, 'target-extension': targetExt, 'pkg-dir': pkgDir, modules, dirs, exports: exportsOpt, } = parsed;

package/dist/cjs/util.cjs

@@ -1,17 +1,43 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCompileFiles = exports.getRealPathAsFileUrl = exports.logError = exports.log = void 0;
+exports.getCompileFiles = exports.getRealPathAsFileUrl = exports.logWarn = exports.logSuccess = exports.logError = exports.log = void 0;
 const node_url_1 = require("node:url");
 const promises_1 = require("node:fs/promises");
 const node_child_process_1 = require("node:child_process");
 const node_process_1 = require("node:process");
 const node_os_1 = require("node:os");
-const log = (color = '\x1b[30m', msg = '') => {
+const COLORS = {
+    reset: '\x1b[0m',
+    info: '\x1b[36m',
+    success: '\x1b[32m',
+    warn: '\x1b[33m',
+    error: '\x1b[31m',
+};
+const log = (msg = '', level = 'info', opts = {}) => {
+    const { bare = false } = opts;
+    const palette = {
+        info: COLORS.info,
+        success: COLORS.success,
+        warn: COLORS.warn,
+        error: COLORS.error,
+    };
+    const badge = {
+        success: '[✓]',
+        warn: '[!]',
+        error: '[x]',
+        info: '[i]',
+    }[level];
+    const color = palette[level] ?? COLORS.info;
+    const prefix = !bare && badge ? `${badge} ` : '';
     // eslint-disable-next-line no-console
-    console.log(`${color}%s\x1b[0m`, msg);
+    console.log(`${color}${prefix}%s${COLORS.reset}`, msg);
 };
 exports.log = log;
-const logError = log.bind(null, '\x1b[31m');
+const logSuccess = msg => log(msg, 'success');
+exports.logSuccess = logSuccess;
+const logWarn = msg => log(msg, 'warn');
+exports.logWarn = logWarn;
+const logError = msg => log(msg, 'error');
 exports.logError = logError;
 const getRealPathAsFileUrl = async (path) => {
     const realPath = await (0, promises_1.realpath)(path);

package/dist/cjs/util.d.cts

@@ -1,4 +1,6 @@
-export function log(color?: string, msg?: string): void;
-export const logError: (msg?: string | undefined) => void;
+export function log(msg?: string, level?: string, opts?: {}): void;
+export function logError(msg: any): void;
+export function logSuccess(msg: any): void;
+export function logWarn(msg: any): void;
 export function getRealPathAsFileUrl(path: any): Promise<string>;
 export function getCompileFiles(tscBinPath: any, wd?: string): string[];

package/dist/esm/duel.js

@@ -9,7 +9,7 @@ import { glob } from 'glob';
 import { findUp } from 'find-up';
 import { transform } from '@knighted/module';
 import { init } from './init.js';
-import { getRealPathAsFileUrl, getCompileFiles, logError, log } from './util.js';
+import { getRealPathAsFileUrl, getCompileFiles, log, logError, logSuccess as logSuccessBadge, } from './util.js';
 const stripKnownExt = path => {
     return path.replace(/(\.d\.(?:ts|mts|cts)|\.(?:mjs|cjs|js))$/, '');
 };
@@ -255,6 +255,7 @@ const duel = async (args) => {
                 const writeOptions = {
                     target,
                     rewriteSpecifier,
+                    transformSyntax: 'globals-only',
                     ...(outFilename === filename ? { inPlace: true } : { out: outFilename }),
                 };
                 await transform(filename, writeOptions);
@@ -264,7 +265,7 @@ const duel = async (args) => {
             }
         };
         const logSuccess = start => {
-            log(`Successfully created a dual ${isCjsBuild ? 'CJS' : 'ESM'} build in ${Math.round(performance.now() - start)}ms.`);
+            logSuccessBadge(`Successfully created a dual ${isCjsBuild ? 'CJS' : 'ESM'} build in ${Math.round(performance.now() - start)}ms.`);
         };
         log('Starting primary build...');
         let success = false;
@@ -311,7 +312,7 @@ const duel = async (args) => {
                     await transform(file, {
                         out: file,
                         target: isCjsBuild ? 'commonjs' : 'module',
-                        transformSyntax: false,
+                        transformSyntax: 'globals-only',
                     });
                 }
             }

package/dist/esm/init.js

@@ -52,14 +52,15 @@ const init = async (args) => {
         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 --project directory.');
-        log('--modules, -m \t\t Transform module globals for dual build target. Defaults to false.');
-        log('--dirs, -d \t\t Output both builds to directories inside of outDir. [esm, cjs].');
-        log('--exports, -e \t Generate package.json exports. Values: wildcard | dir | name.');
-        log('--help, -h \t\t Print this message.');
+        const bare = { bare: true };
+        log('Usage: duel [options]\n', 'info', bare);
+        log('Options:', 'info', bare);
+        log("--project, -p [path] \t Compile the project given the path to its configuration file, or to a folder with a 'tsconfig.json'.", 'info', bare);
+        log('--pkg-dir, -k [path] \t The directory to start looking for a package.json file. Defaults to --project directory.', 'info', bare);
+        log('--modules, -m \t\t Transform module globals for dual build target. Defaults to false.', 'info', bare);
+        log('--dirs, -d \t\t Output both builds to directories inside of outDir. [esm, cjs].', 'info', bare);
+        log('--exports, -e \t Generate package.json exports. Values: wildcard | dir | name.', 'info', bare);
+        log('--help, -h \t\t Print this message.', 'info', bare);
     }
     else {
         const { project, 'target-extension': targetExt, 'pkg-dir': pkgDir, modules, dirs, exports: exportsOpt, } = parsed;

package/dist/esm/util.d.ts

@@ -1,4 +1,6 @@
-export function log(color?: string, msg?: string): void;
-export const logError: (msg?: string | undefined) => void;
+export function log(msg?: string, level?: string, opts?: {}): void;
+export function logError(msg: any): void;
+export function logSuccess(msg: any): void;
+export function logWarn(msg: any): void;
 export function getRealPathAsFileUrl(path: any): Promise<string>;
 export function getCompileFiles(tscBinPath: any, wd?: string): string[];

package/dist/esm/util.js

@@ -3,11 +3,35 @@ import { realpath } from 'node:fs/promises';
 import { spawnSync } from 'node:child_process';
 import { cwd, platform } from 'node:process';
 import { EOL } from 'node:os';
-const log = (color = '\x1b[30m', msg = '') => {
+const COLORS = {
+    reset: '\x1b[0m',
+    info: '\x1b[36m',
+    success: '\x1b[32m',
+    warn: '\x1b[33m',
+    error: '\x1b[31m',
+};
+const log = (msg = '', level = 'info', opts = {}) => {
+    const { bare = false } = opts;
+    const palette = {
+        info: COLORS.info,
+        success: COLORS.success,
+        warn: COLORS.warn,
+        error: COLORS.error,
+    };
+    const badge = {
+        success: '[✓]',
+        warn: '[!]',
+        error: '[x]',
+        info: '[i]',
+    }[level];
+    const color = palette[level] ?? COLORS.info;
+    const prefix = !bare && badge ? `${badge} ` : '';
     // eslint-disable-next-line no-console
-    console.log(`${color}%s\x1b[0m`, msg);
+    console.log(`${color}${prefix}%s${COLORS.reset}`, msg);
 };
-const logError = log.bind(null, '\x1b[31m');
+const logSuccess = msg => log(msg, 'success');
+const logWarn = msg => log(msg, 'warn');
+const logError = msg => log(msg, 'error');
 const getRealPathAsFileUrl = async (path) => {
     const realPath = await realpath(path);
     const asFileUrl = pathToFileURL(realPath).href;
@@ -24,4 +48,4 @@ const getCompileFiles = (tscBinPath, wd = cwd()) => {
         .split(EOL)
         .filter(path => !/node_modules|^$/.test(path));
 };
-export { log, logError, getRealPathAsFileUrl, getCompileFiles };
+export { log, logError, logSuccess, logWarn, getRealPathAsFileUrl, getCompileFiles };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knighted/duel",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "description": "TypeScript dual packages.",
   "type": "module",
   "main": "dist/esm/duel.js",
@@ -67,7 +67,6 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.39.1",
-    "@knighted/module": "^1.0.0-rc.2",
     "@tsconfig/recommended": "^1.0.10",
     "@types/node": "^24.10.1",
     "c8": "^10.1.3",
@@ -83,6 +82,7 @@
     "vite": "^7.2.4"
   },
   "dependencies": {
+    "@knighted/module": "^1.0.0-rc.6",
     "find-up": "^8.0.0",
     "get-tsconfig": "^4.13.0",
     "glob": "^13.0.0",