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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/jest",
-  "version": "17.3.0-beta.3",
+  "version": "17.3.0-beta.5",
   "private": false,
   "description": "The Nx Plugin for Jest contains executors and generators allowing your workspace to use the powerful Jest testing capabilities.",
   "repository": {
@@ -45,9 +45,9 @@
     "minimatch": "3.0.5",
     "resolve.exports": "1.1.0",
     "tslib": "^2.3.0",
-    "@nx/devkit": "17.3.0-beta.3",
-    "@nx/js": "17.3.0-beta.3",
-    "@nrwl/jest": "17.3.0-beta.3"
+    "@nx/devkit": "17.3.0-beta.5",
+    "@nx/js": "17.3.0-beta.5",
+    "@nrwl/jest": "17.3.0-beta.5"
   },
   "publishConfig": {
     "access": "public"

package/src/generators/configuration/configuration.js

@@ -4,9 +4,13 @@ exports.configurationGenerator = void 0;
 const init_1 = require("../init/init");
 const check_for_test_target_1 = require("./lib/check-for-test-target");
 const create_files_1 = require("./lib/create-files");
+const create_jest_config_1 = require("./lib/create-jest-config");
+const ensure_dependencies_1 = require("./lib/ensure-dependencies");
 const update_tsconfig_1 = require("./lib/update-tsconfig");
+const update_vscode_recommended_extensions_1 = require("./lib/update-vscode-recommended-extensions");
 const update_workspace_1 = require("./lib/update-workspace");
 const devkit_1 = require("@nx/devkit");
+const js_1 = require("@nx/js");
 const schemaDefaults = {
     setupFile: 'none',
     babelJest: false,
@@ -41,10 +45,17 @@ function normalizeOptions(tree, options) {
 }
 async function configurationGenerator(tree, schema) {
     const options = normalizeOptions(tree, schema);
-    const installTask = await (0, init_1.default)(tree, options);
+    const tasks = [];
+    tasks.push(await (0, js_1.initGenerator)(tree, { ...schema, skipFormat: true }));
+    tasks.push(await (0, init_1.jestInitGenerator)(tree, options));
+    if (!schema.skipPackageJson) {
+        tasks.push((0, ensure_dependencies_1.ensureDependencies)(tree, options));
+    }
+    await (0, create_jest_config_1.createJestConfig)(tree, options);
     (0, check_for_test_target_1.checkForTestTarget)(tree, options);
     (0, create_files_1.createFiles)(tree, options);
     (0, update_tsconfig_1.updateTsConfig)(tree, options);
+    (0, update_vscode_recommended_extensions_1.updateVsCodeRecommendedExtensions)(tree);
     const nxJson = (0, devkit_1.readNxJson)(tree);
     const hasPlugin = nxJson.plugins?.some((p) => typeof p === 'string'
         ? p === '@nx/jest/plugin'
@@ -55,7 +66,7 @@ async function configurationGenerator(tree, schema) {
     if (!schema.skipFormat) {
         await (0, devkit_1.formatFiles)(tree);
     }
-    return installTask;
+    return (0, devkit_1.runTasksInSerial)(...tasks);
 }
 exports.configurationGenerator = configurationGenerator;
 exports.default = configurationGenerator;

package/src/generators/configuration/lib/create-jest-config.d.ts

@@ -0,0 +1,3 @@
+import { type Tree } from '@nx/devkit';
+import type { NormalizedJestProjectSchema } from '../schema';
+export declare function createJestConfig(tree: Tree, options: Partial<NormalizedJestProjectSchema>): Promise<void>;

package/src/generators/configuration/lib/create-jest-config.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createJestConfig = void 0;
+const devkit_1 = require("@nx/devkit");
+const project_configuration_utils_1 = require("nx/src/project-graph/utils/project-configuration-utils");
+const find_root_jest_files_1 = require("../../../utils/config/find-root-jest-files");
+async function createJestConfig(tree, options) {
+    if (!tree.exists('jest.preset.js')) {
+        // preset is always js file.
+        tree.write(`jest.preset.js`, `
+      const nxPreset = require('@nx/jest/preset').default;
+
+      module.exports = { ...nxPreset }`);
+    }
+    if (options.rootProject) {
+        // we don't want any config to be made because the `configurationGenerator` will do it.
+        // will copy the template config file
+        return;
+    }
+    const rootJestPath = (0, find_root_jest_files_1.findRootJestConfig)(tree);
+    if (!rootJestPath) {
+        // if there's not root jest config, we will create one and return
+        // this can happen when:
+        // - root jest config was renamed => in which case there is migration needed
+        // - root project didn't have jest setup => again, no migration is needed
+        generateGlobalConfig(tree, options.js);
+        return;
+    }
+    if (tree.exists(rootJestPath)) {
+        // moving from root project config to monorepo-style config
+        const { nodes: projects } = await (0, devkit_1.createProjectGraphAsync)();
+        const projectConfigurations = Object.values(projects);
+        const rootProject = projectConfigurations.find((projectNode) => projectNode.data?.root === '.');
+        // root project might have been removed,
+        // if it's missing there's nothing to migrate
+        if (rootProject) {
+            const jestTarget = Object.entries(rootProject.data?.targets ?? {}).find(([_, t]) => ((t?.executor === '@nx/jest:jest' ||
+                t?.executor === '@nrwl/jest:jest') &&
+                t?.options?.jestConfig === rootJestPath) ||
+                (t?.executor === 'nx:run-commands' && t?.options?.command === 'jest'));
+            if (!jestTarget) {
+                return;
+            }
+            const [jestTargetName, jestTargetConfigInGraph] = jestTarget;
+            // if root project doesn't have jest target, there's nothing to migrate
+            const rootProjectConfig = (0, devkit_1.readProjectConfiguration)(tree, rootProject.name);
+            if (rootProjectConfig.targets['test']?.executor === 'nx:run-commands'
+                ? rootProjectConfig.targets['test']?.command !== 'jest'
+                : rootProjectConfig.targets['test']?.options?.jestConfig !==
+                    rootJestPath) {
+                // Jest target has already been updated
+                return;
+            }
+            const jestProjectConfig = `jest.config.${rootProjectConfig.projectType === 'application' ? 'app' : 'lib'}.${options.js ? 'js' : 'ts'}`;
+            tree.rename(rootJestPath, jestProjectConfig);
+            const nxJson = (0, devkit_1.readNxJson)(tree);
+            const targetDefaults = (0, project_configuration_utils_1.readTargetDefaultsForTarget)(jestTargetName, nxJson.targetDefaults, jestTargetConfigInGraph.executor);
+            const target = (rootProjectConfig.targets[jestTargetName] ??=
+                jestTargetConfigInGraph.executor === 'nx:run-commands'
+                    ? { command: `jest --config ${jestProjectConfig}` }
+                    : {
+                        executor: jestTargetConfigInGraph.executor,
+                        options: {},
+                    });
+            if (target.executor === '@nx/jest:jest') {
+                target.options.jestConfig = jestProjectConfig;
+            }
+            if (targetDefaults?.cache === undefined) {
+                target.cache = jestTargetConfigInGraph.cache;
+            }
+            if (targetDefaults?.inputs === undefined) {
+                target.inputs = jestTargetConfigInGraph.inputs;
+            }
+            if (targetDefaults?.outputs === undefined) {
+                target.outputs = jestTargetConfigInGraph.outputs;
+            }
+            if (targetDefaults?.dependsOn === undefined) {
+                target.dependsOn = jestTargetConfigInGraph.dependsOn;
+            }
+            (0, devkit_1.updateProjectConfiguration)(tree, rootProject.name, rootProjectConfig);
+            // generate new global config as it was move to project config or is missing
+            generateGlobalConfig(tree, options.js);
+        }
+    }
+}
+exports.createJestConfig = createJestConfig;
+function generateGlobalConfig(tree, isJS) {
+    const contents = isJS
+        ? (0, devkit_1.stripIndents) `
+    const { getJestProjects } = require('@nx/jest');
+
+    module.exports = {
+      projects: getJestProjects()
+    };`
+        : (0, devkit_1.stripIndents) `
+    import { getJestProjects } from '@nx/jest';
+
+    export default {
+     projects: getJestProjects()
+    };`;
+    tree.write(`jest.config.${isJS ? 'js' : 'ts'}`, contents);
+}

package/src/generators/configuration/lib/ensure-dependencies.d.ts

@@ -0,0 +1,3 @@
+import { type Tree } from '@nx/devkit';
+import type { NormalizedJestProjectSchema } from '../schema';
+export declare function ensureDependencies(tree: Tree, options: Partial<NormalizedJestProjectSchema>): import("@nx/devkit").GeneratorCallback;

package/src/generators/configuration/lib/ensure-dependencies.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureDependencies = void 0;
+const devkit_1 = require("@nx/devkit");
+const versions_1 = require("../../../utils/versions");
+function ensureDependencies(tree, options) {
+    const dependencies = {
+        tslib: versions_1.tslibVersion,
+    };
+    const devDeps = {
+        // because the default jest-preset uses ts-jest,
+        // jest will throw an error if it's not installed
+        // even if not using it in overriding transformers
+        'ts-jest': versions_1.tsJestVersion,
+    };
+    if (options.testEnvironment !== 'none') {
+        devDeps[`jest-environment-${options.testEnvironment}`] = versions_1.jestVersion;
+    }
+    if (!options.js) {
+        devDeps['ts-node'] = versions_1.tsNodeVersion;
+        devDeps['@types/jest'] = versions_1.jestTypesVersion;
+        devDeps['@types/node'] = versions_1.typesNodeVersion;
+    }
+    if (options.compiler === 'babel' || options.babelJest) {
+        devDeps['babel-jest'] = versions_1.babelJestVersion;
+        // in some cases @nx/js will not already be present i.e. node only projects
+        devDeps['@nx/js'] = versions_1.nxVersion;
+    }
+    else if (options.compiler === 'swc') {
+        devDeps['@swc/jest'] = versions_1.swcJestVersion;
+    }
+    return (0, devkit_1.addDependenciesToPackageJson)(tree, dependencies, devDeps);
+}
+exports.ensureDependencies = ensureDependencies;

package/src/generators/configuration/lib/update-vscode-recommended-extensions.d.ts

@@ -0,0 +1,2 @@
+import { type Tree } from '@nx/devkit';
+export declare function updateVsCodeRecommendedExtensions(host: Tree): void;

package/src/generators/configuration/lib/update-vscode-recommended-extensions.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateVsCodeRecommendedExtensions = void 0;
+const devkit_1 = require("@nx/devkit");
+function updateVsCodeRecommendedExtensions(host) {
+    if (!host.exists('.vscode/extensions.json')) {
+        return;
+    }
+    (0, devkit_1.updateJson)(host, '.vscode/extensions.json', (json) => {
+        json.recommendations = json.recommendations || [];
+        const extension = 'firsttris.vscode-jest-runner';
+        if (!json.recommendations.includes(extension)) {
+            json.recommendations.push(extension);
+        }
+        return json;
+    });
+}
+exports.updateVsCodeRecommendedExtensions = updateVsCodeRecommendedExtensions;

package/src/generators/init/init.d.ts

@@ -1,4 +1,4 @@
-import { GeneratorCallback, Tree } from '@nx/devkit';
-import { JestInitSchema } from './schema';
-export declare function jestInitGenerator(tree: Tree, schema: JestInitSchema): Promise<GeneratorCallback>;
+import { type GeneratorCallback, type Tree } from '@nx/devkit';
+import type { JestInitSchema } from './schema';
+export declare function jestInitGenerator(tree: Tree, options: JestInitSchema): Promise<GeneratorCallback>;
 export default jestInitGenerator;

package/src/generators/init/init.js

@@ -2,32 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.jestInitGenerator = void 0;
 const devkit_1 = require("@nx/devkit");
-const js_1 = require("@nx/js");
-const find_root_jest_files_1 = require("../../utils/config/find-root-jest-files");
 const versions_1 = require("../../utils/versions");
-const project_configuration_utils_1 = require("nx/src/project-graph/utils/project-configuration-utils");
-const schemaDefaults = {
-    compiler: 'tsc',
-    js: false,
-    rootProject: false,
-    testEnvironment: 'jsdom',
-};
-function generateGlobalConfig(tree, isJS) {
-    const contents = isJS
-        ? (0, devkit_1.stripIndents) `
-    const { getJestProjects } = require('@nx/jest');
-
-    module.exports = {
-      projects: getJestProjects()
-    };`
-        : (0, devkit_1.stripIndents) `
-    import { getJestProjects } from '@nx/jest';
-
-    export default {
-     projects: getJestProjects()
-    };`;
-    tree.write(`jest.config.${isJS ? 'js' : 'ts'}`, contents);
-}
 function addPlugin(tree) {
     const nxJson = (0, devkit_1.readNxJson)(tree);
     nxJson.plugins ??= [];
@@ -43,93 +18,6 @@ function addPlugin(tree) {
     }
     (0, devkit_1.updateNxJson)(tree, nxJson);
 }
-async function createJestConfig(tree, options) {
-    if (!tree.exists('jest.preset.js')) {
-        // preset is always js file.
-        tree.write(`jest.preset.js`, `
-      const nxPreset = require('@nx/jest/preset').default;
-
-      module.exports = { ...nxPreset }`);
-        const shouldAddPlugin = process.env.NX_PCV3 === 'true';
-        if (shouldAddPlugin) {
-            addPlugin(tree);
-        }
-        updateProductionFileSet(tree);
-        if (!shouldAddPlugin) {
-            addJestTargetDefaults(tree, shouldAddPlugin);
-        }
-    }
-    if (options.rootProject) {
-        // we don't want any config to be made because the `configurationGenerator` will do it.
-        // will copy the template config file
-        return;
-    }
-    const rootJestPath = (0, find_root_jest_files_1.findRootJestConfig)(tree);
-    if (!rootJestPath) {
-        // if there's not root jest config, we will create one and return
-        // this can happen when:
-        // - root jest config was renamed => in which case there is migration needed
-        // - root project didn't have jest setup => again, no migration is needed
-        generateGlobalConfig(tree, options.js);
-        return;
-    }
-    if (tree.exists(rootJestPath)) {
-        // moving from root project config to monorepo-style config
-        const { nodes: projects } = await (0, devkit_1.createProjectGraphAsync)();
-        const projectConfigurations = Object.values(projects);
-        const rootProject = projectConfigurations.find((projectNode) => projectNode.data?.root === '.');
-        // root project might have been removed,
-        // if it's missing there's nothing to migrate
-        if (rootProject) {
-            const jestTarget = Object.entries(rootProject.data?.targets ?? {}).find(([_, t]) => ((t?.executor === '@nx/jest:jest' ||
-                t?.executor === '@nrwl/jest:jest') &&
-                t?.options?.jestConfig === rootJestPath) ||
-                (t?.executor === 'nx:run-commands' && t?.options?.command === 'jest'));
-            if (!jestTarget) {
-                return;
-            }
-            const [jestTargetName, jestTargetConfigInGraph] = jestTarget;
-            // if root project doesn't have jest target, there's nothing to migrate
-            const rootProjectConfig = (0, devkit_1.readProjectConfiguration)(tree, rootProject.name);
-            if (rootProjectConfig.targets['test']?.executor === 'nx:run-commands'
-                ? rootProjectConfig.targets['test']?.command !== 'jest'
-                : rootProjectConfig.targets['test']?.options?.jestConfig !==
-                    rootJestPath) {
-                // Jest target has already been updated
-                return;
-            }
-            const jestProjectConfig = `jest.config.${rootProjectConfig.projectType === 'application' ? 'app' : 'lib'}.${options.js ? 'js' : 'ts'}`;
-            tree.rename(rootJestPath, jestProjectConfig);
-            const nxJson = (0, devkit_1.readNxJson)(tree);
-            const targetDefaults = (0, project_configuration_utils_1.readTargetDefaultsForTarget)(jestTargetName, nxJson.targetDefaults, jestTargetConfigInGraph.executor);
-            const target = (rootProjectConfig.targets[jestTargetName] ??=
-                jestTargetConfigInGraph.executor === 'nx:run-commands'
-                    ? { command: `jest --config ${jestProjectConfig}` }
-                    : {
-                        executor: jestTargetConfigInGraph.executor,
-                        options: {},
-                    });
-            if (target.executor === '@nx/jest:jest') {
-                target.options.jestConfig = jestProjectConfig;
-            }
-            if (targetDefaults?.cache === undefined) {
-                target.cache = jestTargetConfigInGraph.cache;
-            }
-            if (targetDefaults?.inputs === undefined) {
-                target.inputs = jestTargetConfigInGraph.inputs;
-            }
-            if (targetDefaults?.outputs === undefined) {
-                target.outputs = jestTargetConfigInGraph.outputs;
-            }
-            if (targetDefaults?.dependsOn === undefined) {
-                target.dependsOn = jestTargetConfigInGraph.dependsOn;
-            }
-            (0, devkit_1.updateProjectConfiguration)(tree, rootProject.name, rootProjectConfig);
-            // generate new global config as it was move to project config or is missing
-            generateGlobalConfig(tree, options.js);
-        }
-    }
-}
 function updateProductionFileSet(tree) {
     const nxJson = (0, devkit_1.readNxJson)(tree);
     const productionFileSet = nxJson.namedInputs?.production;
@@ -150,20 +38,18 @@ function updateProductionFileSet(tree) {
     }
     (0, devkit_1.updateNxJson)(tree, nxJson);
 }
-function addJestTargetDefaults(tree, hasPlugin) {
+function addJestTargetDefaults(tree) {
     const nxJson = (0, devkit_1.readNxJson)(tree);
     nxJson.targetDefaults ??= {};
     nxJson.targetDefaults['@nx/jest:jest'] ??= {};
-    if (!hasPlugin) {
-        const productionFileSet = nxJson.namedInputs?.production;
-        nxJson.targetDefaults['@nx/jest:jest'].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.js',
-        ];
-    }
+    const productionFileSet = nxJson.namedInputs?.production;
+    nxJson.targetDefaults['@nx/jest:jest'].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.js',
+    ];
     nxJson.targetDefaults['@nx/jest:jest'].options ??= {
         passWithNoTests: true,
     };
@@ -175,70 +61,31 @@ function addJestTargetDefaults(tree, hasPlugin) {
     };
     (0, devkit_1.updateNxJson)(tree, nxJson);
 }
-function updateDependencies(tree, options) {
-    const dependencies = {
-        tslib: versions_1.tslibVersion,
-    };
-    const devDeps = {
+function updateDependencies(tree) {
+    return (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
         '@nx/jest': versions_1.nxVersion,
         jest: versions_1.jestVersion,
-        // because the default jest-preset uses ts-jest,
-        // jest will throw an error if it's not installed
-        // even if not using it in overriding transformers
-        'ts-jest': versions_1.tsJestVersion,
-    };
-    if (options.testEnvironment !== 'none') {
-        devDeps[`jest-environment-${options.testEnvironment}`] = versions_1.jestVersion;
-    }
-    if (!options.js) {
-        devDeps['ts-node'] = versions_1.tsNodeVersion;
-        devDeps['@types/jest'] = versions_1.jestTypesVersion;
-        devDeps['@types/node'] = versions_1.typesNodeVersion;
-    }
-    if (options.compiler === 'babel' || options.babelJest) {
-        devDeps['babel-jest'] = versions_1.babelJestVersion;
-        // in some cases @nx/js will not already be present i.e. node only projects
-        devDeps['@nx/js'] = versions_1.nxVersion;
-    }
-    else if (options.compiler === 'swc') {
-        devDeps['@swc/jest'] = versions_1.swcJestVersion;
-    }
-    return (0, devkit_1.addDependenciesToPackageJson)(tree, dependencies, devDeps);
-}
-function updateExtensions(host) {
-    if (!host.exists('.vscode/extensions.json')) {
-        return;
-    }
-    (0, devkit_1.updateJson)(host, '.vscode/extensions.json', (json) => {
-        json.recommendations = json.recommendations || [];
-        const extension = 'firsttris.vscode-jest-runner';
-        if (!json.recommendations.includes(extension)) {
-            json.recommendations.push(extension);
-        }
-        return json;
     });
 }
-async function jestInitGenerator(tree, schema) {
-    const options = normalizeOptions(schema);
+async function jestInitGenerator(tree, options) {
+    if (!tree.exists('jest.preset.js')) {
+        updateProductionFileSet(tree);
+        if (process.env.NX_PCV3 === 'true') {
+            addPlugin(tree);
+        }
+        else {
+            addJestTargetDefaults(tree);
+        }
+    }
     const tasks = [];
-    tasks.push(await (0, js_1.initGenerator)(tree, {
-        ...schema,
-        skipFormat: true,
-    }));
-    await createJestConfig(tree, options);
     if (!options.skipPackageJson) {
-        (0, devkit_1.removeDependenciesFromPackageJson)(tree, ['@nx/jest'], []);
-        const installTask = updateDependencies(tree, options);
-        tasks.push(installTask);
+        tasks.push((0, devkit_1.removeDependenciesFromPackageJson)(tree, ['@nx/jest'], []));
+        tasks.push(updateDependencies(tree));
+    }
+    if (!options.skipFormat) {
+        await (0, devkit_1.formatFiles)(tree);
     }
-    updateExtensions(tree);
     return (0, devkit_1.runTasksInSerial)(...tasks);
 }
 exports.jestInitGenerator = jestInitGenerator;
-function normalizeOptions(options) {
-    return {
-        ...schemaDefaults,
-        ...options,
-    };
-}
 exports.default = jestInitGenerator;

package/src/generators/init/schema.d.ts

@@ -1,11 +1,4 @@
 export interface JestInitSchema {
-  compiler?: 'tsc' | 'babel' | 'swc';
-  js?: boolean;
+  skipFormat?: boolean;
   skipPackageJson?: boolean;
-  testEnvironment?: 'node' | 'jsdom' | 'none';
-  /**
-   * @deprecated
-   */
-  babelJest?: boolean;
-  rootProject?: boolean;
 }

package/src/generators/init/schema.json

@@ -6,35 +6,16 @@
   "description": "Add Jest Configuration to a workspace.",
   "type": "object",
   "properties": {
-    "babelJest": {
-      "type": "boolean",
-      "alias": "babel-jest",
-      "description": "Use `babel-jest` instead of `ts-jest`.",
-      "default": false
-    },
-    "skipPackageJson": {
+    "skipFormat": {
+      "description": "Skip formatting files.",
       "type": "boolean",
       "default": false,
-      "description": "Do not add dependencies to `package.json`.",
       "x-priority": "internal"
     },
-    "testEnvironment": {
-      "type": "string",
-      "enum": ["jsdom", "node", "none"],
-      "description": "The test environment for jest. This controls which jest-environment-* package is installed",
-      "default": "jsdom",
-      "x-priority": "important"
-    },
-    "js": {
-      "type": "boolean",
-      "default": false,
-      "description": "Use JavaScript instead of TypeScript for config files"
-    },
-    "rootProject": {
-      "description": "initialize Jest for an application at the root of the workspace",
+    "skipPackageJson": {
       "type": "boolean",
       "default": false,
-      "hidden": true,
+      "description": "Do not add dependencies to `package.json`.",
       "x-priority": "internal"
     }
   },