@knighted/duel 3.0.0 → 3.1.0

package/README.md

@@ -98,6 +98,10 @@ The available options are limited, because you should define most of them inside
 - `--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`.
+- `--exports, -e` Generate `package.json` `exports` from build output. Values: `wildcard` | `dir` | `name`.
+
+> [!NOTE]
+> Exports keys are extensionless by design; the target `import`/`require`/`types` entries keep explicit file extensions so Node resolution remains deterministic.
 
 You can run `duel --help` to get the same info. Below is the output of that:
 
@@ -131,3 +135,5 @@ Fortunately, Node.js has added `--experimental-require-module` so that you can [
 ## Documentation
 
 - [docs/faq.md](docs/faq.md)
+- [docs/exports.md](docs/exports.md)
+- [docs/migrate-v2-v3.md](docs/migrate-v2-v3.md)

package/dist/cjs/duel.cjs

@@ -13,15 +13,178 @@ const find_up_1 = require("find-up");
 const module_1 = require("@knighted/module");
 const init_js_1 = require("./init.cjs");
 const util_js_1 = require("./util.cjs");
+const stripKnownExt = path => {
+    return path.replace(/(\.d\.(?:ts|mts|cts)|\.(?:mjs|cjs|js))$/, '');
+};
+const ensureDotSlash = path => {
+    return path.startsWith('./') ? path : `./${path}`;
+};
+const getSubpath = (mode, relFromRoot) => {
+    const parsed = (0, node_path_1.parse)(relFromRoot);
+    const segments = parsed.dir.split('/').filter(Boolean);
+    if (mode === 'name') {
+        return parsed.name ? `./${parsed.name}` : null;
+    }
+    if (mode === 'dir') {
+        const last = segments.at(-1);
+        return last ? `./${last}` : null;
+    }
+    if (mode === 'wildcard') {
+        const first = segments[0];
+        return first ? `./${first}/*` : null;
+    }
+    return null;
+};
 const handleErrorAndExit = message => {
     const exitCode = Number(message);
     (0, util_js_1.logError)('Compilation errors found.');
     process.exit(exitCode);
 };
+const generateExports = async (options) => {
+    const { mode, pkg, pkgDir, esmRoot, cjsRoot, mainDefaultKind, mainPath } = options;
+    const toPosix = path => path.replace(/\\/g, '/');
+    const esmRootPosix = toPosix(esmRoot);
+    const cjsRootPosix = toPosix(cjsRoot);
+    const esmIgnore = ['node_modules/**'];
+    const cjsIgnore = ['node_modules/**'];
+    const baseMap = new Map();
+    const subpathMap = new Map();
+    const baseToSubpath = new Map();
+    if (cjsRootPosix.startsWith(`${esmRootPosix}/`)) {
+        esmIgnore.push(`${cjsRootPosix}/**`);
+    }
+    if (esmRootPosix.startsWith(`${cjsRootPosix}/`)) {
+        cjsIgnore.push(`${esmRootPosix}/**`);
+    }
+    const recordPath = (kind, filePath, root) => {
+        const relPkg = toPosix((0, node_path_1.relative)(pkgDir, filePath));
+        const relFromRoot = toPosix((0, node_path_1.relative)(root, filePath));
+        const withDot = ensureDotSlash(relPkg);
+        const baseKey = stripKnownExt(relPkg);
+        const baseEntry = baseMap.get(baseKey) ?? {};
+        baseEntry[kind] = withDot;
+        baseMap.set(baseKey, baseEntry);
+        const subpath = getSubpath(mode, relFromRoot);
+        if (kind === 'types') {
+            const mappedSubpath = baseToSubpath.get(baseKey);
+            if (mappedSubpath) {
+                const subEntry = subpathMap.get(mappedSubpath) ?? {};
+                subEntry.types = withDot;
+                subpathMap.set(mappedSubpath, subEntry);
+            }
+            return;
+        }
+        if (subpath && subpath !== '.') {
+            const subEntry = subpathMap.get(subpath) ?? {};
+            subEntry[kind] = withDot;
+            subpathMap.set(subpath, subEntry);
+            baseToSubpath.set(baseKey, subpath);
+        }
+    };
+    const esmFiles = await (0, glob_1.glob)(`${esmRootPosix}/**/*.{js,mjs,d.ts,d.mts}`, {
+        ignore: esmIgnore,
+    });
+    for (const file of esmFiles) {
+        if (/\.d\.(ts|mts)$/.test(file)) {
+            recordPath('types', file, esmRoot);
+        }
+        else {
+            recordPath('import', file, esmRoot);
+        }
+    }
+    const cjsFiles = await (0, glob_1.glob)(`${cjsRootPosix}/**/*.{js,cjs,d.ts,d.cts}`, {
+        ignore: cjsIgnore,
+    });
+    for (const file of cjsFiles) {
+        if (/\.d\.(ts|cts)$/.test(file)) {
+            recordPath('types', file, cjsRoot);
+        }
+        else {
+            recordPath('require', file, cjsRoot);
+        }
+    }
+    const exportsMap = {};
+    const mainBase = mainPath ? stripKnownExt(mainPath.replace(/^\.\//, '')) : null;
+    const mainEntry = mainBase ? (baseMap.get(mainBase) ?? {}) : {};
+    if (mainPath) {
+        const rootEntry = {};
+        if (mainEntry.types) {
+            rootEntry.types = mainEntry.types;
+        }
+        if (mainDefaultKind === 'import') {
+            rootEntry.import = mainEntry.import ?? ensureDotSlash(mainPath);
+            if (mainEntry.require) {
+                rootEntry.require = mainEntry.require;
+            }
+        }
+        else {
+            rootEntry.require = mainEntry.require ?? ensureDotSlash(mainPath);
+            if (mainEntry.import) {
+                rootEntry.import = mainEntry.import;
+            }
+        }
+        rootEntry.default = ensureDotSlash(mainPath);
+        exportsMap['.'] = rootEntry;
+    }
+    const defaultKind = mainDefaultKind ?? 'import';
+    for (const [subpath, entry] of subpathMap.entries()) {
+        const out = {};
+        if (entry.types) {
+            out.types = entry.types;
+        }
+        if (entry.import) {
+            out.import = entry.import;
+        }
+        if (entry.require) {
+            out.require = entry.require;
+        }
+        const def = defaultKind === 'import'
+            ? (entry.import ?? entry.require)
+            : (entry.require ?? entry.import);
+        if (def) {
+            out.default = def;
+        }
+        if (Object.keys(out).length) {
+            exportsMap[subpath] = out;
+        }
+    }
+    if (!exportsMap['.'] && baseMap.size) {
+        const [subpath, entry] = subpathMap.entries().next().value ?? [];
+        if (entry) {
+            const out = {};
+            if (entry.types) {
+                out.types = entry.types;
+            }
+            if (entry.import) {
+                out.import = entry.import;
+            }
+            if (entry.require) {
+                out.require = entry.require;
+            }
+            const def = defaultKind === 'import'
+                ? (entry.import ?? entry.require)
+                : (entry.require ?? entry.import);
+            if (def) {
+                out.default = def;
+            }
+            if (Object.keys(out).length) {
+                exportsMap['.'] = out;
+                exportsMap[subpath] ??= out;
+            }
+        }
+    }
+    if (Object.keys(exportsMap).length) {
+        const pkgJson = {
+            ...pkg.packageJson,
+            exports: exportsMap,
+        };
+        await (0, promises_1.writeFile)(pkg.path, `${JSON.stringify(pkgJson, null, 2)}\n`);
+    }
+};
 const duel = async (args) => {
     const ctx = await (0, init_js_1.init)(args);
     if (ctx) {
-        const { projectDir, tsconfig, configPath, modules, dirs, pkg } = ctx;
+        const { projectDir, tsconfig, configPath, modules, dirs, pkg, exports: exportsOpt, } = ctx;
         const tsc = await (0, find_up_1.findUp)(async (dir) => {
             const tscBin = (0, node_path_1.join)(dir, 'node_modules', '.bin', 'tsc');
             try {
@@ -45,6 +208,8 @@ const duel = async (args) => {
             });
         };
         const pkgDir = (0, node_path_1.dirname)(pkg.path);
+        const mainPath = pkg.packageJson.main;
+        const mainDefaultKind = mainPath?.endsWith('.cjs') ? 'require' : 'import';
         const outDir = tsconfig.compilerOptions?.outDir ?? 'dist';
         const absoluteOutDir = (0, node_path_1.resolve)(projectDir, outDir);
         const originalType = pkg.packageJson.type ?? 'commonjs';
@@ -192,6 +357,19 @@ const duel = async (args) => {
                     const primaryFiles = await (0, glob_1.glob)(`${primaryOutDir.replace(/\\/g, '/')}/**/*{.js,.d.ts}`, { ignore: 'node_modules/**' });
                     await updateSpecifiersAndFileExtensions(primaryFiles, 'commonjs', '.cjs');
                 }
+                if (exportsOpt) {
+                    const esmRoot = isCjsBuild ? primaryOutDir : absoluteDualOutDir;
+                    const cjsRoot = isCjsBuild ? absoluteDualOutDir : primaryOutDir;
+                    await generateExports({
+                        mode: exportsOpt,
+                        pkg,
+                        pkgDir,
+                        esmRoot,
+                        cjsRoot,
+                        mainDefaultKind,
+                        mainPath,
+                    });
+                }
                 logSuccess(startTime);
             }
         }

package/dist/cjs/init.cjs

@@ -37,6 +37,10 @@ const init = async (args) => {
                     short: 'd',
                     default: false,
                 },
+                exports: {
+                    type: 'string',
+                    short: 'e',
+                },
                 help: {
                     type: 'boolean',
                     short: 'h',
@@ -57,10 +61,11 @@ const init = async (args) => {
         (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.');
     }
     else {
-        const { project, 'target-extension': targetExt, 'pkg-dir': pkgDir, modules, dirs, } = parsed;
+        const { project, 'target-extension': targetExt, 'pkg-dir': pkgDir, modules, dirs, exports: exportsOpt, } = parsed;
         let configPath = (0, node_path_1.resolve)(project);
         let stats = null;
         let pkg = null;
@@ -96,10 +101,15 @@ const init = async (args) => {
             if (!tsconfig.compilerOptions?.outDir) {
                 (0, util_js_1.log)('No outDir defined in tsconfig.json. Build output will be in "dist".');
             }
+            if (exportsOpt && !['wildcard', 'dir', 'name'].includes(exportsOpt)) {
+                (0, util_js_1.logError)('--exports expects one of: wildcard | dir | name');
+                return false;
+            }
             return {
                 pkg,
                 dirs,
                 modules,
+                exports: exportsOpt,
                 tsconfig,
                 projectDir,
                 configPath,

package/dist/cjs/init.d.cts

@@ -2,6 +2,7 @@ export function init(args: any): Promise<false | {
     pkg: import("read-package-up", { with: { "resolution-mode": "import" } }).NormalizedReadResult;
     dirs: boolean;
     modules: boolean;
+    exports: string | undefined;
     tsconfig: {
         compilerOptions?: import("get-tsconfig").TsConfigJson.CompilerOptions | undefined;
         watchOptions?: import("get-tsconfig").TsConfigJson.WatchOptions | undefined;

package/dist/esm/duel.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 import { argv, platform } from 'node:process';
-import { join, dirname, resolve, relative } from 'node:path';
+import { join, dirname, resolve, relative, parse as parsePath } from 'node:path';
 import { spawn } from 'node:child_process';
 import { writeFile, rm, rename, mkdir, cp, access, readFile } from 'node:fs/promises';
 import { randomBytes } from 'node:crypto';
@@ -10,15 +10,178 @@ import { findUp } from 'find-up';
 import { transform } from '@knighted/module';
 import { init } from './init.js';
 import { getRealPathAsFileUrl, getCompileFiles, logError, log } from './util.js';
+const stripKnownExt = path => {
+    return path.replace(/(\.d\.(?:ts|mts|cts)|\.(?:mjs|cjs|js))$/, '');
+};
+const ensureDotSlash = path => {
+    return path.startsWith('./') ? path : `./${path}`;
+};
+const getSubpath = (mode, relFromRoot) => {
+    const parsed = parsePath(relFromRoot);
+    const segments = parsed.dir.split('/').filter(Boolean);
+    if (mode === 'name') {
+        return parsed.name ? `./${parsed.name}` : null;
+    }
+    if (mode === 'dir') {
+        const last = segments.at(-1);
+        return last ? `./${last}` : null;
+    }
+    if (mode === 'wildcard') {
+        const first = segments[0];
+        return first ? `./${first}/*` : null;
+    }
+    return null;
+};
 const handleErrorAndExit = message => {
     const exitCode = Number(message);
     logError('Compilation errors found.');
     process.exit(exitCode);
 };
+const generateExports = async (options) => {
+    const { mode, pkg, pkgDir, esmRoot, cjsRoot, mainDefaultKind, mainPath } = options;
+    const toPosix = path => path.replace(/\\/g, '/');
+    const esmRootPosix = toPosix(esmRoot);
+    const cjsRootPosix = toPosix(cjsRoot);
+    const esmIgnore = ['node_modules/**'];
+    const cjsIgnore = ['node_modules/**'];
+    const baseMap = new Map();
+    const subpathMap = new Map();
+    const baseToSubpath = new Map();
+    if (cjsRootPosix.startsWith(`${esmRootPosix}/`)) {
+        esmIgnore.push(`${cjsRootPosix}/**`);
+    }
+    if (esmRootPosix.startsWith(`${cjsRootPosix}/`)) {
+        cjsIgnore.push(`${esmRootPosix}/**`);
+    }
+    const recordPath = (kind, filePath, root) => {
+        const relPkg = toPosix(relative(pkgDir, filePath));
+        const relFromRoot = toPosix(relative(root, filePath));
+        const withDot = ensureDotSlash(relPkg);
+        const baseKey = stripKnownExt(relPkg);
+        const baseEntry = baseMap.get(baseKey) ?? {};
+        baseEntry[kind] = withDot;
+        baseMap.set(baseKey, baseEntry);
+        const subpath = getSubpath(mode, relFromRoot);
+        if (kind === 'types') {
+            const mappedSubpath = baseToSubpath.get(baseKey);
+            if (mappedSubpath) {
+                const subEntry = subpathMap.get(mappedSubpath) ?? {};
+                subEntry.types = withDot;
+                subpathMap.set(mappedSubpath, subEntry);
+            }
+            return;
+        }
+        if (subpath && subpath !== '.') {
+            const subEntry = subpathMap.get(subpath) ?? {};
+            subEntry[kind] = withDot;
+            subpathMap.set(subpath, subEntry);
+            baseToSubpath.set(baseKey, subpath);
+        }
+    };
+    const esmFiles = await glob(`${esmRootPosix}/**/*.{js,mjs,d.ts,d.mts}`, {
+        ignore: esmIgnore,
+    });
+    for (const file of esmFiles) {
+        if (/\.d\.(ts|mts)$/.test(file)) {
+            recordPath('types', file, esmRoot);
+        }
+        else {
+            recordPath('import', file, esmRoot);
+        }
+    }
+    const cjsFiles = await glob(`${cjsRootPosix}/**/*.{js,cjs,d.ts,d.cts}`, {
+        ignore: cjsIgnore,
+    });
+    for (const file of cjsFiles) {
+        if (/\.d\.(ts|cts)$/.test(file)) {
+            recordPath('types', file, cjsRoot);
+        }
+        else {
+            recordPath('require', file, cjsRoot);
+        }
+    }
+    const exportsMap = {};
+    const mainBase = mainPath ? stripKnownExt(mainPath.replace(/^\.\//, '')) : null;
+    const mainEntry = mainBase ? (baseMap.get(mainBase) ?? {}) : {};
+    if (mainPath) {
+        const rootEntry = {};
+        if (mainEntry.types) {
+            rootEntry.types = mainEntry.types;
+        }
+        if (mainDefaultKind === 'import') {
+            rootEntry.import = mainEntry.import ?? ensureDotSlash(mainPath);
+            if (mainEntry.require) {
+                rootEntry.require = mainEntry.require;
+            }
+        }
+        else {
+            rootEntry.require = mainEntry.require ?? ensureDotSlash(mainPath);
+            if (mainEntry.import) {
+                rootEntry.import = mainEntry.import;
+            }
+        }
+        rootEntry.default = ensureDotSlash(mainPath);
+        exportsMap['.'] = rootEntry;
+    }
+    const defaultKind = mainDefaultKind ?? 'import';
+    for (const [subpath, entry] of subpathMap.entries()) {
+        const out = {};
+        if (entry.types) {
+            out.types = entry.types;
+        }
+        if (entry.import) {
+            out.import = entry.import;
+        }
+        if (entry.require) {
+            out.require = entry.require;
+        }
+        const def = defaultKind === 'import'
+            ? (entry.import ?? entry.require)
+            : (entry.require ?? entry.import);
+        if (def) {
+            out.default = def;
+        }
+        if (Object.keys(out).length) {
+            exportsMap[subpath] = out;
+        }
+    }
+    if (!exportsMap['.'] && baseMap.size) {
+        const [subpath, entry] = subpathMap.entries().next().value ?? [];
+        if (entry) {
+            const out = {};
+            if (entry.types) {
+                out.types = entry.types;
+            }
+            if (entry.import) {
+                out.import = entry.import;
+            }
+            if (entry.require) {
+                out.require = entry.require;
+            }
+            const def = defaultKind === 'import'
+                ? (entry.import ?? entry.require)
+                : (entry.require ?? entry.import);
+            if (def) {
+                out.default = def;
+            }
+            if (Object.keys(out).length) {
+                exportsMap['.'] = out;
+                exportsMap[subpath] ??= out;
+            }
+        }
+    }
+    if (Object.keys(exportsMap).length) {
+        const pkgJson = {
+            ...pkg.packageJson,
+            exports: exportsMap,
+        };
+        await writeFile(pkg.path, `${JSON.stringify(pkgJson, null, 2)}\n`);
+    }
+};
 const duel = async (args) => {
     const ctx = await init(args);
     if (ctx) {
-        const { projectDir, tsconfig, configPath, modules, dirs, pkg } = ctx;
+        const { projectDir, tsconfig, configPath, modules, dirs, pkg, exports: exportsOpt, } = ctx;
         const tsc = await findUp(async (dir) => {
             const tscBin = join(dir, 'node_modules', '.bin', 'tsc');
             try {
@@ -42,6 +205,8 @@ const duel = async (args) => {
             });
         };
         const pkgDir = dirname(pkg.path);
+        const mainPath = pkg.packageJson.main;
+        const mainDefaultKind = mainPath?.endsWith('.cjs') ? 'require' : 'import';
         const outDir = tsconfig.compilerOptions?.outDir ?? 'dist';
         const absoluteOutDir = resolve(projectDir, outDir);
         const originalType = pkg.packageJson.type ?? 'commonjs';
@@ -189,6 +354,19 @@ const duel = async (args) => {
                     const primaryFiles = await glob(`${primaryOutDir.replace(/\\/g, '/')}/**/*{.js,.d.ts}`, { ignore: 'node_modules/**' });
                     await updateSpecifiersAndFileExtensions(primaryFiles, 'commonjs', '.cjs');
                 }
+                if (exportsOpt) {
+                    const esmRoot = isCjsBuild ? primaryOutDir : absoluteDualOutDir;
+                    const cjsRoot = isCjsBuild ? absoluteDualOutDir : primaryOutDir;
+                    await generateExports({
+                        mode: exportsOpt,
+                        pkg,
+                        pkgDir,
+                        esmRoot,
+                        cjsRoot,
+                        mainDefaultKind,
+                        mainPath,
+                    });
+                }
                 logSuccess(startTime);
             }
         }

package/dist/esm/init.d.ts

@@ -2,6 +2,7 @@ export function init(args: any): Promise<false | {
     pkg: import("read-package-up").NormalizedReadResult;
     dirs: boolean;
     modules: boolean;
+    exports: string | undefined;
     tsconfig: {
         compilerOptions?: import("get-tsconfig").TsConfigJson.CompilerOptions | undefined;
         watchOptions?: import("get-tsconfig").TsConfigJson.WatchOptions | undefined;

package/dist/esm/init.js

@@ -34,6 +34,10 @@ const init = async (args) => {
                     short: 'd',
                     default: false,
                 },
+                exports: {
+                    type: 'string',
+                    short: 'e',
+                },
                 help: {
                     type: 'boolean',
                     short: 'h',
@@ -54,10 +58,11 @@ const init = async (args) => {
         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.');
     }
     else {
-        const { project, 'target-extension': targetExt, 'pkg-dir': pkgDir, modules, dirs, } = parsed;
+        const { project, 'target-extension': targetExt, 'pkg-dir': pkgDir, modules, dirs, exports: exportsOpt, } = parsed;
         let configPath = resolve(project);
         let stats = null;
         let pkg = null;
@@ -93,10 +98,15 @@ const init = async (args) => {
             if (!tsconfig.compilerOptions?.outDir) {
                 log('No outDir defined in tsconfig.json. Build output will be in "dist".');
             }
+            if (exportsOpt && !['wildcard', 'dir', 'name'].includes(exportsOpt)) {
+                logError('--exports expects one of: wildcard | dir | name');
+                return false;
+            }
             return {
                 pkg,
                 dirs,
                 modules,
+                exports: exportsOpt,
                 tsconfig,
                 projectDir,
                 configPath,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knighted/duel",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "TypeScript dual packages.",
   "type": "module",
   "main": "dist/esm/duel.js",