@nx/cypress 19.0.0-beta.1 → 19.0.0-beta.10

package/generators.json

@@ -9,12 +9,6 @@
       "aliases": ["ng-add"],
       "hidden": true
     },
-    "cypress-project": {
-      "factory": "./src/generators/cypress-project/cypress-project#cypressProjectGeneratorInternal",
-      "schema": "./src/generators/cypress-project/schema.json",
-      "description": "Add a Cypress E2E Project.",
-      "hidden": true
-    },
     "configuration": {
       "aliases": ["cypress-e2e-configuration", "e2e", "e2e-config"],
       "factory": "./src/generators/configuration/configuration#configurationGeneratorInternal",
@@ -32,6 +26,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/index.d.ts

@@ -1,11 +1,4 @@
-import { configurationGenerator } from './src/generators/configuration/configuration';
-import { componentConfigurationGenerator } from './src/generators/component-configuration/component-configuration';
-import { cypressProjectGenerator as _cypressProjectGenerator } from './src/generators/cypress-project/cypress-project';
-export { configurationGenerator, componentConfigurationGenerator };
-/** @deprecated Use `configurationGenerator` instead. It will be removed in Nx 19. */
-export declare const cypressComponentConfiguration: typeof componentConfigurationGenerator;
-export { configurationGenerator as cypressE2EConfigurationGenerator };
-/** @deprecated Add a new project and call `configurationGenerator` instead. It will be removed in Nx 19. */
-export declare const cypressProjectGenerator: typeof _cypressProjectGenerator;
+export { configurationGenerator } from './src/generators/configuration/configuration';
+export { componentConfigurationGenerator } from './src/generators/component-configuration/component-configuration';
 export { cypressInitGenerator } from './src/generators/init/init';
 export { migrateCypressProject } from './src/generators/migrate-to-cypress-11/migrate-to-cypress-11';

package/index.js

@@ -1,19 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.migrateCypressProject = exports.cypressInitGenerator = exports.cypressProjectGenerator = exports.cypressE2EConfigurationGenerator = exports.cypressComponentConfiguration = exports.componentConfigurationGenerator = exports.configurationGenerator = void 0;
-const configuration_1 = require("./src/generators/configuration/configuration");
+exports.migrateCypressProject = exports.cypressInitGenerator = exports.componentConfigurationGenerator = exports.configurationGenerator = void 0;
+var configuration_1 = require("./src/generators/configuration/configuration");
 Object.defineProperty(exports, "configurationGenerator", { enumerable: true, get: function () { return configuration_1.configurationGenerator; } });
-Object.defineProperty(exports, "cypressE2EConfigurationGenerator", { enumerable: true, get: function () { return configuration_1.configurationGenerator; } });
-const component_configuration_1 = require("./src/generators/component-configuration/component-configuration");
+var component_configuration_1 = require("./src/generators/component-configuration/component-configuration");
 Object.defineProperty(exports, "componentConfigurationGenerator", { enumerable: true, get: function () { return component_configuration_1.componentConfigurationGenerator; } });
-const cypress_project_1 = require("./src/generators/cypress-project/cypress-project");
-// Maintain backwards compatibility with the old names in case community plugins used them.
-// TODO(v19): Remove old name
-/** @deprecated Use `configurationGenerator` instead. It will be removed in Nx 19. */
-exports.cypressComponentConfiguration = component_configuration_1.componentConfigurationGenerator;
-// TODO(v19): Remove project generator
-/** @deprecated Add a new project and call `configurationGenerator` instead. It will be removed in Nx 19. */
-exports.cypressProjectGenerator = cypress_project_1.cypressProjectGenerator;
 var init_1 = require("./src/generators/init/init");
 Object.defineProperty(exports, "cypressInitGenerator", { enumerable: true, get: function () { return init_1.cypressInitGenerator; } });
 var migrate_to_cypress_11_1 = require("./src/generators/migrate-to-cypress-11/migrate-to-cypress-11");

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.1",
+  "version": "19.0.0-beta.10",
   "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,13 @@
     "migrations": "./migrations.json"
   },
   "dependencies": {
-    "@nx/devkit": "19.0.0-beta.1",
-    "@nx/eslint": "19.0.0-beta.1",
-    "@nx/js": "19.0.0-beta.1",
+    "@nx/devkit": "19.0.0-beta.10",
+    "@nx/eslint": "19.0.0-beta.10",
+    "@nx/js": "19.0.0-beta.10",
     "@phenomnomnominal/tsquery": "~5.0.1",
     "detect-port": "^1.5.1",
-    "semver": "^7.5.3",
     "tslib": "^2.3.0",
-    "@nrwl/cypress": "19.0.0-beta.1"
+    "@nrwl/cypress": "19.0.0-beta.10"
   },
   "peerDependencies": {
     "cypress": ">= 3 < 14"

package/plugins/cypress-preset.d.ts

@@ -14,6 +14,8 @@ export interface NxComponentTestingOptions {
     bundler?: 'vite' | 'webpack';
     compiler?: 'swc' | 'babel';
 }
+export interface NxComponentTestingPresetOptions extends Omit<NxComponentTestingOptions, 'bundler'> {
+}
 export declare function nxBaseCypressPreset(pathToConfig: string, options?: {
     testingType: 'component' | 'e2e';
 }): BaseCypressPreset;

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/generators/cypress-project/cypress-project.d.ts

@@ -1,16 +0,0 @@
-import { GeneratorCallback, Tree } from '@nx/devkit';
-import { Schema } from './schema';
-export interface CypressProjectSchema extends Schema {
-    projectName: string;
-    projectRoot: string;
-    rootProject: boolean;
-}
-/**
- * @deprecated use cypressE2EConfigurationGenerator instead
- **/
-export declare function cypressProjectGenerator(host: Tree, schema: Schema): Promise<GeneratorCallback>;
-/**
- * @deprecated use cypressE2EConfigurationGenerator instead
- **/
-export declare function cypressProjectGeneratorInternal(host: Tree, schema: Schema): Promise<GeneratorCallback>;
-export default cypressProjectGenerator;