@knighted/duel 1.0.0-rc.3 → 1.0.0-rc.4

package/README.md

@@ -11,12 +11,10 @@ Node.js tool for building a TypeScript dual package.
 * Bidirectional ESM ↔️ CJS dual builds inferred from the package.json `type`.
 * Correctly preserves module systems for `.mts` and `.cts` file extensions.
 * Use only one package.json and tsconfig.json.
-* Run builds in parallel.
 
 ## Requirements
 
 * Node >= 16.19.0.
-* A tsconfig.json with `outDir` defined.
 
 ## Example
 
@@ -72,7 +70,7 @@ Assuming an `outDir` of `dist`, running the above will create `dist/esm` and `di
 
 ### Parallel builds
 
-For a slightly faster build, you can run them in parallel. This is experimental, as your mileage may vary based on the size of your `node_modules` directory.
+This is experimental, as your mileage may vary based on the size of your `node_modules` directory.
 
 ```json
 "scripts": {
@@ -80,7 +78,7 @@ For a slightly faster build, you can run them in parallel. This is experimental,
 }
 ```
 
-You _might_ save an extra few seconds from your builds, but not much more. This requires first copying your project to a parent directory of `--project` if it exists as a writable folder. Common [gitignored directories for Node.js projects](https://github.com/github/gitignore/blob/main/Node.gitignore) are not copied, with the exception of `node_modules`. See the [notes](#notes) as to why this can't be improved much further.
+You _might_ reduce your build times, but only if your project has minimal dependencies. This requires first copying your project to a parent directory of `--project` if it exists as a writable folder. Common [gitignored directories for Node.js projects](https://github.com/github/gitignore/blob/main/Node.gitignore) are not copied, with the exception of `node_modules`. See the [notes](#notes) as to why this can't be improved much further. In most cases, you're better off with serial builds.
 
 ## Options
 
@@ -89,7 +87,7 @@ The available options are limited, because you should define most of them inside
 * `--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.
 * `--dirs, -d` Outputs both builds to directories inside of `outDir`. Defalts to `false`.
-* `--parallel, -l` Run the builds in parallel.
+* `--parallel, -l` Run the builds in parallel. Defaults to `false`.
 
 You can run `duel --help` to get the same info. Below is the output of that:
 
@@ -118,5 +116,5 @@ These are definitely edge cases, and would only really come up if your project m
 
 ## Notes
 
