@nx/jest 23.1.0-beta.3 → 23.1.0-beta.5

package/dist/src/generators/configuration/configuration.js

@@ -3,8 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.configurationGenerator = configurationGenerator;
 exports.configurationGeneratorInternal = configurationGeneratorInternal;
 const devkit_1 = require("@nx/devkit");
+const internal_1 = require("@nx/devkit/internal");
 const js_1 = require("@nx/js");
-const internal_1 = require("@nx/js/internal");
+const internal_2 = require("@nx/js/internal");
 const config_file_1 = require("../../utils/config/config-file");
 const init_1 = require("../init/init");
 const assert_supported_jest_version_1 = require("../../utils/assert-supported-jest-version");
@@ -47,7 +48,7 @@ function normalizeOptions(tree, options) {
         ...options,
         keepExistingVersions: options.keepExistingVersions ?? true,
         rootProject: project.root === '.' || project.root === '',
-        isTsSolutionSetup: (0, internal_1.isUsingTsSolutionSetup)(tree),
+        isTsSolutionSetup: (0, internal_2.isUsingTsSolutionSetup)(tree),
     };
 }
 function configurationGenerator(tree, schema) {
@@ -93,12 +94,17 @@ async function configurationGeneratorInternal(tree, schema) {
         ignoreTestOutput(tree);
         // in the TS solution setup, the test target depends on the build outputs
         // so we need to setup the task pipeline accordingly
-        const nxJson = (0, devkit_1.readNxJson)(tree);
-        nxJson.targetDefaults ??= {};
-        nxJson.targetDefaults[options.targetName] ??= {};
-        nxJson.targetDefaults[options.targetName].dependsOn ??= [];
-        nxJson.targetDefaults[options.targetName].dependsOn.push('^build');
-        nxJson.targetDefaults[options.targetName].dependsOn = Array.from(new Set(nxJson.targetDefaults[options.targetName].dependsOn));
+        const nxJson = (0, devkit_1.readNxJson)(tree) ?? {};
+        // A bare `target` locator matches only the unfiltered generic entry, so we
+        // extend the workspace-wide baseline rather than a project-scoped one.
+        const existing = (0, internal_1.findTargetDefault)(nxJson.targetDefaults, {
+            target: options.targetName,
+        });
+        const dependsOn = Array.from(new Set([...(existing?.dependsOn ?? []), '^build']));
+        (0, internal_1.upsertTargetDefault)(tree, nxJson, {
+            target: options.targetName,
+            dependsOn,
+        });
         (0, devkit_1.updateNxJson)(tree, nxJson);
     }
     if (!schema.skipFormat) {

package/dist/src/generators/init/init.js

@@ -29,27 +29,44 @@ function updateProductionFileSet(tree) {
     (0, devkit_1.updateNxJson)(tree, nxJson);
 }
 function addJestTargetDefaults(tree, presetExt) {
-    const nxJson = (0, devkit_1.readNxJson)(tree);
-    nxJson.targetDefaults ??= {};
-    nxJson.targetDefaults['@nx/jest:jest'] ??= {};
+    const nxJson = (0, devkit_1.readNxJson)(tree) ?? {};
     const productionFileSet = nxJson.namedInputs?.production;
-    nxJson.targetDefaults['@nx/jest:jest'].cache ??= true;
+    // Manage the workspace-wide `@nx/jest:jest` default; `upsertTargetDefault`
+    // updates the unfiltered entry (or creates one), leaving any project- or
+    // plugin-scoped jest overrides the user authored untouched.
+    const existing = (0, internal_1.findTargetDefault)(nxJson.targetDefaults, {
+        executor: '@nx/jest:jest',
+    });
+    const patch = createJestDefaultPatch(existing, productionFileSet, presetExt);
+    if (Object.keys(patch).length > 0) {
+        (0, internal_1.upsertTargetDefault)(tree, nxJson, { executor: '@nx/jest:jest', ...patch });
+        (0, devkit_1.updateNxJson)(tree, nxJson);
+    }
+}
+function createJestDefaultPatch(existing, productionFileSet, presetExt) {
+    const patch = {};
+    if (existing?.cache === undefined)
+        patch.cache = true;
     // Test targets depend on all their project's sources + production sources of dependencies
-    nxJson.targetDefaults['@nx/jest:jest'].inputs ??= [
-        'default',
-        productionFileSet ? '^production' : '^default',
-        `{workspaceRoot}/jest.preset.${presetExt}`,
-    ];
-    nxJson.targetDefaults['@nx/jest:jest'].options ??= {
-        passWithNoTests: true,
-    };
-    nxJson.targetDefaults['@nx/jest:jest'].configurations ??= {
-        ci: {
-            ci: true,
-            codeCoverage: true,
-        },
-    };
-    (0, devkit_1.updateNxJson)(tree, nxJson);
+    if (existing?.inputs === undefined) {
+        patch.inputs = [
+            'default',
+            productionFileSet ? '^production' : '^default',
+            `{workspaceRoot}/jest.preset.${presetExt}`,
+        ];
+    }
+    if (existing?.options === undefined) {
+        patch.options = { passWithNoTests: true };
+    }
+    if (existing?.configurations === undefined) {
+        patch.configurations = {
+            ci: {
+                ci: true,
+                codeCoverage: true,
+            },
+        };
+    }
+    return patch;
 }
 function updateDependencies(tree, options) {
     const { jestVersion, nxVersion } = (0, versions_1.versions)(tree);

package/dist/src/migrations/update-21-0-0/remove-tsconfig-option-from-jest-executor.js

@@ -19,29 +19,24 @@ async function default_1(tree) {
         }
         (0, devkit_1.updateProjectConfiguration)(tree, project, projectConfiguration);
     });
-    // update options from nx.json target defaults
+    // update options from nx.json target defaults. `updateTargetDefault` walks
+    // both the object and filtered array value forms, drops entries left with
+    // nothing but their executor locator, and collapses lone unfiltered ones
+    // back to the object form.
     const nxJson = (0, devkit_1.readNxJson)(tree);
-    if (nxJson.targetDefaults) {
-        for (const [targetOrExecutor, targetConfig] of Object.entries(nxJson.targetDefaults)) {
-            if (targetOrExecutor !== EXECUTOR_TO_MIGRATE &&
-                targetConfig.executor !== EXECUTOR_TO_MIGRATE) {
-                continue;
-            }
-            if (targetConfig.options) {
-                updateOptions(targetConfig);
-            }
-            Object.keys(targetConfig.configurations ?? {}).forEach((config) => {
-                updateConfiguration(targetConfig, config);
+    if (nxJson?.targetDefaults) {
+        (0, internal_1.updateTargetDefault)(nxJson, { executor: EXECUTOR_TO_MIGRATE }, (config) => {
+            if (config.options)
+                updateOptions(config);
+            Object.keys(config.configurations ?? {}).forEach((configuration) => {
+                updateConfiguration(config, configuration);
             });
-            if (!Object.keys(targetConfig).length ||
-                (Object.keys(targetConfig).length === 1 &&
-                    Object.keys(targetConfig)[0] === 'executor')) {
-                delete nxJson.targetDefaults[targetOrExecutor];
+            // Drop the entry once nothing but its executor locator remains.
+            const keys = Object.keys(config);
+            if (keys.length === 0 || (keys.length === 1 && keys[0] === 'executor')) {
+                return null;
             }
-            if (!Object.keys(nxJson.targetDefaults).length) {
-                delete nxJson.targetDefaults;
-            }
-        }
+        });
         (0, devkit_1.updateNxJson)(tree, nxJson);
     }
     await (0, devkit_1.formatFiles)(tree);

package/dist/src/migrations/update-21-3-0/rename-test-path-pattern.js

@@ -14,24 +14,21 @@ async function default_1(tree) {
         renameTestPathPattern(config);
         (0, devkit_1.updateProjectConfiguration)(tree, project, projectConfiguration);
     });
-    // update options from nx.json target defaults
+    // update options from nx.json target defaults. Migration order isn't
+    // guaranteed, so a default may already be in the filtered array shape;
+    // `updateTargetDefault` walks both the object and array value forms.
     const nxJson = (0, devkit_1.readNxJson)(tree);
-    if (!nxJson.targetDefaults) {
-        return;
-    }
-    for (const [targetOrExecutor, targetConfig] of Object.entries(nxJson.targetDefaults)) {
-        if (targetOrExecutor !== '@nx/jest:jest' &&
-            targetConfig.executor !== '@nx/jest:jest') {
-            continue;
-        }
-        if (targetConfig.options) {
-            renameTestPathPattern(targetConfig.options);
-        }
-        Object.values(targetConfig.configurations ?? {}).forEach((config) => {
-            renameTestPathPattern(config);
+    if (nxJson?.targetDefaults) {
+        (0, internal_1.updateTargetDefault)(nxJson, { executor: '@nx/jest:jest' }, (config) => {
+            if (config.options) {
+                renameTestPathPattern(config.options);
+            }
+            Object.values(config.configurations ?? {}).forEach((c) => {
+                renameTestPathPattern(c);
+            });
         });
+        (0, devkit_1.updateNxJson)(tree, nxJson);
     }
-    (0, devkit_1.updateNxJson)(tree, nxJson);
     await (0, devkit_1.formatFiles)(tree);
 }
 function renameTestPathPattern(config) {

package/dist/src/migrations/update-23-0-0/migrate-jest-executor-setup-file.js

@@ -190,47 +190,40 @@ function migrateInheritedSetupFile(tree, project, target, nxJson, projectConfigC
 function stripSetupFileFromNxJson(tree, nxJson) {
     if (!nxJson?.targetDefaults)
         return false;
-    let changed = false;
     let hadSetupFile = false;
-    for (const [targetOrExecutor, targetConfig] of Object.entries(nxJson.targetDefaults)) {
-        if (targetOrExecutor !== EXECUTOR_TO_MIGRATE &&
-            targetConfig.executor !== EXECUTOR_TO_MIGRATE) {
-            continue;
-        }
-        if (targetConfig.options?.setupFile !== undefined) {
+    // Migration order isn't guaranteed, so a default may already be in the
+    // filtered array shape; `updateTargetDefault` walks both value forms, drops
+    // entries the callback empties, and collapses lone unfiltered ones back to
+    // the object form.
+    (0, internal_1.updateTargetDefault)(nxJson, { executor: EXECUTOR_TO_MIGRATE }, (config) => {
+        if (config.options?.setupFile !== undefined) {
             hadSetupFile = true;
-            changed = true;
-            delete targetConfig.options.setupFile;
-            if (!Object.keys(targetConfig.options).length) {
-                delete targetConfig.options;
+            delete config.options.setupFile;
+            if (!Object.keys(config.options).length) {
+                delete config.options;
             }
         }
-        for (const config of Object.keys(targetConfig.configurations ?? {})) {
-            if (targetConfig.configurations[config]?.setupFile !== undefined) {
+        for (const configuration of Object.keys(config.configurations ?? {})) {
+            if (config.configurations[configuration]?.setupFile !== undefined) {
                 hadSetupFile = true;
-                changed = true;
-                delete targetConfig.configurations[config].setupFile;
-                if (!Object.keys(targetConfig.configurations[config]).length &&
-                    (!targetConfig.defaultConfiguration ||
-                        targetConfig.defaultConfiguration !== config)) {
-                    delete targetConfig.configurations[config];
+                delete config.configurations[configuration].setupFile;
+                if (!Object.keys(config.configurations[configuration]).length &&
+                    (!config.defaultConfiguration ||
+                        config.defaultConfiguration !== configuration)) {
+                    delete config.configurations[configuration];
                 }
             }
         }
-        if (targetConfig.configurations &&
-            !Object.keys(targetConfig.configurations).length) {
-            delete targetConfig.configurations;
+        if (config.configurations && !Object.keys(config.configurations).length) {
+            delete config.configurations;
         }
-        if (!Object.keys(targetConfig).length ||
-            (Object.keys(targetConfig).length === 1 &&
-                Object.keys(targetConfig)[0] === 'executor')) {
-            delete nxJson.targetDefaults[targetOrExecutor];
+        // Drop the entry once nothing but its executor locator remains.
+        const keys = Object.keys(config);
+        if (keys.length === 0 || (keys.length === 1 && keys[0] === 'executor')) {
+            return null;
         }
-    }
-    if (!Object.keys(nxJson.targetDefaults).length) {
-        delete nxJson.targetDefaults;
-    }
-    if (changed)
+    });
+    if (hadSetupFile)
         (0, devkit_1.updateNxJson)(tree, nxJson);
     return hadSetupFile;
 }

package/dist/src/migrations/update-23-0-0/migrate-jest-executor-setup-file.md

@@ -137,7 +137,7 @@ Remove the option from a target default using the `@nx/jest:jest` executor:
 
 Per-project paths don't make sense as workspace defaults, so the option is removed without rewriting individual project Jest configs. A warning is logged so the setup file path can be added to each project's Jest config manually if needed.
 
-Remove the option from a target default using the `@nx/jest:jest` executor as the key:
+Remove the option from a target default entry matching on the `@nx/jest:jest` executor:
 
 ##### Before
 

package/dist/src/migrations/update-23-1-0/set-ts-jest-isolated-modules.md

@@ -39,3 +39,13 @@ TypeScript 6 and above resolves `exports` under `bundler` with `commonjs`, so th
   }
 }
 ```
+
+#### Verifying the workspace
+
+After the migration runs, verify the workspace still typechecks and fix anything `isolatedModules` surfaced:
+
+```bash
+nx run-many -t typecheck
+```
+
+`isolatedModules` can fail typecheck (TS1205 - re-exporting a type needs `export type`; TS2748 - const enum access) or break a project's tests at runtime even when typecheck passes. The cause is a package that re-exports a value through both `module.exports` and an ESM `export` (for example napi bindings exposing a `const enum`); per-file transpilation cannot preserve it, and consumers of that const enum break too. To fix a broken project, remove `isolatedModules` from its `tsconfig.spec.json`; if that brings back the `TS2307: Cannot find module` error this migration was added to prevent, that project needs `isolatedModules`, so fix the source instead.

package/dist/src/migrations/update-23-1-0/verify-typecheck.md

@@ -0,0 +1,14 @@
+# Verify typecheck after the Nx 23.1 migration
+
+This migration enables `isolatedModules` on ts-jest spec configs. Run
+`nx run-many -t typecheck` and fix any project it broke.
+
+`isolatedModules` can fail typecheck (TS1205 - a re-exported type needs `export type`;
+TS2748 - const enum access) or break a project's tests at runtime. To fix a broken
+project, remove `isolatedModules` from its `tsconfig.spec.json` and re-run. If a
+`TS2307: Cannot find module` error then appears for a workspace library, that project
+needs `isolatedModules` - keep it and fix the source instead (avoid mixing
+`module.exports` with an ESM `export`, and avoid cross-file `const enum`).
+
+Re-run until the projects this migration touched typecheck. See the migration
+documentation for details.

package/migrations.json

@@ -79,12 +79,13 @@
       "documentation": "./dist/src/migrations/update-23-0-0/migrate-create-nodes-v2-to-create-nodes.md"
     },
     "set-ts-jest-isolated-modules": {
-      "version": "23.1.0-beta.3",
+      "version": "23.1.0-beta.4",
       "requires": {
         "ts-jest": ">=29.2.0"
       },
-      "description": "Set `isolatedModules: true` in `tsconfig.spec.json` for ts-jest projects on TypeScript < 6. ts-jest 29.2+ forces `moduleResolution: node10` on the CommonJS path, which ignores package `exports` maps and breaks (TS2307) resolution of exports-only workspace libraries; transpiling per file avoids the type-resolution failure.",
+      "description": "Set `isolatedModules: true` in `tsconfig.spec.json` for ts-jest projects on TypeScript < 6 (ts-jest 29.2+ forces `moduleResolution: node10` on the CommonJS path, which ignores package `exports` maps and breaks resolution of exports-only workspace libraries), then verify the workspace still typechecks and remedy any failures the change surfaced.",
       "implementation": "./dist/src/migrations/update-23-1-0/set-ts-jest-isolated-modules",
+      "prompt": "./dist/src/migrations/update-23-1-0/verify-typecheck.md",
       "documentation": "./dist/src/migrations/update-23-1-0/set-ts-jest-isolated-modules.md"
     }
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/jest",
-  "version": "23.1.0-beta.3",
+  "version": "23.1.0-beta.5",
   "private": false,
   "type": "commonjs",
   "files": [
@@ -117,11 +117,11 @@
     "semver": "^7.6.3",
     "tslib": "^2.3.0",
     "yargs-parser": "21.1.1",
-    "@nx/devkit": "23.1.0-beta.3",
-    "@nx/js": "23.1.0-beta.3"
+    "@nx/devkit": "23.1.0-beta.5",
+    "@nx/js": "23.1.0-beta.5"
   },
   "devDependencies": {
-    "nx": "23.1.0-beta.3"
+    "nx": "23.1.0-beta.5"
   },
   "publishConfig": {
     "access": "public"