@nx/cypress 0.0.0-pr-32490-e4fdfa9 → 0.0.0-pr-32868-a65a4a2

package/README.md

@@ -22,7 +22,7 @@
 
 # Nx: Smart Repos · Fast Builds
 
-An AI-first build platform that connects everything from your editor to CI. Helping you deliver fast, without breaking things.
+Get to green PRs in half the time. Nx optimizes your builds, scales your CI, and fixes failed PRs. Built for developers and AI agents.
 
 This package is a [Cypress plugin for Nx](https://nx.dev/cypress/overview).
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/cypress",
-  "version": "0.0.0-pr-32490-e4fdfa9",
+  "version": "0.0.0-pr-32868-a65a4a2",
   "private": false,
   "description": "The Nx Plugin for Cypress contains executors and generators allowing your workspace to use the powerful Cypress integration testing capabilities.",
   "repository": {
@@ -36,9 +36,9 @@
     "migrations": "./migrations.json"
   },
   "dependencies": {
-    "@nx/devkit": "0.0.0-pr-32490-e4fdfa9",
-    "@nx/eslint": "0.0.0-pr-32490-e4fdfa9",
-    "@nx/js": "0.0.0-pr-32490-e4fdfa9",
+    "@nx/devkit": "0.0.0-pr-32868-a65a4a2",
+    "@nx/eslint": "0.0.0-pr-32868-a65a4a2",
+    "@nx/js": "0.0.0-pr-32868-a65a4a2",
     "@phenomnomnominal/tsquery": "~5.0.1",
     "detect-port": "^1.5.1",
     "semver": "^7.6.3",
@@ -46,7 +46,7 @@
     "tslib": "^2.3.0"
   },
   "devDependencies": {
-    "nx": "0.0.0-pr-32490-e4fdfa9"
+    "nx": "0.0.0-pr-32868-a65a4a2"
   },
   "peerDependencies": {
     "cypress": ">= 3 < 15"

package/src/plugins/plugin.d.ts

@@ -1,9 +1,10 @@
-import { CreateNodes, CreateNodesV2 } from '@nx/devkit';
+import { type CreateNodes, type CreateNodesV2 } from '@nx/devkit';
 export interface CypressPluginOptions {
     ciTargetName?: string;
     targetName?: string;
     openTargetName?: string;
     componentTestingTargetName?: string;
+    ciComponentTestingTargetName?: string;
 }
 export declare const createNodesV2: CreateNodesV2<CypressPluginOptions>;
 /**

package/src/plugins/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../../../packages/cypress/src/plugins/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EAGX,aAAa,EAWd,MAAM,YAAY,CAAC;AAepB,MAAM,WAAW,oBAAoB;IACnC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAoBD,eAAO,MAAM,aAAa,EAAE,aAAa,CAAC,oBAAoB,CAqB7D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,WAAW,CAAC,oBAAoB,CAQzD,CAAC"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../../../packages/cypress/src/plugins/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,WAAW,EAGhB,KAAK,aAAa,EAWnB,MAAM,YAAY,CAAC;AAYpB,MAAM,WAAW,oBAAoB;IACnC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,4BAA4B,CAAC,EAAE,MAAM,CAAC;CACvC;AA8BD,eAAO,MAAM,aAAa,EAAE,aAAa,CAAC,oBAAoB,CAqB7D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,WAAW,CAAC,oBAAoB,CAQzD,CAAC"}

package/src/plugins/plugin.js

@@ -2,16 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createNodes = exports.createNodesV2 = void 0;
 const devkit_1 = require("@nx/devkit");
-const path_1 = require("path");
-const js_1 = require("@nx/js");
-const get_named_inputs_1 = require("@nx/devkit/src/utils/get-named-inputs");
-const fs_1 = require("fs");
 const calculate_hash_for_create_nodes_1 = require("@nx/devkit/src/utils/calculate-hash-for-create-nodes");
-const cache_directory_1 = require("nx/src/utils/cache-directory");
-const constants_1 = require("../utils/constants");
 const config_utils_1 = require("@nx/devkit/src/utils/config-utils");
+const get_named_inputs_1 = require("@nx/devkit/src/utils/get-named-inputs");
+const js_1 = require("@nx/js");
+const fs_1 = require("fs");
 const devkit_internals_1 = require("nx/src/devkit-internals");
+const cache_directory_1 = require("nx/src/utils/cache-directory");
 const workspace_context_1 = require("nx/src/utils/workspace-context");
+const path_1 = require("path");
+const constants_1 = require("../utils/constants");
 function readTargetsCache(cachePath) {
     try {
         return process.env.NX_CACHE_PROJECT_GRAPH !== 'false'
@@ -26,6 +26,16 @@ function writeTargetsToCache(cachePath, results) {
     (0, devkit_1.writeJsonFile)(cachePath, results);
 }
 const cypressConfigGlob = '**/cypress.config.{js,ts,mjs,cjs}';
+const defaultPatterns = {
+    e2e: {
+        specPattern: 'cypress/e2e/**/*.cy.{js,jsx,ts,tsx}',
+        excludeSpecPattern: '*.hot-update.js',
+    },
+    component: {
+        specPattern: '**/*.cy.{js,jsx,ts,tsx}',
+        excludeSpecPattern: ['/snapshots/*', '/image_snapshots/*'],
+    },
+};
 const pmc = (0, devkit_1.getPackageManagerCommand)();
 exports.createNodesV2 = [
     cypressConfigGlob,
@@ -214,16 +224,7 @@ async function buildCypressTargets(configFilePath, projectRoot, options, context
         }
         const ciWebServerCommand = pluginPresetOptions?.ciWebServerCommand;
         if (ciWebServerCommand) {
-            const specPatterns = Array.isArray(cypressConfig.e2e.specPattern)
-                ? cypressConfig.e2e.specPattern.map((p) => (0, path_1.join)(projectRoot, p))
-                : [(0, path_1.join)(projectRoot, cypressConfig.e2e.specPattern)];
-            const excludeSpecPatterns = !cypressConfig.e2e
-                .excludeSpecPattern
-                ? cypressConfig.e2e.excludeSpecPattern
-                : Array.isArray(cypressConfig.e2e.excludeSpecPattern)
-                    ? cypressConfig.e2e.excludeSpecPattern.map((p) => (0, path_1.join)(projectRoot, p))
-                    : [(0, path_1.join)(projectRoot, cypressConfig.e2e.excludeSpecPattern)];
-            const specFiles = await (0, workspace_context_1.globWithWorkspaceContext)(context.workspaceRoot, specPatterns, excludeSpecPatterns);
+            const { specFiles, specPatterns, excludeSpecPatterns } = await getSpecFilesAndPatternsForTestType(cypressConfig, 'e2e', context.workspaceRoot, projectRoot);
             const ciBaseUrl = pluginPresetOptions?.ciBaseUrl;
             const dependsOn = [];
             const outputs = getOutputs(projectRoot, cypressConfig, 'e2e');
@@ -276,6 +277,7 @@ async function buildCypressTargets(configFilePath, projectRoot, options, context
                     target: targetName,
                     projects: 'self',
                     params: 'forward',
+                    options: 'forward',
                 });
                 if (ciWebServerCommandTask) {
                     targets[targetName].dependsOn = [
@@ -314,6 +316,8 @@ async function buildCypressTargets(configFilePath, projectRoot, options, context
         }
     }
     if ('component' in cypressConfig) {
+        const inputs = getInputs(namedInputs);
+        const outputs = getOutputs(projectRoot, cypressConfig, 'component');
         // This will not override the e2e target if it is the same
         targets[options.componentTestingTargetName] ??= {
             command: `cypress run --component`,
@@ -322,8 +326,8 @@ async function buildCypressTargets(configFilePath, projectRoot, options, context
                 env: { TS_NODE_COMPILER_OPTIONS: tsNodeCompilerOptions },
             },
             cache: true,
-            inputs: getInputs(namedInputs),
-            outputs: getOutputs(projectRoot, cypressConfig, 'component'),
+            inputs,
+            outputs,
             metadata: {
                 technologies: ['cypress'],
                 description: 'Runs Cypress Component Tests',
@@ -335,6 +339,83 @@ async function buildCypressTargets(configFilePath, projectRoot, options, context
                 },
             },
         };
+        if (options.ciComponentTestingTargetName) {
+            const { specFiles, specPatterns, excludeSpecPatterns } = await getSpecFilesAndPatternsForTestType(cypressConfig, 'component', context.workspaceRoot, projectRoot);
+            const dependsOn = [];
+            const groupName = 'Component Testing (CI)';
+            metadata ??= {};
+            metadata.targetGroups ??= {};
+            metadata.targetGroups[groupName] ??= [];
+            const ctCiTargetGroup = metadata.targetGroups[groupName];
+            for (const file of specFiles) {
+                const relativeSpecFilePath = (0, devkit_1.normalizePath)((0, path_1.relative)(projectRoot, file));
+                if (relativeSpecFilePath.includes('../')) {
+                    throw new Error('@nx/cypress/plugin attempted to run tests outside of the project root. This is not supported and should not happen. Please open an issue at https://github.com/nrwl/nx/issues/new/choose with the following information:\n\n' +
+                        `\n\n${JSON.stringify({
+                            projectRoot,
+                            relativeSpecFilePath,
+                            specFiles,
+                            context,
+                            excludeSpecPatterns,
+                            specPatterns,
+                        }, null, 2)}`);
+                }
+                const targetName = options.ciComponentTestingTargetName + '--' + relativeSpecFilePath;
+                const outputSubfolder = relativeSpecFilePath
+                    .replace(/[\/\\]/g, '-')
+                    .replace(/\./g, '-');
+                ctCiTargetGroup.push(targetName);
+                targets[targetName] = {
+                    outputs: getTargetOutputs(outputs, outputSubfolder),
+                    inputs,
+                    cache: true,
+                    command: `cypress run --component --spec ${relativeSpecFilePath} --config=${getTargetConfig(cypressConfig, outputSubfolder)}`,
+                    options: {
+                        cwd: projectRoot,
+                        env: { TS_NODE_COMPILER_OPTIONS: tsNodeCompilerOptions },
+                    },
+                    // Cypress handles starting the server, there's no separate server
+                    // target we can use as continuous, so we need to disable parallelism
+                    // to avoid port conflicts
+                    parallelism: false,
+                    metadata: {
+                        technologies: ['cypress'],
+                        description: `Runs Cypress Component Tests for ${relativeSpecFilePath} in CI`,
+                        help: {
+                            command: `${pmc.exec} cypress run --help`,
+                            example: {
+                                args: ['--dev', '--headed'],
+                            },
+                        },
+                    },
+                };
+                dependsOn.push({
+                    target: targetName,
+                    projects: 'self',
+                    params: 'forward',
+                    options: 'forward',
+                });
+            }
+            targets[options.ciComponentTestingTargetName] = {
+                executor: 'nx:noop',
+                cache: true,
+                inputs,
+                outputs,
+                dependsOn,
+                metadata: {
+                    technologies: ['cypress'],
+                    description: 'Runs Cypress Component Tests in CI',
+                    nonAtomizedTarget: options.componentTestingTargetName,
+                    help: {
+                        command: `${pmc.exec} cypress run --help`,
+                        example: {
+                            args: ['--dev', '--headed'],
+                        },
+                    },
+                },
+            };
+            ctCiTargetGroup.push(options.ciComponentTestingTargetName);
+        }
     }
     targets[options.openTargetName] = {
         command: `cypress open`,
@@ -361,6 +442,8 @@ function normalizeOptions(options) {
     options.openTargetName ??= 'open-cypress';
     options.componentTestingTargetName ??= 'component-test';
     options.ciTargetName ??= 'e2e-ci';
+    // must be explicitly provided to opt-in to atomized component testing
+    options.ciComponentTestingTargetName;
     return options;
 }
 function getInputs(namedInputs) {
@@ -388,3 +471,17 @@ function parseTaskFromCommand(command) {
     }
     return null;
 }
+async function getSpecFilesAndPatternsForTestType(cypressConfig, testType, workspaceRoot, projectRoot) {
+    const specPattern = cypressConfig[testType].specPattern ??
+        defaultPatterns[testType].specPattern;
+    const specPatterns = Array.isArray(specPattern)
+        ? specPattern.map((p) => (0, path_1.join)(projectRoot, p))
+        : [(0, path_1.join)(projectRoot, specPattern)];
+    const excludeSpecPattern = cypressConfig[testType].excludeSpecPattern ??
+        defaultPatterns[testType].excludeSpecPattern;
+    const excludeSpecPatterns = Array.isArray(excludeSpecPattern)
+        ? excludeSpecPattern.map((p) => (0, path_1.join)(projectRoot, p))
+        : [(0, path_1.join)(projectRoot, excludeSpecPattern)];
+    const specFiles = await (0, workspace_context_1.globWithWorkspaceContext)(workspaceRoot, specPatterns, excludeSpecPatterns);
+    return { specFiles, specPatterns, excludeSpecPatterns };
+}

package/src/utils/versions.d.ts

@@ -7,7 +7,7 @@ export declare const cypressVersion = "^14.2.1";
 export declare const cypressWebpackVersion = "^4.0.2";
 export declare const viteVersion = "^6.0.0";
 export declare const htmlWebpackPluginVersion = "^5.5.0";
-export declare function versions(tree: Tree, cypressMajorVersion?: number): Omit<typeof import("./versions"), "versions" | "getInstalledCypressMajorVersion" | "assertMinimumCypressVersion"> | {
+export declare function versions(tree: Tree): Omit<typeof import("./versions"), "versions" | "getInstalledCypressVersion" | "getInstalledCypressMajorVersion" | "assertMinimumCypressVersion"> | {
     nxVersion: any;
     eslintPluginCypressVersion: string;
     typesNodeVersion: string;
@@ -17,6 +17,7 @@ export declare function versions(tree: Tree, cypressMajorVersion?: number): Omit
     viteVersion: string;
     htmlWebpackPluginVersion: string;
 };
+export declare function getInstalledCypressVersion(tree?: Tree): string | null;
 export declare function getInstalledCypressMajorVersion(tree?: Tree): number | null;
 export declare function assertMinimumCypressVersion(minVersion: number, tree?: Tree): void;
 //# sourceMappingURL=versions.d.ts.map

package/src/utils/versions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"versions.d.ts","sourceRoot":"","sources":["../../../../../packages/cypress/src/utils/versions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,IAAI,EAAE,MAAM,YAAY,CAAC;AAIjD,eAAO,MAAM,SAAS,KAAwC,CAAC;AAC/D,eAAO,MAAM,0BAA0B,WAAW,CAAC;AACnD,eAAO,MAAM,gBAAgB,YAAY,CAAC;AAC1C,eAAO,MAAM,2BAA2B,WAAW,CAAC;AACpD,eAAO,MAAM,cAAc,YAAY,CAAC;AACxC,eAAO,MAAM,qBAAqB,WAAW,CAAC;AAC9C,eAAO,MAAM,WAAW,WAAW,CAAC;AACpC,eAAO,MAAM,wBAAwB,WAAW,CAAC;AAgBjD,wBAAgB,QAAQ,CACtB,IAAI,EAAE,IAAI,EACV,mBAAmB,SAAwC;;;;;;;;;EAwB5D;AAED,wBAAgB,+BAA+B,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAc1E;AAED,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,IAAI,GACV,IAAI,CAON"}
+{"version":3,"file":"versions.d.ts","sourceRoot":"","sources":["../../../../../packages/cypress/src/utils/versions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,IAAI,EAAE,MAAM,YAAY,CAAC;AAIjD,eAAO,MAAM,SAAS,KAAwC,CAAC;AAC/D,eAAO,MAAM,0BAA0B,WAAW,CAAC;AACnD,eAAO,MAAM,gBAAgB,YAAY,CAAC;AAC1C,eAAO,MAAM,2BAA2B,WAAW,CAAC;AACpD,eAAO,MAAM,cAAc,YAAY,CAAC;AACxC,eAAO,MAAM,qBAAqB,WAAW,CAAC;AAC9C,eAAO,MAAM,WAAW,WAAW,CAAC;AACpC,eAAO,MAAM,wBAAwB,WAAW,CAAC;AAmBjD,wBAAgB,QAAQ,CAAC,IAAI,EAAE,IAAI;;;;;;;;;EA2BlC;AAED,wBAAgB,0BAA0B,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAcrE;AAED,wBAAgB,+BAA+B,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAI1E;AAED,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,IAAI,GACV,IAAI,CAON"}

package/src/utils/versions.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.htmlWebpackPluginVersion = exports.viteVersion = exports.cypressWebpackVersion = exports.cypressVersion = exports.cypressViteDevServerVersion = exports.typesNodeVersion = exports.eslintPluginCypressVersion = exports.nxVersion = void 0;
 exports.versions = versions;
+exports.getInstalledCypressVersion = getInstalledCypressVersion;
 exports.getInstalledCypressMajorVersion = getInstalledCypressMajorVersion;
 exports.assertMinimumCypressVersion = assertMinimumCypressVersion;
 const devkit_1 = require("@nx/devkit");
@@ -24,16 +25,18 @@ const latestVersions = {
     viteVersion: exports.viteVersion,
     htmlWebpackPluginVersion: exports.htmlWebpackPluginVersion,
 };
-function versions(tree, cypressMajorVersion = getInstalledCypressMajorVersion(tree)) {
-    if (!cypressMajorVersion) {
+function versions(tree) {
+    const installedCypressVersion = getInstalledCypressVersion(tree);
+    if (!installedCypressVersion) {
         return latestVersions;
     }
-    if (cypressMajorVersion > 14) {
-        throw new Error(`Unsupported Cypress version: ${exports.cypressVersion}`);
-    }
+    const cypressMajorVersion = (0, semver_1.major)(installedCypressVersion);
     if (cypressMajorVersion === 14) {
         return latestVersions;
     }
+    if (cypressMajorVersion > 14) {
+        throw new Error(`You're currently using an unsupported Cypress version: ${installedCypressVersion}. Supported versions are v13 and v14.`);
+    }
     return {
         nxVersion: exports.nxVersion,
         eslintPluginCypressVersion: '^3.5.0',
@@ -45,7 +48,7 @@ function versions(tree, cypressMajorVersion = getInstalledCypressMajorVersion(tr
         htmlWebpackPluginVersion: '^5.5.0',
     };
 }
-function getInstalledCypressMajorVersion(tree) {
+function getInstalledCypressVersion(tree) {
     try {
         let version;
         if (tree) {
@@ -54,12 +57,16 @@ function getInstalledCypressMajorVersion(tree) {
         else {
             version = getCypressVersionFromFileSystem();
         }
-        return version ? (0, semver_1.major)(version) : null;
+        return version;
     }
     catch {
         return null;
     }
 }
+function getInstalledCypressMajorVersion(tree) {
+    const installedCypressVersion = getInstalledCypressVersion(tree);
+    return installedCypressVersion ? (0, semver_1.major)(installedCypressVersion) : null;
+}
 function assertMinimumCypressVersion(minVersion, tree) {
     const version = getInstalledCypressMajorVersion(tree);
     if (version && version < minVersion) {