-As far as I can tell, `duel` is one (if not the only) way to get a correct dual package build using only `tsc` while using only **one package.json** file and **one tsconfig.json** file, _and also_ preserving module system by file extension. The Microsoft backed TypeScript team [keep](https://github.com/microsoft/TypeScript/issues/54593) [talking](https://github.com/microsoft/TypeScript/pull/54546) about dual build support, but their philosophy is mainly one of self perseverance, rather than collaboration. For instance, they continue to refuse to rewrite specifiers. The downside of their decisions, and the fact that `npm` does not support using alternative names for the package.json file, is that `duel` must copy your project
+As far as I can tell, `duel` is one (if not the only) way to get a correct dual package build using only `tsc` while using only **one package.json** file and **one tsconfig.json** file, _and also_ preserving module system by file extension. The Microsoft backed TypeScript team [keep](https://github.com/microsoft/TypeScript/issues/54593) [talking](https://github.com/microsoft/TypeScript/pull/54546) about dual build support, but their philosophy is mainly one of self-preservation, rather than collaboration. For instance, they continue to [refuse to rewrite specifiers](https://github.com/microsoft/TypeScript/issues/16577). The downside of their decisions, and the fact that `npm` does not support using alternative names for the package.json file, is that `duel` must copy your project
 directory before attempting to run the builds in parallel.

package/dist/duel.cjs

@@ -49,6 +49,7 @@ const duel = async args => {
     } = 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';
@@ -91,6 +92,10 @@ const duel = async args => {
     const logSuccess = start => {
       (0, _util.log)(`Successfully created a dual ${isCjsBuild ? 'CJS' : 'ESM'} build in ${Math.round(_nodePerf_hooks.performance.now() - start)}ms.`);
     };
+    await (0, _promises.rm)(absoluteOutDir, {
+      force: true,
+      recursive: true
+    });
     if (parallel) {
       const paraName = `_${hex}_`;
       const paraParent = (0, _nodePath.join)(projectDir, '..');
@@ -111,6 +116,7 @@ const duel = async args => {
         return;
       }
       (0, _util.log)('Preparing parallel build...');
+      const prepStart = _nodePerf_hooks.performance.now();
       await (0, _promises.cp)(projectDir, paraTempDir, {
         recursive: true,
         /**
@@ -128,6 +134,7 @@ const duel = async args => {
       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();
@@ -140,7 +147,6 @@ const duel = async args => {
         (0, _util.logError)(message);
       }
       if (success) {
-        const absoluteOutDir = (0, _nodePath.resolve)(projectDir, outDir);
         const absoluteDualOutDir = (0, _nodePath.join)(paraTempDir, dualOutDir);
         const filenames = await (0, _glob.glob)(`${absoluteDualOutDir}/**/*{.js,.d.ts}`, {
           ignore: 'node_modules/**'
@@ -169,7 +175,6 @@ const duel = async args => {
       if (success) {
         const dualConfigPath = (0, _nodePath.join)(projectDir, `tsconfig.${hex}.json`);
         const dualOutDir = isCjsBuild ? (0, _nodePath.join)(outDir, 'cjs') : (0, _nodePath.join)(outDir, 'esm');
-        // Using structuredClone() would require node >= 17.0.0
         const tsconfigDual = getOverrideTsConfig(dualOutDir);
         const pkgRename = 'package.json.bak';
 

package/dist/duel.js

@@ -43,6 +43,7 @@ const duel = async args => {
     } = 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';
@@ -85,6 +86,10 @@ const duel = async args => {
     const logSuccess = start => {
       log(`Successfully created a dual ${isCjsBuild ? 'CJS' : 'ESM'} build in ${Math.round(performance.now() - start)}ms.`);
     };
+    await rm(absoluteOutDir, {
+      force: true,
+      recursive: true
+    });
     if (parallel) {
       const paraName = `_${hex}_`;
       const paraParent = join(projectDir, '..');
@@ -105,6 +110,7 @@ const duel = async args => {
         return;
       }
       log('Preparing parallel build...');
+      const prepStart = performance.now();
       await cp(projectDir, paraTempDir, {
         recursive: true,
         /**
@@ -122,6 +128,7 @@ const duel = async args => {
       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();
@@ -134,7 +141,6 @@ const duel = async args => {
         logError(message);
       }
       if (success) {
-        const absoluteOutDir = resolve(projectDir, outDir);
         const absoluteDualOutDir = join(paraTempDir, dualOutDir);
         const filenames = await glob(`${absoluteDualOutDir}/**/*{.js,.d.ts}`, {
           ignore: 'node_modules/**'
@@ -163,7 +169,6 @@ const duel = async args => {
       if (success) {
         const dualConfigPath = join(projectDir, `tsconfig.${hex}.json`);
         const dualOutDir = isCjsBuild ? join(outDir, 'cjs') : join(outDir, 'esm');
-        // Using structuredClone() would require node >= 17.0.0
         const tsconfigDual = getOverrideTsConfig(dualOutDir);
         const pkgRename = 'package.json.bak';
 

package/dist/init.cjs

@@ -109,8 +109,7 @@ const init = async args => {
         return false;
       }
       if (!tsconfig.compilerOptions?.outDir) {
-        (0, _util.logError)('You must define an `outDir` in your project config.');
-        return false;
+        (0, _util.log)('No `outDir` defined in tsconfig.json. Build output will be in "dist".');
       }
       const projectDir = (0, _nodePath.dirname)(configPath);
       return {

package/dist/init.js

@@ -103,8 +103,7 @@ const init = async args => {
         return false;
       }
       if (!tsconfig.compilerOptions?.outDir) {
-        logError('You must define an `outDir` in your project config.');
-        return false;
+        log('No `outDir` defined in tsconfig.json. Build output will be in "dist".');
       }
       const projectDir = dirname(configPath);
       return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knighted/duel",
-  "version": "1.0.0-rc.3",
+  "version": "1.0.0-rc.4",
   "description": "TypeScript dual packages.",
   "type": "module",
   "main": "dist",
@@ -28,8 +28,8 @@
     "tsc",
     "typescript",
     "dual package",
-    "cjs",
-    "mjs"
+    "cts",
+    "mts"
   ],
   "files": [
     "dist"