@knighted/duel 2.0.0 → 2.1.0

package/README.md

@@ -89,7 +89,7 @@ This feature is still a work in progress regarding transforming `exports` when t
 The available options are limited, because you should define most of them inside your project's `tsconfig.json` file.
 
 - `--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.
+- `--pkg-dir, -k` The directory to start looking for a package.json file. Defaults to `--project` dir.
 - `--modules, -m` Transform module globals for dual build target. Defaults to false.
 - `--dirs, -d` Outputs both builds to directories inside of `outDir`. Defaults to `false`.
 
@@ -100,7 +100,7 @@ Usage: duel [options]
 
 Options:
 --project, -p [path] 	 Compile the project given the path to its configuration file, or to a folder with a 'tsconfig.json'.
---pkg-dir, -k [path] 	 The directory to start looking for a package.json file. Defaults to cwd.
+--pkg-dir, -k [path] 	 The directory to start looking for a package.json file. Defaults to --project directory.
 --modules, -m 		 Transform module globals for dual build target. Defaults to false.
 --dirs, -d 		 Output both builds to directories inside of outDir. [esm, cjs].
 --help, -h 		 Print this message.
@@ -112,14 +112,12 @@ 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, TypeScript doesn't really build [dual packages](https://nodejs.org/api/packages.html#dual-commonjses-module-packages) very well. 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.
-
-- If doing an `import type` across module systems, i.e. from `.mts` into `.cts`, or vice versa, you might encounter the compilation error ``error TS1452: 'resolution-mode' assertions are only supported when `moduleResolution` is `node16` or `nodenext`.``. This is a [known issue](https://github.com/microsoft/TypeScript/issues/49055) and TypeScript currently suggests installing the nightly build, i.e. `npm i typescript@next`.
+- 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.
 
 - 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.
 
 ## Notes
 
-As far as I can tell, `duel` is one (if not the only) way to get a correct dual package build using `tsc` without requiring multiple `tsconfig.json` files or extra configuration. The Microsoft backed TypeScript team [keep](https://github.com/microsoft/TypeScript/pull/54546) [talking](https://github.com/microsoft/TypeScript/issues/54593) about dual build support, but they continue to [refuse to rewrite specifiers](https://github.com/microsoft/TypeScript/issues/16577).
+As far as I can tell, `duel` is one (if not the only) way to get a correct dual package build using `tsc` without requiring multiple `tsconfig.json` files or extra configuration. The TypeScript team [keep](https://github.com/microsoft/TypeScript/pull/54546) [talking](https://github.com/microsoft/TypeScript/issues/54593) about dual build support, but they continue to [refuse to rewrite specifiers](https://github.com/microsoft/TypeScript/issues/16577).
 
 Fortunately, Node.js has added `--experimental-require-module` so that you can [`require()` ES modules](https://nodejs.org/api/esm.html#require) if they don't use top level await, which sets the stage for possibly no longer requiring dual builds.

package/dist/cjs/init.cjs

@@ -1,15 +1,11 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.init = void 0;
-const node_process_1 = require("node:process");
 const node_util_1 = require("node:util");
 const node_path_1 = require("node:path");
 const promises_1 = require("node:fs/promises");
+const get_tsconfig_1 = require("get-tsconfig");
 const read_package_up_1 = require("read-package-up");
-const jsonc_parser_1 = __importDefault(require("jsonc-parser"));
 const util_js_1 = require("./util.cjs");
 const init = async (args) => {
     let parsed = null;
@@ -30,7 +26,6 @@ const init = async (args) => {
                 'pkg-dir': {
                     type: 'string',
                     short: 'k',
-                    default: (0, node_process_1.cwd)(),
                 },
                 modules: {
                     type: 'boolean',
@@ -59,7 +54,7 @@ const init = async (args) => {
         (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 cwd.');
+        (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)('--help, -h \t\t Print this message.');
@@ -73,11 +68,6 @@ const init = async (args) => {
             (0, util_js_1.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 (0, read_package_up_1.readPackageUp)({ cwd: pkgDir });
-        if (!pkg) {
-            (0, util_js_1.logError)('No package.json file found.');
-            return false;
-        }
         try {
             stats = await (0, promises_1.stat)(configPath);
         }
@@ -85,6 +75,11 @@ const init = async (args) => {
             (0, util_js_1.logError)(`Provided --project '${project}' resolves to ${configPath} which is not a file or directory.`);
             return false;
         }
+        pkg = await (0, read_package_up_1.readPackageUp)({ cwd: pkgDir ?? configPath });
+        if (!pkg) {
+            (0, util_js_1.logError)('No package.json file found.');
+            return false;
+        }
         if (stats.isDirectory()) {
             configPath = (0, node_path_1.join)(configPath, 'tsconfig.json');
             try {
@@ -96,21 +91,11 @@ const init = async (args) => {
             }
         }
         if (stats.isFile()) {
-            let tsconfig = null;
-            const errors = [];
-            const jsonText = (await (0, promises_1.readFile)(configPath)).toString();
-            tsconfig = jsonc_parser_1.default.parse(jsonText, errors, {
-                disallowComments: false,
-                allowTrailingComma: true,
-            });
-            if (errors.length) {
-                (0, util_js_1.logError)(`The config file found at ${configPath} is not parsable as JSONC.`);
-                return false;
-            }
+            const tsconfig = (0, get_tsconfig_1.parseTsconfig)(configPath);
+            const projectDir = (0, node_path_1.dirname)(configPath);
             if (!tsconfig.compilerOptions?.outDir) {
                 (0, util_js_1.log)('No outDir defined in tsconfig.json. Build output will be in "dist".');
             }
-            const projectDir = (0, node_path_1.dirname)(configPath);
             return {
                 pkg,
                 dirs,

package/dist/cjs/init.d.cts

@@ -2,7 +2,16 @@ export function init(args: any): Promise<false | {
     pkg: import("read-package-up", { with: { "resolution-mode": "import" } }).NormalizedReadResult;
     dirs: boolean;
     modules: boolean;
-    tsconfig: any;
+    tsconfig: {
+        compilerOptions?: import("get-tsconfig").TsConfigJson.CompilerOptions | undefined;
+        watchOptions?: import("get-tsconfig").TsConfigJson.WatchOptions | undefined;
+        typeAcquisition?: import("get-tsconfig").TsConfigJson.TypeAcquisition | undefined;
+        compileOnSave?: boolean | undefined;
+        files?: string[] | undefined;
+        exclude?: string[] | undefined;
+        include?: string[] | undefined;
+        references?: import("get-tsconfig").TsConfigJson.References[] | undefined;
+    };
     projectDir: string;
     configPath: string;
 }>;

package/dist/esm/init.d.ts

@@ -2,7 +2,16 @@ export function init(args: any): Promise<false | {
     pkg: import("read-package-up").NormalizedReadResult;
     dirs: boolean;
     modules: boolean;
-    tsconfig: any;
+    tsconfig: {
+        compilerOptions?: import("get-tsconfig").TsConfigJson.CompilerOptions | undefined;
+        watchOptions?: import("get-tsconfig").TsConfigJson.WatchOptions | undefined;
+        typeAcquisition?: import("get-tsconfig").TsConfigJson.TypeAcquisition | undefined;
+        compileOnSave?: boolean | undefined;
+        files?: string[] | undefined;
+        exclude?: string[] | undefined;
+        include?: string[] | undefined;
+        references?: import("get-tsconfig").TsConfigJson.References[] | undefined;
+    };
     projectDir: string;
     configPath: string;
 }>;

package/dist/esm/init.js

@@ -1,9 +1,8 @@
-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 { stat } from 'node:fs/promises';
+import { parseTsconfig } from 'get-tsconfig';
 import { readPackageUp } from 'read-package-up';
-import JSONC from 'jsonc-parser';
 import { logError, log } from './util.js';
 const init = async (args) => {
     let parsed = null;
@@ -24,7 +23,6 @@ const init = async (args) => {
                 'pkg-dir': {
                     type: 'string',
                     short: 'k',
-                    default: cwd(),
                 },
                 modules: {
                     type: 'boolean',
@@ -53,7 +51,7 @@ const init = async (args) => {
         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('--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('--help, -h \t\t Print this message.');
@@ -67,11 +65,6 @@ const init = async (args) => {
             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);
         }
@@ -79,6 +72,11 @@ const init = async (args) => {
             logError(`Provided --project '${project}' resolves to ${configPath} which is not a file or directory.`);
             return false;
         }
+        pkg = await readPackageUp({ cwd: pkgDir ?? configPath });
+        if (!pkg) {
+            logError('No package.json file found.');
+            return false;
+        }
         if (stats.isDirectory()) {
             configPath = join(configPath, 'tsconfig.json');
             try {
@@ -90,21 +88,11 @@ const init = async (args) => {
             }
         }
         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;
-            }
+            const tsconfig = parseTsconfig(configPath);
+            const projectDir = dirname(configPath);
             if (!tsconfig.compilerOptions?.outDir) {
                 log('No outDir defined in tsconfig.json. Build output will be in "dist".');
             }
-            const projectDir = dirname(configPath);
             return {
                 pkg,
                 dirs,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knighted/duel",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "TypeScript dual packages.",
   "type": "module",
   "main": "dist/esm/duel.js",
@@ -57,22 +57,23 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.6.0",
+    "@tsconfig/recommended": "^1.0.8",
     "@types/node": "^22.7.4",
     "c8": "^10.1.3",
     "eslint": "^9.16.0",
     "eslint-plugin-n": "^17.15.0",
     "globals": "^15.6.0",
     "prettier": "^3.4.2",
-    "tsx": "^4.19.1",
-    "typescript": "^5.7.2",
-    "vite": "^6.0.3"
+    "tsx": "^4.19.3",
+    "typescript": "^5.8.2",
+    "vite": "^6.2.3"
   },
   "dependencies": {
     "@knighted/module": "^1.0.0-alpha.4",
     "@knighted/specifier": "^2.0.0-rc.1",
     "find-up": "^6.3.0",
-    "glob": "^10.3.3",
-    "jsonc-parser": "^3.2.0",
+    "get-tsconfig": "^4.10.0",
+    "glob": "^11.0.1",
     "read-package-up": "^11.0.0"
   },
   "prettier": {