@nx/jest 18.1.0-beta.1 → 18.1.0-beta.3

package/index.d.ts

@@ -5,4 +5,4 @@ export declare const jestProjectGenerator: typeof configurationGenerator;
 export { addPropertyToJestConfig, removePropertyFromJestConfig, } from './src/utils/config/update-config';
 export { jestConfigObjectAst } from './src/utils/config/functions';
 export { jestInitGenerator } from './src/generators/init/init';
-export { getJestProjects, getNestedJestProjects, } from './src/utils/config/get-jest-projects';
+export { getJestProjects, getJestProjectsAsync, getNestedJestProjects, } from './src/utils/config/get-jest-projects';

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNestedJestProjects = exports.getJestProjects = exports.jestInitGenerator = exports.jestConfigObjectAst = exports.removePropertyFromJestConfig = exports.addPropertyToJestConfig = exports.jestProjectGenerator = exports.configurationGenerator = void 0;
+exports.getNestedJestProjects = exports.getJestProjectsAsync = exports.getJestProjects = exports.jestInitGenerator = exports.jestConfigObjectAst = exports.removePropertyFromJestConfig = exports.addPropertyToJestConfig = exports.jestProjectGenerator = exports.configurationGenerator = void 0;
 const configuration_1 = require("./src/generators/configuration/configuration");
 Object.defineProperty(exports, "configurationGenerator", { enumerable: true, get: function () { return configuration_1.configurationGenerator; } });
 // Exported for backwards compatibility in case a plugin is using the old name.
@@ -15,4 +15,5 @@ var init_1 = require("./src/generators/init/init");
 Object.defineProperty(exports, "jestInitGenerator", { enumerable: true, get: function () { return init_1.jestInitGenerator; } });
 var get_jest_projects_1 = require("./src/utils/config/get-jest-projects");
 Object.defineProperty(exports, "getJestProjects", { enumerable: true, get: function () { return get_jest_projects_1.getJestProjects; } });
