@nx/cypress 19.0.0-beta.7 → 19.0.0-beta.9

package/generators.json

@@ -32,6 +32,11 @@
       "factory": "./src/generators/migrate-to-cypress-11/migrate-to-cypress-11#migrateCypressProject",
       "schema": "./src/generators/migrate-to-cypress-11/schema.json",
       "description": "Migrate existing Cypress e2e projects to Cypress v11"
+    },
+    "convert-to-inferred": {
+      "factory": "./src/generators/convert-to-inferred/convert-to-inferred",
+      "schema": "./src/generators/convert-to-inferred/schema.json",
+      "description": "Convert existing Cypress project(s) using `@nx/cypress:cypress` executor to use `@nx/cypress/plugin`."
     }
   }
 }

package/migrations.json

@@ -1,29 +1,5 @@
 {
   "generators": {
-    "add-cypress-inputs": {
-      "cli": "nx",
-      "version": "15.0.0-beta.0",
-      "description": "Stop hashing cypress spec files and config files for build targets and dependent tasks",
-      "factory": "./src/migrations/update-15-0-0/add-cypress-inputs"
-    },
-    "update-cy-mount-usage": {
-      "cli": "nx",
-      "version": "15.0.0-beta.4",
-      "description": "Update to using cy.mount in the commands.ts file instead of importing mount for each component test file",
-      "factory": "./src/migrations/update-15-0-0/update-cy-mount-usage"
-    },
-    "update-to-cypress-11": {
-      "cli": "nx",
-      "version": "15.1.0-beta.0",
-      "description": "Update to Cypress v11. This migration will only update if the workspace is already on v10. https://www.cypress.io/blog/2022/11/04/upcoming-changes-to-component-testing/",
-      "factory": "./src/migrations/update-15-1-0/cypress-11"
-    },
-    "update-to-cypress-12": {
-      "cli": "nx",
-      "version": "15.5.0-beta.0",
-      "description": "Update to Cypress v12. Cypress 12 contains a handful of breaking changes that might causes tests to start failing that nx cannot directly fix. Read more Cypress 12 changes: https://docs.cypress.io/guides/references/migration-guide#Migrating-to-Cypress-12-0.This migration will only run if you are already using Cypress v11.",
-      "factory": "./src/migrations/update-15-5-0/update-to-cypress-12"
-    },
     "update-16-0-0-add-nx-packages": {
       "cli": "nx",
       "version": "16.0.0-beta.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/cypress",
-  "version": "19.0.0-beta.7",
+  "version": "19.0.0-beta.9",
   "private": false,
   "description": "The Nx Plugin for Cypress contains executors and generators allowing your workspace to use the powerful Cypress integration testing capabilities.",
   "repository": {
@@ -34,14 +34,14 @@
     "migrations": "./migrations.json"
   },
   "dependencies": {
-    "@nx/devkit": "19.0.0-beta.7",
-    "@nx/eslint": "19.0.0-beta.7",
-    "@nx/js": "19.0.0-beta.7",
+    "@nx/devkit": "19.0.0-beta.9",
+    "@nx/eslint": "19.0.0-beta.9",
+    "@nx/js": "19.0.0-beta.9",
     "@phenomnomnominal/tsquery": "~5.0.1",
     "detect-port": "^1.5.1",
     "semver": "^7.5.3",
     "tslib": "^2.3.0",
-    "@nrwl/cypress": "19.0.0-beta.7"
+    "@nrwl/cypress": "19.0.0-beta.9"
   },
   "peerDependencies": {
     "cypress": ">= 3 < 14"

package/src/generators/convert-to-inferred/convert-to-inferred.d.ts

@@ -0,0 +1,8 @@
+import { type Tree } from '@nx/devkit';
+interface Schema {
+    project?: string;
+    all?: boolean;
+    skipFormat?: boolean;
+}
+export declare function convertToInferred(tree: Tree, options: Schema): Promise<void>;
+export default convertToInferred;

package/src/generators/convert-to-inferred/convert-to-inferred.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertToInferred = void 0;
+const devkit_1 = require("@nx/devkit");
+const executor_to_plugin_migrator_1 = require("@nx/devkit/src/generators/plugin-migrations/executor-to-plugin-migrator");
+const plugin_1 = require("../../plugins/plugin");
+const target_options_map_1 = require("./lib/target-options-map");
+const upsert_baseUrl_1 = require("./lib/upsert-baseUrl");
+const add_dev_server_target_to_config_1 = require("./lib/add-dev-server-target-to-config");
+const add_exclude_spec_pattern_1 = require("./lib/add-exclude-spec-pattern");
+async function convertToInferred(tree, options) {
+    const projectGraph = await (0, devkit_1.createProjectGraphAsync)();
+    await (0, executor_to_plugin_migrator_1.migrateExecutorToPlugin)(tree, projectGraph, '@nx/cypress:cypress', '@nx/cypress/plugin', (targetName) => ({
+        targetName,
+        ciTargetName: 'e2e-ci',
+    }), postTargetTransformer, plugin_1.createNodes, options.project);
+    if (!options.skipFormat) {
+        await (0, devkit_1.formatFiles)(tree);
+    }
+}
+exports.convertToInferred = convertToInferred;
+function postTargetTransformer(target, tree) {
+    if (target.options) {
+        const configFilePath = target.options.cypressConfig;
+        delete target.options.cypressConfig;
+        delete target.options.copyFiles;
+        delete target.options.skipServe;
+        for (const key in target_options_map_1.targetOptionsToCliMap) {
+            if (target.options[key]) {
+                target.options[target_options_map_1.targetOptionsToCliMap[key]] = target.options[key];
+                delete target.options[key];
+            }
+        }
+        if ('exit' in target.options && !target.options.exit) {
+            delete target.options.exit;
+            target.options['no-exit'] = true;
+        }
+        if (target.options.testingType) {
+            delete target.options.testingType;
+        }
+        if (target.options.watch) {
+            target.options.headed = true;
+            target.options['no-exit'] = true;
+            delete target.options.watch;
+        }
+        if (target.options.baseUrl) {
+            (0, upsert_baseUrl_1.upsertBaseUrl)(tree, configFilePath, target.options.baseUrl);
+            delete target.options.baseUrl;
+        }
+        if (target.options.devServerTarget) {
+            const webServerCommands = {
+                default: `npx nx run ${target.options.devServerTarget}`,
+            };
+            delete target.options.devServerTarget;
+            if (target.configurations) {
+                for (const configuration in target.configurations) {
+                    if (target.configurations[configuration]?.devServerTarget) {
+                        webServerCommands[configuration] = `npx nx run ${target.configurations[configuration].devServerTarget}`;
+                        delete target.configurations[configuration].devServerTarget;
+                    }
+                }
+            }
+            (0, add_dev_server_target_to_config_1.addDevServerTargetToConfig)(tree, configFilePath, webServerCommands, target.configurations?.ci?.devServerTarget);
+        }
+        if (target.options.ignoreTestFiles) {
+            (0, add_exclude_spec_pattern_1.addExcludeSpecPattern)(tree, configFilePath, target.options.ignoreTestFiles);
+            delete target.options.ignoreTestFiles;
+        }
+        if (Object.keys(target.options).length === 0) {
+            delete target.options;
+        }
+        if (target.configurations &&
+            Object.keys(target.configurations).length !== 0) {
+            for (const configuration in target.configurations) {
+                if (Object.keys(target.configurations[configuration]).length === 0) {
+                    delete target.configurations[configuration];
+                }
+            }
+            if (Object.keys(target.configurations).length === 0) {
+                delete target.configurations;
+            }
+        }
+    }
+    return target;
+}
+exports.default = convertToInferred;

package/src/generators/convert-to-inferred/lib/add-dev-server-target-to-config.d.ts

@@ -0,0 +1,12 @@
+import type { Tree } from '@nx/devkit';
+/**
+ * Add or update the webServerCommands and ciWebServerCommand options in the Cypress Config
+ * Scenarios Covered:
+ *  1. Only devServerTarget Exists
+ *  2. devServerTarget and configuration.ci.devServerTarget Exists
+ *
+ *  For each, the following scenarios are covered:
+ *  a. The command is not listed in the config, so it is added
+ *  b. Replace the existing webServerCommands with the value passed in
+ */
+export declare function addDevServerTargetToConfig(tree: Tree, configFilePath: string, webServerCommands: Record<string, string>, ciDevServerTarget?: string): void;

package/src/generators/convert-to-inferred/lib/add-dev-server-target-to-config.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addDevServerTargetToConfig = void 0;
+const tsquery_1 = require("@phenomnomnominal/tsquery");
+/**
+ * Add or update the webServerCommands and ciWebServerCommand options in the Cypress Config
+ * Scenarios Covered:
+ *  1. Only devServerTarget Exists
+ *  2. devServerTarget and configuration.ci.devServerTarget Exists
+ *
+ *  For each, the following scenarios are covered:
+ *  a. The command is not listed in the config, so it is added
+ *  b. Replace the existing webServerCommands with the value passed in
+ */
+function addDevServerTargetToConfig(tree, configFilePath, webServerCommands, ciDevServerTarget) {
+    let configFileContents = tree.read(configFilePath, 'utf-8');
+    let ast = tsquery_1.tsquery.ast(configFileContents);
+    const NX_E2E_PRESET_OPTIONS_SELECTOR = 'PropertyAssignment:has(Identifier[name=e2e]) CallExpression:has(Identifier[name=nxE2EPreset]) > ObjectLiteralExpression';
+    const nxE2ePresetOptionsNodes = (0, tsquery_1.tsquery)(ast, NX_E2E_PRESET_OPTIONS_SELECTOR, {
+        visitAllChildren: true,
+    });
+    if (nxE2ePresetOptionsNodes.length !== 0) {
+        let nxE2ePresetOptionsNode = nxE2ePresetOptionsNodes[0];
+        const WEB_SERVER_COMMANDS_SELECTOR = 'PropertyAssignment:has(Identifier[name=webServerCommands])';
+        const webServerCommandsNodes = (0, tsquery_1.tsquery)(nxE2ePresetOptionsNode, WEB_SERVER_COMMANDS_SELECTOR, { visitAllChildren: true });
+        if (webServerCommandsNodes.length !== 0) {
+            // Already exists, replace it
+            tree.write(configFilePath, `${configFileContents.slice(0, webServerCommandsNodes[0].getStart())}webServerCommands: ${JSON.stringify(webServerCommands)}${configFileContents.slice(webServerCommandsNodes[0].getEnd())}`);
+        }
+        else {
+            tree.write(configFilePath, `${configFileContents.slice(0, nxE2ePresetOptionsNode.getStart() + 1)}webServerCommands: ${JSON.stringify(webServerCommands)},${configFileContents.slice(nxE2ePresetOptionsNode.getStart() + 1)}`);
+        }
+        if (ciDevServerTarget) {
+            configFileContents = tree.read(configFilePath, 'utf-8');
+            ast = tsquery_1.tsquery.ast(configFileContents);
+            nxE2ePresetOptionsNode = (0, tsquery_1.tsquery)(ast, NX_E2E_PRESET_OPTIONS_SELECTOR, {
+                visitAllChildren: true,
+            })[0];
+            const CI_WEB_SERVER_COMMANDS_SELECTOR = 'PropertyAssignment:has(Identifier[name=ciWebServerCommand])';
+            const ciWebServerCommandsNodes = (0, tsquery_1.tsquery)(nxE2ePresetOptionsNode, CI_WEB_SERVER_COMMANDS_SELECTOR, { visitAllChildren: true });
+            if (ciWebServerCommandsNodes.length !== 0) {
+                const ciWebServerCommandNode = ciWebServerCommandsNodes[0].getChildAt(2);
+                const ciWebServerCommand = ciWebServerCommandNode
+                    .getText()
+                    .replace(/["']/g, '');
+                if (!ciWebServerCommand.includes(ciDevServerTarget)) {
+                    tree.write(configFilePath, `${configFileContents.slice(0, ciWebServerCommandNode.getStart())}"npx nx run ${ciDevServerTarget}"${configFileContents.slice(ciWebServerCommandNode.getEnd())}`);
+                }
+            }
+            else {
+                tree.write(configFilePath, `${configFileContents.slice(0, nxE2ePresetOptionsNode.getStart() + 1)}ciWebServerCommand: "npx nx run ${ciDevServerTarget}",${configFileContents.slice(nxE2ePresetOptionsNode.getStart() + 1)}`);
+            }
+        }
+    }
+}
+exports.addDevServerTargetToConfig = addDevServerTargetToConfig;

package/src/generators/convert-to-inferred/lib/add-exclude-spec-pattern.d.ts

@@ -0,0 +1,2 @@
+import type { Tree } from '@nx/devkit';
+export declare function addExcludeSpecPattern(tree: Tree, configFilePath: string, excludeSpecPattern: string | string[]): void;

package/src/generators/convert-to-inferred/lib/add-exclude-spec-pattern.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addExcludeSpecPattern = void 0;
+const tsquery_1 = require("@phenomnomnominal/tsquery");
+function addExcludeSpecPattern(tree, configFilePath, excludeSpecPattern) {
+    let configFileContents = tree.read(configFilePath, 'utf-8');
+    let ast = tsquery_1.tsquery.ast(configFileContents);
+    const E2E_CONFIG_SELECTOR = 'PropertyAssignment:has(Identifier[name=e2e]) > ObjectLiteralExpression';
+    const e2eConfigNodes = (0, tsquery_1.tsquery)(ast, E2E_CONFIG_SELECTOR, {
+        visitAllChildren: true,
+    });
+    if (e2eConfigNodes.length !== 0) {
+        const e2eConfigNode = e2eConfigNodes[0];
+        const EXCLUDE_SPEC_PATTERN_SELECTOR = 'PropertyAssignment:has(Identifier[name="excludeSpecPattern"])';
+        const excludeSpecPatternNodes = (0, tsquery_1.tsquery)(e2eConfigNode, EXCLUDE_SPEC_PATTERN_SELECTOR, { visitAllChildren: true });
+        if (excludeSpecPatternNodes.length !== 0) {
+            const excludeSpecPatternNode = excludeSpecPatternNodes[0];
+            let updatedExcludePattern = Array.isArray(excludeSpecPattern)
+                ? excludeSpecPattern
+                : [excludeSpecPattern];
+            tree.write(configFilePath, `${configFileContents.slice(0, excludeSpecPatternNode.getStart())}excludeSpecPattern: ${JSON.stringify(updatedExcludePattern)}${configFileContents.slice(excludeSpecPatternNode.getEnd())}`);
+        }
+        else {
+            tree.write(configFilePath, `${configFileContents.slice(0, e2eConfigNode.getStart() + 1)}excludeSpecPattern: ${JSON.stringify(excludeSpecPattern)},${configFileContents.slice(e2eConfigNode.getStart() + 1)}`);
+        }
+    }
+}
+exports.addExcludeSpecPattern = addExcludeSpecPattern;

package/src/generators/convert-to-inferred/lib/target-options-map.d.ts

@@ -0,0 +1,18 @@
+export declare const targetOptionsToCliMap: {
+    headed: string;
+    headless: string;
+    key: string;
+    record: string;
+    parallel: string;
+    browser: string;
+    env: string;
+    spec: string;
+    ciBuildId: string;
+    group: string;
+    reporter: string;
+    reporterOptions: string;
+    tag: string;
+    port: string;
+    quiet: string;
+    runnerUi: string;
+};

package/src/generators/convert-to-inferred/lib/target-options-map.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.targetOptionsToCliMap = void 0;
+exports.targetOptionsToCliMap = {
+    headed: 'headed',
+    headless: 'headless',
+    key: 'key',
+    record: 'record',
+    parallel: 'parallel',
+    browser: 'browser',
+    env: 'env',
+    spec: 'spec',
+    ciBuildId: 'ci-build-id',
+    group: 'group',
+    reporter: 'reporter',
+    reporterOptions: 'reporter-options',
+    tag: 'tag',
+    port: 'port',
+    quiet: 'quiet',
+    runnerUi: 'runner-ui',
+};

package/src/generators/convert-to-inferred/lib/upsert-baseUrl.d.ts

@@ -0,0 +1,2 @@
+import type { Tree } from '@nx/devkit';
+export declare function upsertBaseUrl(tree: Tree, configFilePath: string, baseUrlValueInProject: string): void;

package/src/generators/convert-to-inferred/lib/upsert-baseUrl.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.upsertBaseUrl = void 0;
+const tsquery_1 = require("@phenomnomnominal/tsquery");
+function upsertBaseUrl(tree, configFilePath, baseUrlValueInProject) {
+    const configFileContents = tree.read(configFilePath, 'utf-8');
+    const ast = tsquery_1.tsquery.ast(configFileContents);
+    const BASE_URL_SELECTOR = 'PropertyAssignment:has(Identifier[name=e2e]) PropertyAssignment:has(Identifier[name="baseUrl"])';
+    const baseUrlNodes = (0, tsquery_1.tsquery)(ast, BASE_URL_SELECTOR, {
+        visitAllChildren: true,
+    });
+    if (baseUrlNodes.length !== 0) {
+        // The property exists in the config
+        const baseUrlValueNode = baseUrlNodes[0].getChildAt(2);
+        const baseUrlValue = baseUrlValueNode.getText().replace(/(["'])/, '');
+        if (baseUrlValue === baseUrlValueInProject) {
+            return;
+        }
+        tree.write(configFilePath, `${configFileContents.slice(0, baseUrlValueNode.getStart())}"${baseUrlValueInProject}"${configFileContents.slice(baseUrlValueNode.getEnd())}`);
+    }
+    else {
+        const E2E_OBJECT_SELECTOR = 'PropertyAssignment:has(Identifier[name=e2e]) ObjectLiteralExpression';
+        const e2eConfigNodes = (0, tsquery_1.tsquery)(ast, E2E_OBJECT_SELECTOR, {
+            visitAllChildren: true,
+        });
+        if (e2eConfigNodes.length !== 0) {
+            const e2eConfigNode = e2eConfigNodes[0];
+            tree.write(configFilePath, `${configFileContents.slice(0, e2eConfigNode.getEnd() - 1)}baseUrl: "${baseUrlValueInProject}",
+        ${configFileContents.slice(e2eConfigNode.getEnd() - 1)}`);
+        }
+    }
+}
+exports.upsertBaseUrl = upsertBaseUrl;

package/src/generators/convert-to-inferred/schema.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "$id": "NxCypressConvertToInferred",
+  "description": "Convert existing Cypress project(s) using `@nx/cypress:cypress` executor to use `@nx/cypress/plugin`.",
+  "title": "Convert Cypress project from executor to plugin",
+  "type": "object",
+  "properties": {
+    "project": {
+      "type": "string",
+      "description": "The project to convert from using the `@nx/cypress:cypress` executor to use `@nx/cypress/plugin`.",
+      "x-priority": "important"
+    },
+    "skipFormat": {
+      "type": "boolean",
+      "description": "Whether to format files at the end of the migration.",
+      "default": false
+    }
+  }
+}

package/src/migrations/update-15-0-0/add-cypress-inputs.d.ts

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

package/src/migrations/update-15-0-0/add-cypress-inputs.js

@@ -1,42 +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");
-async function default_1(tree) {
-    const nxJson = (0, devkit_1.readNxJson)(tree);
-    const { cypressTargets, hasComponentTesting } = getCypressTargetNames(tree);
-    const hasProductionFileset = !!nxJson.namedInputs?.production;
-    if (hasComponentTesting && hasProductionFileset && cypressTargets.size > 0) {
-        const productionFileset = new Set(nxJson.namedInputs.production);
-        for (const exclusion of [
-            '!{projectRoot}/cypress/**/*',
-            '!{projectRoot}/**/*.cy.[jt]s?(x)',
-            '!{projectRoot}/cypress.config.[jt]s',
-        ]) {
-            productionFileset.add(exclusion);
-        }
-        nxJson.namedInputs.production = Array.from(productionFileset);
-    }
-    for (const targetName of cypressTargets) {
-        nxJson.targetDefaults ??= {};
-        const cypressTargetDefaults = (nxJson.targetDefaults[targetName] ??= {});
-        cypressTargetDefaults.inputs ??= [
-            'default',
-            hasProductionFileset ? '^production' : '^default',
-        ];
-    }
-    (0, devkit_1.updateNxJson)(tree, nxJson);
-    await (0, devkit_1.formatFiles)(tree);
-}
-exports.default = default_1;
-function getCypressTargetNames(tree) {
-    const cypressTargets = new Set();
-    let hasComponentTesting = false;
-    (0, executor_options_utils_1.forEachExecutorOptions)(tree, '@nrwl/cypress:cypress', (options, __, target) => {
-        cypressTargets.add(target);
-        if (options.testingType === 'component') {
-            hasComponentTesting = true;
-        }
-    });
-    return { cypressTargets, hasComponentTesting };
-}

package/src/migrations/update-15-0-0/update-cy-mount-usage.d.ts

@@ -1,5 +0,0 @@
-import { Tree } from '@nx/devkit';
-export declare function updateCyMountUsage(tree: Tree): Promise<void>;
-export declare function addMountCommand(tree: Tree, projectRoot: string, framework: string): void;
-export declare function updateCyFile(tree: Tree, filePath: string, framework: 'angular' | 'react' | 'react18'): void;
-export default updateCyMountUsage;

package/src/migrations/update-15-0-0/update-cy-mount-usage.js

@@ -1,119 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateCyFile = exports.addMountCommand = exports.updateCyMountUsage = void 0;
-const ct_helpers_1 = require("../../utils/ct-helpers");
-const cypress_version_1 = require("../../utils/cypress-version");
-const devkit_1 = require("@nx/devkit");
-const executor_options_utils_1 = require("@nx/devkit/src/generators/executor-options-utils");
-const semver_1 = require("@nx/devkit/src/utils/semver");
-const tsquery_1 = require("@phenomnomnominal/tsquery");
-const semver_2 = require("semver");
-async function updateCyMountUsage(tree) {
-    if ((0, cypress_version_1.installedCypressVersion)() < 10) {
-        return;
-    }
-    const projects = (0, devkit_1.getProjects)(tree);
-    const graph = await (0, devkit_1.createProjectGraphAsync)();
-    (0, executor_options_utils_1.forEachExecutorOptions)(tree, '@nrwl/cypress:cypress', (options, projectName) => {
-        if (options.testingType !== 'component' || !options.devServerTarget) {
-            return;
-        }
-        const parsed = (0, devkit_1.parseTargetString)(options.devServerTarget, graph);
-        if (!parsed?.project || !parsed?.target) {
-            return;
-        }
-        const buildProjectConfig = projects.get(parsed.project);
-        const framework = getFramework(tree, parsed.configuration
-            ? buildProjectConfig.targets[parsed.target].configurations[parsed.configuration]
-            : buildProjectConfig.targets[parsed.target]);
-        const ctProjectConfig = projects.get(projectName);
-        addMountCommand(tree, ctProjectConfig.root, framework);
-        (0, devkit_1.visitNotIgnoredFiles)(tree, ctProjectConfig.sourceRoot, (filePath) => {
-            if (ct_helpers_1.CY_FILE_MATCHER.test(filePath)) {
-                updateCyFile(tree, filePath, framework);
-            }
-        });
-    });
-    await (0, devkit_1.formatFiles)(tree);
-}
-exports.updateCyMountUsage = updateCyMountUsage;
-function addMountCommand(tree, projectRoot, framework) {
-    const commandFilePath = (0, devkit_1.joinPathFragments)(projectRoot, 'cypress', 'support', 'commands.ts');
-    if (!tree.exists(commandFilePath)) {
-        return;
-    }
-    const commandFile = tree.read(commandFilePath, 'utf-8');
-    const mountCommand = tsquery_1.tsquery.query(commandFile, 'CallExpression:has(StringLiteral[value="mount"]) PropertyAccessExpression:has(Identifier[name="add"])');
-    if (mountCommand?.length > 0) {
-        return;
-    }
-    const existingCommands = tsquery_1.tsquery.query(commandFile, 'InterfaceDeclaration:has(Identifier[name="Chainable"]) > MethodSignature, InterfaceDeclaration:has(Identifier[name="Chainable"]) > PropertySignature');
-    const isGlobalDeclaration = tsquery_1.tsquery.query(commandFile, 'ModuleDeclaration > Identifier[name="global"]');
-    const updatedInterface = tsquery_1.tsquery.replace(commandFile, 'ModuleDeclaration:has(Identifier[name="Cypress"])', (node) => {
-        const newModuleDelcaration = `declare global {
-  // eslint-disable-next-line @typescript-eslint/no-namespace
-  namespace Cypress {
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    interface Chainable<Subject> {
-      ${existingCommands.map((c) => c.getText()).join('\n')}
-      mount: typeof mount;
-    }
-  }
-}`;
-        /*
-         * this is to prevent the change being applied twice since
-         * declare global { 1
-         *   interface Cypress { 2
-         *   }
-         * }
-         * matches twice.
-         * i.e. if there is no global declaration, then add it
-         * or if the node is the global declaration, then add it,
-         * but not to the cypress module declaration inside the global declaration
-         */
-        if (isGlobalDeclaration?.length === 0 ||
-            node.name.getText() === 'global') {
-            return newModuleDelcaration;
-        }
-    });
-    const updatedCommandFile = `import { mount } from 'cypress/${framework}'\n${updatedInterface}\nCypress.Commands.add('mount', mount);`;
-    tree.write(commandFilePath, updatedCommandFile);
-}
-exports.addMountCommand = addMountCommand;
-function getFramework(tree, target) {
-    if (target.executor === '@nrwl/angular:webpack-browser' ||
-        target.executor === '@angular-devkit/build-angular:browser') {
-        return 'angular';
-    }
-    const pkgJson = (0, devkit_1.readJson)(tree, 'package.json');
-    const reactDomVersion = pkgJson?.dependencies?.['react-dom'];
-    const hasReact18 = reactDomVersion &&
-        (0, semver_2.gte)((0, semver_1.checkAndCleanWithSemver)('react-dom', reactDomVersion), '18.0.0');
-    if (hasReact18) {
-        return 'react18';
-    }
-    return 'react';
-}
-function updateCyFile(tree, filePath, framework) {
-    if (!tree.exists(filePath)) {
-        return;
-    }
-    const contents = tree.read(filePath, 'utf-8');
-    const withCyMount = tsquery_1.tsquery.replace(contents, ':matches(CallExpression>Identifier[name="mount"])', (node) => {
-        return `cy.mount`;
-    });
-    const withUpdatedImports = tsquery_1.tsquery.replace(withCyMount, ':matches(ImportDeclaration, VariableStatement):has(Identifier[name="mount"]):has(StringLiteral[value="cypress/react"], StringLiteral[value="cypress/angular"], StringLiteral[value="cypress/react18"])', (node) => {
-        switch (framework) {
-            case 'angular':
-                return `import { MountConfig } from 'cypress/angular';`;
-            case 'react18':
-            case 'react':
-                return ' '; // have to return non falsy string to remove the node
-            default:
-                return node.getText().replace('mount', '');
-        }
-    });
-    tree.write(filePath, withUpdatedImports);
-}
-exports.updateCyFile = updateCyFile;
-exports.default = updateCyMountUsage;

package/src/migrations/update-15-1-0/cypress-11.d.ts

@@ -1,6 +0,0 @@
-import { Tree } from '@nx/devkit';
-export declare function updateToCypress11(tree: Tree): Promise<() => void>;
-export declare function updateMountHookUsage(tree: Tree, filePath: string): void;
-export declare function updateUnmountUsage(tree: Tree, filePath: string): void;
-export declare function updateProviderUsage(tree: Tree, filePath: string): void;
-export default updateToCypress11;

package/src/migrations/update-15-1-0/cypress-11.js

@@ -1,114 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateProviderUsage = exports.updateUnmountUsage = exports.updateMountHookUsage = exports.updateToCypress11 = void 0;
-const ct_helpers_1 = require("../../utils/ct-helpers");
-const devkit_1 = require("@nx/devkit");
-const executor_options_utils_1 = require("@nx/devkit/src/generators/executor-options-utils");
-const tsquery_1 = require("@phenomnomnominal/tsquery");
-const path_1 = require("path");
-const ts = require("typescript");
-const cypress_version_1 = require("../../utils/cypress-version");
-const versions_1 = require("../../utils/versions");
-async function updateToCypress11(tree) {
-    const installedVersion = (0, cypress_version_1.installedCypressVersion)();
-    if (installedVersion < 10) {
-        return;
-    }
-    const projects = (0, devkit_1.getProjects)(tree);
-    (0, executor_options_utils_1.forEachExecutorOptions)(tree, '@nrwl/cypress:cypress', (options, projectName, targetName, configurationName) => {
-        if (options.testingType !== 'component' ||
-            !(options.cypressConfig && tree.exists(options.cypressConfig))) {
-            return;
-        }
-        const projectConfig = projects.get(projectName);
-        const commandsFile = (0, devkit_1.joinPathFragments)(projectConfig.root, 'cypress', 'support', 'commands.ts');
-        const framework = getFramework(tree.exists(commandsFile)
-            ? tree.read(commandsFile, 'utf-8')
-            : tree.read(options.cypressConfig, 'utf-8'));
-        (0, devkit_1.visitNotIgnoredFiles)(tree, projectConfig.sourceRoot, (filePath) => {
-            if (!ct_helpers_1.CY_FILE_MATCHER.test(filePath)) {
-                return;
-            }
-            const frameworkFromFile = getFramework(tree.read(filePath, 'utf-8'));
-            if (framework === 'react' || frameworkFromFile === 'react') {
-                updateUnmountUsage(tree, filePath);
-                updateMountHookUsage(tree, filePath);
-            }
-            if (framework === 'angular' || frameworkFromFile === 'angular') {
-                updateProviderUsage(tree, filePath);
-            }
-        });
-    });
-    const installTask = (0, devkit_1.addDependenciesToPackageJson)(tree, {}, { cypress: versions_1.cypressVersion });
-    await (0, devkit_1.formatFiles)(tree);
-    return () => {
-        installTask();
-    };
-}
-exports.updateToCypress11 = updateToCypress11;
-function updateMountHookUsage(tree, filePath) {
-    const originalContents = tree.read(filePath, 'utf-8');
-    const commentedMountHook = tsquery_1.tsquery.replace(originalContents, ':matches(ImportDeclaration, VariableStatement):has(Identifier[name="mountHook"]):has(StringLiteral[value="cypress/react"], StringLiteral[value="cypress/react18"])', (node) => {
-        return `/** TODO: mountHook is deprecate. 
-* Use a wrapper component instead. 
-* See post for details: https://www.cypress.io/blog/2022/11/04/upcoming-changes-to-component-testing/#reactmounthook-removed 
-* */\n${node.getText()}`;
-    });
-    tree.write(filePath, commentedMountHook);
-}
-exports.updateMountHookUsage = updateMountHookUsage;
-function updateUnmountUsage(tree, filePath) {
-    const reactDomImport = (0, path_1.extname)(filePath).includes('ts')
-        ? `import ReactDom from 'react-dom'`
-        : `const ReactDom = require('react-dom')`;
-    const originalContents = tree.read(filePath, 'utf-8');
-    const updatedImports = tsquery_1.tsquery.replace(originalContents, ':matches(ImportDeclaration, VariableStatement):has(Identifier[name="unmount"]):has(StringLiteral[value="cypress/react"], StringLiteral[value="cypress/react18"])', (node) => {
-        return `${node.getText().replace('unmount', 'getContainerEl')}
-${reactDomImport}`;
-    });
-    const updatedUnmountApi = tsquery_1.tsquery.replace(updatedImports, 'ExpressionStatement > CallExpression:has(Identifier[name="unmount"])', (node) => {
-        if (node.expression.getText() === 'unmount') {
-            return `cy.then(() => ReactDom.unmountComponentAtNode(getContainerEl()))`;
-        }
-    });
-    tree.write(filePath, updatedUnmountApi);
-}
-exports.updateUnmountUsage = updateUnmountUsage;
-function updateProviderUsage(tree, filePath) {
-    const originalContents = tree.read(filePath, 'utf-8');
-    const isTestBedImported = tsquery_1.tsquery.query(originalContents, ':matches(ImportDeclaration, VariableStatement):has(Identifier[name="TestBed"]):has(StringLiteral[value="@angular/core/testing"])')?.length > 0;
-    let updatedProviders = tsquery_1.tsquery.replace(originalContents, 'CallExpression:has(PropertyAccessExpression:has(Identifier[name="mount"]))', (node) => {
-        const expressionName = node.expression.getText();
-        if (expressionName === 'cy.mount' && node?.arguments?.length > 1) {
-            const component = node.arguments[0].getText();
-            if (ts.isObjectLiteralExpression(node.arguments[1])) {
-                const providers = node.arguments[1]?.properties
-                    ?.find((p) => p.name?.getText() === 'providers')
-                    ?.getText();
-                const noProviders = tsquery_1.tsquery.replace(node.getText(), 'PropertyAssignment:has(Identifier[name="providers"])', (n) => {
-                    // set it to undefined so we don't run into a hanging comma causing invalid syntax
-                    return 'providers: undefined';
-                });
-                return `TestBed.overrideComponent(${component}, { add: { ${providers} }});\n${noProviders}`;
-            }
-            else {
-                return `TestBed.overrideComponent(${component}, {add: { providers: ${node.arguments[1].getText()}.providers}});\n${node.getText()}`;
-            }
-        }
-    });
-    tree.write(filePath, `${isTestBedImported
-        ? ''
-        : "import {TestBed} from '@angular/core/testing';\n"}${updatedProviders}`);
-}
-exports.updateProviderUsage = updateProviderUsage;
-function getFramework(contents) {
-    if (contents.includes('cypress/react') || contents.includes('@nrwl/react')) {
-        return 'react';
-    }
-    if (contents.includes('cypress/angular') ||
-        contents.includes('@nrwl/angular')) {
-        return 'angular';
-    }
-    return null;
-}
-exports.default = updateToCypress11;

package/src/migrations/update-15-5-0/update-to-cypress-12.d.ts

@@ -1,24 +0,0 @@
-import { GeneratorCallback, Tree } from '@nx/devkit';
-export declare function updateToCypress12(tree: Tree): GeneratorCallback;
-export declare function turnOffTestIsolation(tree: Tree, configPath: string): void;
-/**
- * Leave a comment on all apis that have been removed andsuperseded by cy.intercept
- * stating they these API are now removed and need to update.
- * cy.route, cy.server, Cypress.Server.defaults
- **/
-export declare function shouldUseCyIntercept(tree: Tree, filePath: string): void;
-/**
- * Leave a comment on all apis that have been removed and superseded by cy.session
- * stating they these API are now removed and need to update.
- * Cypress.Cookies.defaults & Cypress.Cookies.preserveOnce
- **/
-export declare function shouldUseCySession(tree: Tree, filePath: string): void;
-/**
- * leave a comment about nested cy commands in a cy.should callback
- * */
-export declare function shouldNotUseCyInShouldCB(tree: Tree, filePath: string): void;
-/**
- * leave a comment on all usages of overriding built-ins that are now banned
- * */
-export declare function shouldNotOverrideCommands(tree: Tree, filePath: string): void;
-export default updateToCypress12;

package/src/migrations/update-15-5-0/update-to-cypress-12.js

@@ -1,180 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.shouldNotOverrideCommands = exports.shouldNotUseCyInShouldCB = exports.shouldUseCySession = exports.shouldUseCyIntercept = exports.turnOffTestIsolation = exports.updateToCypress12 = void 0;
-const devkit_1 = require("@nx/devkit");
-const executor_options_utils_1 = require("@nx/devkit/src/generators/executor-options-utils");
-const tsquery_1 = require("@phenomnomnominal/tsquery");
-const typescript_1 = require("typescript");
-const cypress_version_1 = require("../../utils/cypress-version");
-const helpers_1 = require("./helpers");
-const JS_TS_FILE_MATCHER = /\.[jt]sx?$/;
-function updateToCypress12(tree) {
-    if ((0, cypress_version_1.installedCypressVersion)() < 11) {
-        return;
-    }
-    const projects = (0, devkit_1.getProjects)(tree);
-    (0, executor_options_utils_1.forEachExecutorOptions)(tree, '@nrwl/cypress:cypress', (options, projectName, targetName, configName) => {
-        if (!(options.cypressConfig && tree.exists(options.cypressConfig))) {
-            return;
-        }
-        const projectConfig = projects.get(projectName);
-        turnOffTestIsolation(tree, options.cypressConfig);
-        (0, devkit_1.visitNotIgnoredFiles)(tree, projectConfig.root, (filePath) => {
-            if (!JS_TS_FILE_MATCHER.test(filePath)) {
-                return;
-            }
-            shouldUseCyIntercept(tree, filePath);
-            shouldUseCySession(tree, filePath);
-            shouldNotUseCyInShouldCB(tree, filePath);
-            shouldNotOverrideCommands(tree, filePath);
-        });
-    });
-    console.warn((0, devkit_1.stripIndents) `Cypress 12 has lots of breaking changes that might subtly break your tests.
-This migration marked known issues that need to be manually migrated, 
-but there can still be runtime based errors that were not detected.
-Please consult the offical Cypress v12 migration guide for more info on these changes and the next steps.
-https://docs.cypress.io/guides/references/migration-guide
-      `);
-    (0, devkit_1.updateJson)(tree, 'package.json', (json) => {
-        json.devDependencies.cypress = '^12.2.0';
-        return json;
-    });
-    return () => {
-        (0, devkit_1.installPackagesTask)(tree);
-    };
-}
-exports.updateToCypress12 = updateToCypress12;
-function turnOffTestIsolation(tree, configPath) {
-    const config = tree.read(configPath, 'utf-8');
-    const isTestIsolationSet = tsquery_1.tsquery.query(config, 'ExportAssignment ObjectLiteralExpression > PropertyAssignment:has(Identifier[name="testIsolation"])');
-    if (isTestIsolationSet.length > 0) {
-        return;
-    }
-    const testIsolationProperty = `/**
-    * TODO(@nrwl/cypress): In Cypress v12,the testIsolation option is turned on by default. 
-    * This can cause tests to start breaking where not indended.
-    * You should consider enabling this once you verify tests do not depend on each other
-    * More Info: https://docs.cypress.io/guides/references/migration-guide#Test-Isolation
-    **/
-    testIsolation: false,`;
-    const updated = tsquery_1.tsquery.replace(config, 'ExportAssignment ObjectLiteralExpression > PropertyAssignment:has(Identifier[name="e2e"])', (node) => {
-        if ((0, typescript_1.isObjectLiteralExpression)(node.initializer)) {
-            const listOfProperties = node.initializer.properties
-                .map((j) => j.getText())
-                .join(',\n    ');
-            return `e2e: {
-    ${listOfProperties},
-    ${testIsolationProperty}
- }`;
-        }
-        return `e2e: {
-    ...${node.initializer.getText()},
-    ${testIsolationProperty}
-  }`;
-    });
-    tree.write(configPath, updated);
-}
-exports.turnOffTestIsolation = turnOffTestIsolation;
-/**
- * Leave a comment on all apis that have been removed andsuperseded by cy.intercept
- * stating they these API are now removed and need to update.
- * cy.route, cy.server, Cypress.Server.defaults
- **/
-function shouldUseCyIntercept(tree, filePath) {
-    const content = tree.read(filePath, 'utf-8');
-    const markedRemovedCommands = tsquery_1.tsquery.replace(content, ':matches(PropertyAccessExpression:has(Identifier[name="cy"]):has(Identifier[name="server"], Identifier[name="route"]), PropertyAccessExpression:has(Identifier[name="defaults"]):has(Identifier[name="Cypress"], Identifier[name="Server"]))', (node) => {
-        if ((0, helpers_1.isAlreadyCommented)(node)) {
-            return;
-        }
-        const expression = node.expression.getText().trim();
-        // prevent extra chaining i.e. cy.route().as() will return 2 results
-        // cy.route and cy.route().as
-        // only need the first 1 so skip any extra chaining
-        if (expression === 'cy' || expression === 'Cypress.Server') {
-            return `// TODO(@nrwl/cypress): this command has been removed, use cy.intercept instead. https://docs.cypress.io/guides/references/migration-guide#cy-server-cy-route-and-Cypress-Server-defaults
-${node.getText()}`;
-        }
-    });
-    tree.write(filePath, markedRemovedCommands);
-}
-exports.shouldUseCyIntercept = shouldUseCyIntercept;
-/**
- * Leave a comment on all apis that have been removed and superseded by cy.session
- * stating they these API are now removed and need to update.
- * Cypress.Cookies.defaults & Cypress.Cookies.preserveOnce
- **/
-function shouldUseCySession(tree, filePath) {
-    const content = tree.read(filePath, 'utf-8');
-    const markedRemovedCommands = tsquery_1.tsquery.replace(content, ':matches(PropertyAccessExpression:has(Identifier[name="defaults"]):has(Identifier[name="Cypress"], Identifier[name="Cookies"]), PropertyAccessExpression:has(Identifier[name="preserveOnce"]):has(Identifier[name="Cypress"], Identifier[name="Cookies"]))', (node) => {
-        if ((0, helpers_1.isAlreadyCommented)(node)) {
-            return;
-        }
-        const expression = node.expression.getText().trim();
-        // prevent grabbing other Cypress.<something>.defaults
-        if (expression === 'Cypress.Cookies') {
-            return `// TODO(@nrwl/cypress): this command has been removed, use cy.session instead. https://docs.cypress.io/guides/references/migration-guide#Command-Cypress-API-Changes
-${node.getText()}`;
-        }
-    });
-    tree.write(filePath, markedRemovedCommands);
-}
-exports.shouldUseCySession = shouldUseCySession;
-/**
- * leave a comment about nested cy commands in a cy.should callback
- * */
-function shouldNotUseCyInShouldCB(tree, filePath) {
-    const content = tree.read(filePath, 'utf-8');
-    const markedNestedCyCommands = tsquery_1.tsquery.replace(content, 'CallExpression > PropertyAccessExpression:has(Identifier[name="cy"]):has(Identifier[name="should"])', (node) => {
-        if ((0, helpers_1.isAlreadyCommented)(node) ||
-            (node.parent && !(0, typescript_1.isCallExpression)(node.parent))) {
-            return;
-        }
-        const parentExpression = node.parent;
-        if (parentExpression?.arguments?.[0] &&
-            ((0, typescript_1.isArrowFunction)(parentExpression.arguments[0]) ||
-                (0, typescript_1.isFunctionExpression)(parentExpression.arguments[0]))) {
-            const isUsingNestedCyCommand = tsquery_1.tsquery.query(parentExpression.arguments[0], 'CallExpression > PropertyAccessExpression:has(Identifier[name="cy"])')?.length > 0;
-            if (isUsingNestedCyCommand) {
-                return `/**
-* TODO(@nrwl/cypress): Nesting Cypress commands in a should assertion now throws.
-* You should use .then() to chain commands instead.
-* More Info: https://docs.cypress.io/guides/references/migration-guide#-should
-**/
-${node.getText()}`;
-            }
-            return node.getText();
-        }
-    });
-    tree.write(filePath, markedNestedCyCommands);
-}
-exports.shouldNotUseCyInShouldCB = shouldNotUseCyInShouldCB;
-/**
- * leave a comment on all usages of overriding built-ins that are now banned
- * */
-function shouldNotOverrideCommands(tree, filePath) {
-    const content = tree.read(filePath, 'utf-8');
-    const markedOverrideUsage = tsquery_1.tsquery.replace(content, 'PropertyAccessExpression:has(Identifier[name="overwrite"]):has(Identifier[name="Cypress"])', (node) => {
-        if ((0, helpers_1.isAlreadyCommented)(node)) {
-            return;
-        }
-        const expression = node.expression.getText().trim();
-        // prevent grabbing other Cypress.<something>.defaults
-        if (expression === 'Cypress.Commands') {
-            // get value.
-            const overwriteExpression = node.parent;
-            const command = overwriteExpression.arguments?.[0]?.text; // need string without quotes
-            if (helpers_1.BANNED_COMMANDS.includes(command)) {
-                // overwrite
-                return `/**
-* TODO(@nrwl/cypress): This command can no longer be overridden
-* Consider using a different name like 'custom_${command}'
-* More info: https://docs.cypress.io/guides/references/migration-guide#Cypress-Commands-overwrite
-**/
-${node.getText()}`;
-            }
-        }
-    });
-    tree.write(filePath, markedOverrideUsage);
-}
-exports.shouldNotOverrideCommands = shouldNotOverrideCommands;
-exports.default = updateToCypress12;