@nx/jest 17.0.5 → 17.0.6

package/src/generators/init/schema.json

@@ -1,16 +1,16 @@
 {
-  "$schema": "https://json-schema.org/schema",
+  "$schema": "http://json-schema.org/schema",
   "$id": "NxJestInit",
   "cli": "nx",
   "title": "Jest init",
   "description": "Add Jest Configuration to a workspace.",
   "type": "object",
   "properties": {
-    "skipFormat": {
-      "description": "Skip formatting files.",
+    "babelJest": {
       "type": "boolean",
-      "default": false,
-      "x-priority": "internal"
+      "alias": "babel-jest",
+      "description": "Use `babel-jest` instead of `ts-jest`.",
+      "default": false
     },
     "skipPackageJson": {
       "type": "boolean",
@@ -18,17 +18,24 @@
       "description": "Do not add dependencies to `package.json`.",
       "x-priority": "internal"
     },
-    "keepExistingVersions": {
+    "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",
-      "x-priority": "internal",
-      "description": "Keep existing dependencies versions",
-      "default": false
+      "default": false,
+      "description": "Use JavaScript instead of TypeScript for config files"
     },
-    "updatePackageScripts": {
+    "rootProject": {
+      "description": "initialize Jest for an application at the root of the workspace",
       "type": "boolean",
-      "x-priority": "internal",
-      "description": "Update `package.json` scripts with inferred targets",
-      "default": false
+      "default": false,
+      "hidden": true,
+      "x-priority": "internal"
     }
   },
   "required": []

package/src/utils/config/find-root-jest-files.js

@@ -15,9 +15,6 @@ function findRootJestPreset(tree) {
     if (tree.exists('jest.preset.js')) {
         return 'jest.preset.js';
     }
-    if (tree.exists('jest.preset.cjs')) {
-        return 'jest.preset.cjs';
-    }
     return null;
 }
 exports.findRootJestPreset = findRootJestPreset;

package/src/utils/config/get-jest-projects.d.ts

@@ -2,8 +2,7 @@
  * Get a list of paths to all the jest config files
  * using the Nx Jest executor.
  *
- * This is used to configure Jest multi-project support. To support projects
- * using inferred targets @see getJestProjectsAsync
+ * This is used to configure Jest multi-project support.
  *
  * To add a project not using the Nx Jest executor:
  * export default {
@@ -18,17 +17,3 @@ export declare function getJestProjects(): string[];
  * https://jestjs.io/docs/configuration#testpathignorepatterns-arraystring
  * */
 export declare function getNestedJestProjects(): string[];
-/**
- * Get a list of paths to all the jest config files
- * using the Nx Jest executor and `@nx/run:commands`
- * running `jest`.
- *
- * This is used to configure Jest multi-project support.
- *
- * To add a project not using the Nx Jest executor:
- * export default async () => ({
- *   projects: [...(await getJestProjectsAsync()), '<rootDir>/path/to/jest.config.ts'];
- * });
- *
- **/
-export declare function getJestProjectsAsync(): Promise<string[]>;

package/src/utils/config/get-jest-projects.js

@@ -1,10 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getJestProjectsAsync = exports.getNestedJestProjects = exports.getJestProjects = void 0;
-const devkit_1 = require("@nx/devkit");
-const file_utils_1 = require("nx/src/project-graph/file-utils");
+exports.getNestedJestProjects = exports.getJestProjects = void 0;
 const path_1 = require("path");
-const yargs = require("yargs-parser");
+const file_utils_1 = require("nx/src/project-graph/file-utils");
 function getJestConfigProjectPath(projectJestConfigPath) {
     return (0, path_1.join)('<rootDir>', projectJestConfigPath);
 }
@@ -12,8 +10,7 @@ function getJestConfigProjectPath(projectJestConfigPath) {
  * Get a list of paths to all the jest config files
  * using the Nx Jest executor.
  *
- * This is used to configure Jest multi-project support. To support projects
- * using inferred targets @see getJestProjectsAsync
+ * This is used to configure Jest multi-project support.
  *
  * To add a project not using the Nx Jest executor:
  * export default {
@@ -63,95 +60,3 @@ function getNestedJestProjects() {
     return ['/node_modules/'];
 }
 exports.getNestedJestProjects = getNestedJestProjects;
-/**
- * Get a list of paths to all the jest config files
- * using the Nx Jest executor and `@nx/run:commands`
- * running `jest`.
- *
- * This is used to configure Jest multi-project support.
- *
- * To add a project not using the Nx Jest executor:
- * export default async () => ({
- *   projects: [...(await getJestProjectsAsync()), '<rootDir>/path/to/jest.config.ts'];
- * });
- *
- **/
-async function getJestProjectsAsync() {
-    const graph = await (0, devkit_1.createProjectGraphAsync)({
-        exitOnError: false,
-        resetDaemonClient: true,
-    });
-    const jestConfigurations = new Set();
-    for (const node of Object.values(graph.nodes)) {
-        const projectConfig = node.data;
-        if (!projectConfig.targets) {
-            continue;
-        }
-        for (const targetConfiguration of Object.values(projectConfig.targets)) {
-            if (targetConfiguration.executor === '@nx/jest:jest' ||
-                targetConfiguration.executor === '@nrwl/jest:jest') {
-                collectJestConfigFromJestExecutor(targetConfiguration, jestConfigurations);
-            }
-            else if (targetConfiguration.executor === 'nx:run-commands') {
-                collectJestConfigFromRunCommandsExecutor(targetConfiguration, projectConfig.root, jestConfigurations);
-            }
-        }
-    }
-    return Array.from(jestConfigurations);
-}
-exports.getJestProjectsAsync = getJestProjectsAsync;
-function collectJestConfigFromJestExecutor(targetConfiguration, jestConfigurations) {
-    if (targetConfiguration.options?.jestConfig) {
-        jestConfigurations.add(getJestConfigProjectPath(targetConfiguration.options.jestConfig));
-    }
-    if (targetConfiguration.configurations) {
-        for (const configurationObject of Object.values(targetConfiguration.configurations)) {
-            if (configurationObject.jestConfig) {
-                jestConfigurations.add(getJestConfigProjectPath(configurationObject.jestConfig));
-            }
-        }
-    }
-}
-function collectJestConfigFromRunCommandsExecutor(targetConfiguration, projectRoot, jestConfigurations) {
-    if (targetConfiguration.options?.command) {
-        collectJestConfigFromCommand(targetConfiguration.options.command, targetConfiguration.options.cwd ?? projectRoot, jestConfigurations);
-    }
-    else if (targetConfiguration.options?.commands) {
-        for (const command of targetConfiguration.options.commands) {
-            const commandScript = typeof command === 'string' ? command : command.command;
-            collectJestConfigFromCommand(commandScript, targetConfiguration.options.cwd ?? projectRoot, jestConfigurations);
-        }
-    }
-    if (targetConfiguration.configurations) {
-        for (const configurationObject of Object.values(targetConfiguration.configurations)) {
-            if (configurationObject.command) {
-                collectJestConfigFromCommand(configurationObject.command, configurationObject.cwd ?? projectRoot, jestConfigurations);
-            }
-            else if (configurationObject.commands) {
-                for (const command of configurationObject.commands) {
-                    const commandScript = typeof command === 'string' ? command : command.command;
-                    collectJestConfigFromCommand(commandScript, configurationObject.cwd ?? projectRoot, jestConfigurations);
-                }
-            }
-        }
-    }
-}
-function collectJestConfigFromCommand(command, cwd, jestConfigurations) {
-    const jestCommandRegex = /(?<=^|&)(?:[^&\r\n\s]* )*jest(?: [^&\r\n\s]*)*(?=$|&)/g;
-    const matches = command.match(jestCommandRegex);
-    if (!matches) {
-        return;
-    }
-    for (const match of matches) {
-        const parsed = yargs(match, {
-            configuration: { 'strip-dashed': true },
-            string: ['config'],
-        });
-        if (parsed.config) {
-            jestConfigurations.add(getJestConfigProjectPath((0, path_1.join)(cwd, parsed.config)));
-        }
-        else {
-            jestConfigurations.add(getJestConfigProjectPath(cwd));
-        }
-    }
-}

package/src/utils/versions.d.ts

@@ -5,5 +5,5 @@ export declare const jestTypesVersion = "^29.4.0";
 export declare const tsJestVersion = "^29.1.0";
 export declare const tslibVersion = "^2.3.0";
 export declare const swcJestVersion = "0.2.20";
-export declare const typesNodeVersion = "18.16.9";
+export declare const typesNodeVersion = "16.11.7";
 export declare const tsNodeVersion = "10.9.1";

package/src/utils/versions.js

@@ -8,5 +8,5 @@ exports.jestTypesVersion = '^29.4.0';
 exports.tsJestVersion = '^29.1.0';
 exports.tslibVersion = '^2.3.0';
 exports.swcJestVersion = '0.2.20';
-exports.typesNodeVersion = '18.16.9';
+exports.typesNodeVersion = '16.11.7';
 exports.tsNodeVersion = '10.9.1';

package/plugin.d.ts

@@ -1 +0,0 @@
-export { createNodes, createDependencies, JestPluginOptions, } from './src/plugins/plugin';

package/plugin.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDependencies = exports.createNodes = void 0;
-var plugin_1 = require("./src/plugins/plugin");
-Object.defineProperty(exports, "createNodes", { enumerable: true, get: function () { return plugin_1.createNodes; } });
-Object.defineProperty(exports, "createDependencies", { enumerable: true, get: function () { return plugin_1.createDependencies; } });

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

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

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

@@ -1,102 +0,0 @@
-"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, presetExt) {
-    if (!tree.exists(`jest.preset.${presetExt}`)) {
-        // preset is always js file.
-        tree.write(`jest.preset.${presetExt}`, `
-      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 { getJestProjectsAsync } = require('@nx/jest');
-
-    module.exports = async () => ({
-      projects: await getJestProjectsAsync()
-    });`
-        : (0, devkit_1.stripIndents) `
-    import { getJestProjectsAsync } from '@nx/jest';
-
-    export default async () => ({
-     projects: await getJestProjectsAsync()
-    });`;
-    tree.write(`jest.config.${isJS ? 'js' : 'ts'}`, contents);
-}

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

@@ -1,3 +0,0 @@
-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

@@ -1,34 +0,0 @@
-"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

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

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

@@ -1,18 +0,0 @@
-"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/migrations/update-17-1-0/move-options-to-target-defaults.d.ts

@@ -1,2 +0,0 @@
-import { Tree } from '@nx/devkit';
-export default function update(tree: Tree): Promise<void>;

package/src/migrations/update-17-1-0/move-options-to-target-defaults.js

@@ -1,117 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const devkit_1 = require("@nx/devkit");
-const executor_options_utils_1 = require("@nx/devkit/src/generators/executor-options-utils");
-const project_configuration_utils_1 = require("nx/src/project-graph/utils/project-configuration-utils");
-async function update(tree) {
-    const nxJson = (0, devkit_1.readNxJson)(tree);
-    // Don't override anything if there are already target defaults for jest
-    if (nxJson.targetDefaults?.['@nx/jest:jest']) {
-        return;
-    }
-    nxJson.targetDefaults ??= {};
-    /**
-     * A set of targets which does not use any other executors
-     */
-    const jestTargets = new Set();
-    const graph = await (0, devkit_1.createProjectGraphAsync)();
-    (0, executor_options_utils_1.forEachExecutorOptionsInGraph)(graph, '@nx/jest:jest', (value, proj, targetName) => {
-        jestTargets.add(targetName);
-    });
-    // Workspace does not use jest?
-    if (jestTargets.size === 0) {
-        return;
-    }
-    // Use the project graph so targets which are inferred are considered
-    const projects = graph.nodes;
-    const projectMap = (0, devkit_1.getProjects)(tree);
-    const jestDefaults = (nxJson.targetDefaults['@nx/jest:jest'] = {});
-    // All jest targets have the same name
-    if (jestTargets.size === 1) {
-        const targetName = Array.from(jestTargets)[0];
-        if (nxJson.targetDefaults[targetName]) {
-            Object.assign(jestDefaults, nxJson.targetDefaults[targetName]);
-        }
-    }
-    jestDefaults.cache ??= true;
-    const inputs = ['default'];
-    inputs.push(nxJson.namedInputs?.production ? '^production' : '^default');
-    if (tree.exists('jest.preset.js')) {
-        inputs.push('{workspaceRoot}/jest.preset.js');
-    }
-    jestDefaults.inputs ??= inputs;
-    // Remember if there were already defaults so we don't assume the executor default
-    const passWithNoTestsPreviouslyInDefaults = jestDefaults.options?.passWithNoTests !== undefined;
-    const ciCiPreviouslyInDefaults = jestDefaults.configurations?.ci?.ci !== undefined;
-    const ciCodeCoveragePreviouslyInDefaults = jestDefaults.configurations?.ci?.codeCoverage !== undefined;
-    jestDefaults.options ??= {};
-    jestDefaults.options.passWithNoTests ??= true;
-    jestDefaults.configurations ??= {};
-    jestDefaults.configurations.ci ??= {};
-    jestDefaults.configurations.ci.ci ??= true;
-    jestDefaults.configurations.ci.codeCoverage ??= true;
-    // Cleanup old target defaults
-    for (const [targetDefaultKey, targetDefault] of Object.entries(nxJson.targetDefaults)) {
-        if (!isTargetDefaultUsed(targetDefault, nxJson.targetDefaults, projects, projectMap)) {
-            delete nxJson.targetDefaults[targetDefaultKey];
-        }
-    }
-    (0, devkit_1.updateNxJson)(tree, nxJson);
-    (0, executor_options_utils_1.forEachExecutorOptions)(tree, '@nx/jest:jest', (value, proj, targetName, configuration) => {
-        const projConfig = projectMap.get(proj);
-        if (!configuration) {
-            // Options
-            if (value.passWithNoTests === jestDefaults.options.passWithNoTests) {
-                delete projConfig.targets[targetName].options.passWithNoTests;
-            }
-            else if (!passWithNoTestsPreviouslyInDefaults) {
-                projConfig.targets[targetName].options.passWithNoTests ??= false;
-            }
-            if (Object.keys(projConfig.targets[targetName].options).length === 0) {
-                delete projConfig.targets[targetName].options;
-            }
-        }
-        else if (configuration === 'ci') {
-            // CI Config
-            if (value.ci === jestDefaults.configurations.ci.ci) {
-                delete projConfig.targets[targetName].configurations.ci.ci;
-            }
-            else if (ciCiPreviouslyInDefaults) {
-                projConfig.targets[targetName].configurations.ci.ci ??= false;
-            }
-            if (value.codeCoverage === jestDefaults.configurations.ci.codeCoverage) {
-                delete projConfig.targets[targetName].configurations.ci.codeCoverage;
-            }
-            else if (ciCodeCoveragePreviouslyInDefaults) {
-                projConfig.targets[targetName].configurations.ci.codeCoverage ??=
-                    false;
-            }
-            if (Object.keys(projConfig.targets[targetName].configurations.ci)
-                .length === 0) {
-                delete projConfig.targets[targetName].configurations.ci;
-            }
-            if (Object.keys(projConfig.targets[targetName].configurations).length ===
-                0) {
-                delete projConfig.targets[targetName].configurations;
-            }
-        }
-        (0, devkit_1.updateProjectConfiguration)(tree, proj, projConfig);
-    });
-    await (0, devkit_1.formatFiles)(tree);
-}
-exports.default = update;
-/**
- * Checks every target on every project to see if one of them uses the target default
- */
-function isTargetDefaultUsed(targetDefault, targetDefaults, projects, projectMap) {
-    for (const p of Object.values(projects)) {
-        for (const targetName in p.data?.targets ?? {}) {
-            if ((0, project_configuration_utils_1.readTargetDefaultsForTarget)(targetName, targetDefaults, 
-            // It might seem like we should use the graph here too but we don't want to pass an executor which was processed in the graph
-            projectMap.get(p.name)?.targets?.[targetName]?.executor) === targetDefault) {
-                return true;
-            }
-        }
-    }
-    return false;
-}

package/src/plugins/plugin.d.ts

@@ -1,6 +0,0 @@
-import { CreateDependencies, CreateNodes } from '@nx/devkit';
-export interface JestPluginOptions {
-    targetName?: string;
-}
-export declare const createDependencies: CreateDependencies;
-export declare const createNodes: CreateNodes<JestPluginOptions>;