+Object.defineProperty(exports, "getJestProjectsAsync", { enumerable: true, get: function () { return get_jest_projects_1.getJestProjectsAsync; } });
 Object.defineProperty(exports, "getNestedJestProjects", { enumerable: true, get: function () { return get_jest_projects_1.getNestedJestProjects; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/jest",
-  "version": "18.1.0-beta.1",
+  "version": "18.1.0-beta.3",
   "private": false,
   "description": "The Nx Plugin for Jest contains executors and generators allowing your workspace to use the powerful Jest testing capabilities.",
   "repository": {
@@ -36,6 +36,8 @@
   "dependencies": {
     "@jest/reporters": "^29.4.1",
     "@jest/test-result": "^29.4.1",
+    "@nx/devkit": "18.1.0-beta.3",
+    "@nx/js": "18.1.0-beta.3",
     "@phenomnomnominal/tsquery": "~5.0.1",
     "chalk": "^4.1.0",
     "identity-obj-proxy": "3.0.0",
@@ -45,9 +47,8 @@
     "minimatch": "9.0.3",
     "resolve.exports": "1.1.0",
     "tslib": "^2.3.0",
-    "@nx/devkit": "18.1.0-beta.1",
-    "@nx/js": "18.1.0-beta.1",
-    "@nrwl/jest": "18.1.0-beta.1"
+    "yargs-parser": "21.1.1",
+    "@nrwl/jest": "18.1.0-beta.3"
   },
   "publishConfig": {
     "access": "public"

package/src/generators/configuration/configuration.js

@@ -24,7 +24,10 @@ function normalizeOptions(tree, options) {
     if (!options.testEnvironment) {
         options.testEnvironment = 'jsdom';
     }
-    options.addPlugin ??= process.env.NX_ADD_PLUGINS !== 'false';
+    const nxJson = (0, devkit_1.readNxJson)(tree);
+    const addPlugin = process.env.NX_ADD_PLUGINS !== 'false' &&
+        nxJson.useInferencePlugins !== false;
+    options.addPlugin ??= addPlugin;
     options.targetName ??= 'test';
     if (!options.hasOwnProperty('supportTsx')) {
         options.supportTsx = false;

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

@@ -44,9 +44,9 @@ async function createJestConfig(tree, options, presetExt) {
             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 !==
+            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;
@@ -87,16 +87,16 @@ exports.createJestConfig = createJestConfig;
 function generateGlobalConfig(tree, isJS) {
     const contents = isJS
         ? (0, devkit_1.stripIndents) `
-    const { getJestProjects } = require('@nx/jest');
+    const { getJestProjectsAsync } = require('@nx/jest');
 
-    module.exports = {
-      projects: getJestProjects()
-    };`
+    module.exports = async () => ({
+      projects: await getJestProjectsAsync()
+    });`
         : (0, devkit_1.stripIndents) `
-    import { getJestProjects } from '@nx/jest';
+    import { getJestProjectsAsync } from '@nx/jest';
 
-    export default {
-     projects: getJestProjects()
-    };`;
+    export default async () => ({
+     projects: await getJestProjectsAsync()
+    });`;
     tree.write(`jest.config.${isJS ? 'js' : 'ts'}`, contents);
 }

package/src/generators/configuration/lib/update-jestconfig.js

@@ -6,7 +6,12 @@ const update_config_1 = require("../../../utils/config/update-config");
 const devkit_1 = require("@nx/devkit");
 function isUsingUtilityFunction(host) {
     const rootConfig = (0, find_root_jest_files_1.findRootJestConfig)(host);
-    return (rootConfig && host.read(rootConfig).toString().includes('getJestProjects()'));
+    if (!rootConfig) {
+        return false;
+    }
+    const rootConfigContent = host.read(rootConfig, 'utf-8');
+    return (rootConfigContent.includes('getJestProjects()') ||
+        rootConfigContent.includes('getJestProjectsAsync()'));
 }
 function updateJestConfig(host, options) {
     if (isUsingUtilityFunction(host)) {

package/src/generators/init/init.js

@@ -75,7 +75,10 @@ function jestInitGenerator(tree, options) {
 }
 exports.jestInitGenerator = jestInitGenerator;
 async function jestInitGeneratorInternal(tree, options) {
-    options.addPlugin ??= process.env.NX_ADD_PLUGINS !== 'false';
+    const nxJson = (0, devkit_1.readNxJson)(tree);
+    const addPluginDefault = process.env.NX_ADD_PLUGINS !== 'false' &&
+        nxJson.useInferencePlugins !== false;
+    options.addPlugin ??= addPluginDefault;
     const presetExt = (0, is_preset_cjs_1.isPresetCjs)(tree) ? 'cjs' : 'js';
     if (!tree.exists('jest.preset.js') && !tree.exists('jest.preset.cjs')) {
         updateProductionFileSet(tree, presetExt);

package/src/plugins/plugin.js

@@ -45,6 +45,13 @@ exports.createNodes = [
                 return {};
             }
         }
+        const jestConfigContent = (0, fs_1.readFileSync)((0, path_1.resolve)(context.workspaceRoot, configFilePath), 'utf-8');
+        if (jestConfigContent.includes('getJestProjectsAsync()')) {
+            // The `getJestProjectsAsync` function uses the project graph, which leads to a
+            // circular dependency. We can skip this since it's no intended to be used for
+            // an Nx project.
+            return {};
+        }
         options = normalizeOptions(options);
         const hash = (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(projectRoot, options, context);
         const targets = targetsCache[hash] ??

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

@@ -2,7 +2,8 @@
  * 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.
+ * This is used to configure Jest multi-project support. To support projects
+ * using inferred targets @see getJestProjectsAsync
  *
  * To add a project not using the Nx Jest executor:
  * export default {
@@ -17,3 +18,17 @@ 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,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNestedJestProjects = exports.getJestProjects = void 0;
-const path_1 = require("path");
+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");
+const path_1 = require("path");
+const yargs = require("yargs-parser");
 function getJestConfigProjectPath(projectJestConfigPath) {
     return (0, path_1.join)('<rootDir>', projectJestConfigPath);
 }
@@ -10,7 +12,8 @@ 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.
+ * This is used to configure Jest multi-project support. To support projects
+ * using inferred targets @see getJestProjectsAsync
  *
  * To add a project not using the Nx Jest executor:
  * export default {
@@ -60,3 +63,95 @@ 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));
+        }
+    }
+}