@nx/cypress 16.10.0 → 17.0.0-beta.1

package/index.d.ts

@@ -6,6 +6,4 @@ export declare const cypressComponentConfiguration: typeof componentConfiguratio
 export { configurationGenerator as cypressE2EConfigurationGenerator };
 export { cypressProjectGenerator } from './src/generators/cypress-project/cypress-project';
 export { cypressInitGenerator } from './src/generators/init/init';
-/** @deprecated This generator will be removed in v17 */
-export { conversionGenerator } from './src/generators/convert-tslint-to-eslint/convert-tslint-to-eslint';
 export { migrateCypressProject } from './src/generators/migrate-to-cypress-11/migrate-to-cypress-11';

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.migrateCypressProject = exports.conversionGenerator = exports.cypressInitGenerator = exports.cypressProjectGenerator = exports.cypressE2EConfigurationGenerator = exports.cypressComponentConfiguration = exports.componentConfigurationGenerator = exports.configurationGenerator = void 0;
+exports.migrateCypressProject = exports.cypressInitGenerator = exports.cypressProjectGenerator = exports.cypressE2EConfigurationGenerator = exports.cypressComponentConfiguration = exports.componentConfigurationGenerator = exports.configurationGenerator = void 0;
 const 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; } });
@@ -13,8 +13,5 @@ var cypress_project_1 = require("./src/generators/cypress-project/cypress-projec
 Object.defineProperty(exports, "cypressProjectGenerator", { enumerable: true, get: function () { return cypress_project_1.cypressProjectGenerator; } });
 var init_1 = require("./src/generators/init/init");
 Object.defineProperty(exports, "cypressInitGenerator", { enumerable: true, get: function () { return init_1.cypressInitGenerator; } });
-/** @deprecated This generator will be removed in v17 */
-var convert_tslint_to_eslint_1 = require("./src/generators/convert-tslint-to-eslint/convert-tslint-to-eslint");
-Object.defineProperty(exports, "conversionGenerator", { enumerable: true, get: function () { return convert_tslint_to_eslint_1.conversionGenerator; } });
 var migrate_to_cypress_11_1 = require("./src/generators/migrate-to-cypress-11/migrate-to-cypress-11");
 Object.defineProperty(exports, "migrateCypressProject", { enumerable: true, get: function () { return migrate_to_cypress_11_1.migrateCypressProject; } });

package/migrations.json

@@ -1,23 +1,5 @@
 {
   "generators": {
-    "remove-typescript-plugin": {
-      "cli": "nx",
-      "version": "12.8.0-beta.0",
-      "description": "Remove Typescript Preprocessor Plugin",
-      "factory": "./src/migrations/update-12-8-0/remove-typescript-plugin"
-    },
-    "update-cypress-configs-preset": {
-      "cli": "nx",
-      "version": "14.6.1-beta.0",
-      "description": "Change Cypress e2e and component testing presets to use __filename instead of __dirname and include a devServerTarget for component testing.",
-      "factory": "./src/migrations/update-14-6-1/update-cypress-configs-presets"
-    },
-    "update-cypress-if-v10": {
-      "cli": "nx",
-      "version": "14.7.0-beta.0",
-      "description": "Update Cypress if using v10 to support latest component testing features",
-      "factory": "./src/migrations/update-14-7-0/update-cypress-version-if-10"
-    },
     "add-cypress-inputs": {
       "cli": "nx",
       "version": "15.0.0-beta.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/cypress",
-  "version": "16.10.0",
+  "version": "17.0.0-beta.1",
   "private": false,
   "description": "The Nx Plugin for Cypress contains executors and generators allowing your workspace to use the powerful Cypress integration testing capabilities.",
   "repository": {
@@ -38,10 +38,10 @@
     "detect-port": "^1.5.1",
     "semver": "7.5.3",
     "tslib": "^2.3.0",
-    "@nx/devkit": "16.10.0",
-    "@nx/js": "16.10.0",
-    "@nx/linter": "16.10.0",
-    "@nrwl/cypress": "16.10.0"
+    "@nx/devkit": "17.0.0-beta.1",
+    "@nx/js": "17.0.0-beta.1",
+    "@nx/linter": "17.0.0-beta.1",
+    "@nrwl/cypress": "17.0.0-beta.1"
   },
   "peerDependencies": {
     "cypress": ">= 3 < 14"

package/src/generators/component-configuration/component-configuration.js

@@ -68,22 +68,14 @@ function addTargetToProject(tree, projectConfig, opts) {
 }
 function updateNxJsonConfiguration(tree) {
     const nxJson = (0, devkit_1.readNxJson)(tree);
-    nxJson.tasksRunnerOptions = {
-        ...nxJson?.tasksRunnerOptions,
-        default: {
-            ...nxJson?.tasksRunnerOptions?.default,
-            options: {
-                ...nxJson?.tasksRunnerOptions?.default?.options,
-                cacheableOperations: Array.from(new Set([
-                    ...(nxJson?.tasksRunnerOptions?.default?.options
-                        ?.cacheableOperations ?? []),
-                    'component-test',
-                ])),
-            },
-        },
-    };
+    const cacheableOperations = nxJson.tasksRunnerOptions?.default?.options?.cacheableOperations;
+    if (cacheableOperations && !cacheableOperations.includes('component-test')) {
+        cacheableOperations.push('component-test');
+    }
+    nxJson.targetDefaults ??= {};
+    nxJson.targetDefaults['component-test'] ??= {};
+    nxJson.targetDefaults['component-test'].cache ??= true;
     if (nxJson.namedInputs) {
-        nxJson.targetDefaults ??= {};
         const productionFileSet = nxJson.namedInputs?.production;
         if (productionFileSet) {
             nxJson.namedInputs.production = Array.from(new Set([

package/src/generators/convert-tslint-to-eslint/convert-tslint-to-eslint.d.ts

@@ -1,7 +0,0 @@
-import { Tree } from '@nx/devkit';
-import { ConvertTSLintToESLintSchema } from '@nx/linter';
-/**
- * @deprecated This generator will be removed in v17
- */
-export declare function conversionGenerator(host: Tree, options: ConvertTSLintToESLintSchema): Promise<() => Promise<void>>;
-export declare const conversionSchematic: (generatorOptions: ConvertTSLintToESLintSchema) => (tree: any, context: any) => Promise<any>;

package/src/generators/convert-tslint-to-eslint/convert-tslint-to-eslint.js

@@ -1,103 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.conversionSchematic = exports.conversionGenerator = void 0;
-const devkit_1 = require("@nx/devkit");
-const linter_1 = require("@nx/linter");
-const add_linter_1 = require("../../utils/add-linter");
-/**
- * @deprecated This generator will be removed in v17
- */
-async function conversionGenerator(host, options) {
-    /**
-     * The ProjectConverter instance encapsulates all the standard operations we need
-     * to perform in order to convert a project from TSLint to ESLint, as well as some
-     * extensibility points for adjusting the behavior on a per package basis.
-     *
-     * E.g. @nx/angular projects might need to make different changes to the final
-     * ESLint config when compared with @nx/next projects.
-     *
-     * See the ProjectConverter implementation for a full breakdown of what it does.
-     */
-    const projectConverter = new linter_1.ProjectConverter({
-        host,
-        projectName: options.project,
-        ignoreExistingTslintConfig: options.ignoreExistingTslintConfig,
-        eslintInitializer: async ({ projectName, projectConfig }) => {
-            await (0, add_linter_1.addLinterToCyProject)(host, {
-                linter: linter_1.Linter.EsLint,
-                project: projectName,
-                /**
-                 * We set the parserOptions.project config just in case the converted config uses
-                 * rules which require type-checking. Later in the conversion we check if it actually
-                 * does and remove the config again if it doesn't, so that it is most efficient.
-                 */
-                setParserOptionsProject: true,
-                cypressDir: 'src',
-                overwriteExisting: true,
-            });
-        },
-    });
-    /**
-     * If root eslint configuration already exists it will not be recreated
-     * but we also don't want to re-run the tslint config conversion
-     * as it was likely already done
-     */
-    const rootEslintConfigExists = host.exists('.eslintrc.json');
-    /**
-     * Create the standard (which is applicable to the current package) ESLint setup
-     * for converting the project.
-     */
-    const eslintInitInstallTask = await projectConverter.initESLint();
-    /**
-     * Convert the root tslint.json and apply the converted rules to the root .eslintrc.json.
-     */
-    const rootConfigInstallTask = await projectConverter.convertRootTSLintConfig((json) => removeCodelyzerRelatedRules(json), rootEslintConfigExists);
-    /**
-     * Convert the project's tslint.json to an equivalent ESLint config.
-     */
-    const projectConfigInstallTask = await projectConverter.convertProjectConfig((json) => json);
-    /**
-     * Clean up the original TSLint configuration for the project.
-     */
-    projectConverter.removeProjectTSLintFile();
-    // Only project shouldn't be added as a default
-    const { project, ...defaults } = options;
-    /**
-     * Store user preferences for the collection
-     */
-    projectConverter.setDefaults('@nx/cypress', defaults);
-    /**
-     * Based on user preference and remaining usage, remove TSLint from the workspace entirely.
-     */
-    let uninstallTSLintTask = () => Promise.resolve(undefined);
-    if (options.removeTSLintIfNoMoreTSLintTargets &&
-        !projectConverter.isTSLintUsedInWorkspace()) {
-        uninstallTSLintTask = projectConverter.removeTSLintFromWorkspace();
-    }
-    if (!options.skipFormat) {
-        await (0, devkit_1.formatFiles)(host);
-    }
-    return async () => {
-        await eslintInitInstallTask();
-        await rootConfigInstallTask();
-        await projectConfigInstallTask();
-        await uninstallTSLintTask();
-    };
-}
-exports.conversionGenerator = conversionGenerator;
-exports.conversionSchematic = (0, devkit_1.convertNxGenerator)(conversionGenerator);
-/**
- * Remove any @angular-eslint rules that were applied as a result of converting prior codelyzer
- * rules, because they are only relevant for Angular projects.
- */
-function removeCodelyzerRelatedRules(json) {
-    for (const ruleName of Object.keys(json.rules)) {
-        if (ruleName.startsWith('@angular-eslint')) {
-            delete json.rules[ruleName];
-        }
-    }
-    if (json.plugins) {
-        json.plugins = json.plugins.filter((plugin) => !plugin.startsWith('@angular-eslint'));
-    }
-    return json;
-}

package/src/generators/convert-tslint-to-eslint/schema.json

@@ -1,45 +0,0 @@
-{
-  "$schema": "http://json-schema.org/schema",
-  "$id": "cypress-convert-tslint-to-eslint",
-  "cli": "nx",
-  "title": "Convert a Cypress project from TSLint to ESLint",
-  "description": "Convert a Cypress project from TSLint to ESLint.\n_NOTE: Does not work in `--dry-run` mode_.",
-  "x-deprecated": "This generator is deprecated and will be removed in a future version of Nx. Migrate to ESLint.",
-  "examples": [
-    {
-      "command": "nx g convert-tslint-to-eslint myapp",
-      "description": "Convert the Cypress project `myapp` from TSLint to ESLint."
-    }
-  ],
-  "type": "object",
-  "properties": {
-    "project": {
-      "description": "The name of the Cypress project to convert.",
-      "type": "string",
-      "$default": {
-        "$source": "argv",
-        "index": 0
-      },
-      "x-prompt": "Which Cypress project would you like to convert from TSLint to ESLint?"
-    },
-    "ignoreExistingTslintConfig": {
-      "type": "boolean",
-      "description": "If true we will not use existing TSLint config as a reference, we will just reset the project with the latest recommended ESLint config.",
-      "default": false,
-      "x-prompt": "Would you like to ignore the existing TSLint config? Recommended if the TSLint config has not been altered much as it makes the new ESLint config cleaner."
-    },
-    "removeTSLintIfNoMoreTSLintTargets": {
-      "type": "boolean",
-      "description": "If this conversion leaves no more TSLint usage in the workspace, it will remove TSLint and related dependencies and configuration.",
-      "default": true,
-      "x-prompt": "Would you like to remove TSLint and its related config if there are no TSLint projects remaining after this conversion?"
-    },
-    "skipFormat": {
-      "type": "boolean",
-      "description": "Skip formatting files.",
-      "default": false,
-      "x-priority": "internal"
-    }
-  },
-  "required": ["project"]
-}

package/src/migrations/update-12-8-0/remove-typescript-plugin.d.ts

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

package/src/migrations/update-12-8-0/remove-typescript-plugin.js

@@ -1,85 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const devkit_1 = require("@nx/devkit");
-const typescript_1 = require("typescript");
-const path_1 = require("path");
-const cypress_version_1 = require("../../utils/cypress-version");
-async function removeTypescriptPlugin(tree) {
-    const cypressVersion = (0, cypress_version_1.installedCypressVersion)();
-    if (cypressVersion < 7) {
-        console.warn(`Cypress v${cypressVersion} is installed. This migration was skipped. Please rerun this migration after updating to Cypress 7.`);
-        return;
-    }
-    for (const [_, proj] of (0, devkit_1.getProjects)(tree)) {
-        const cypressTargets = getCypressTargets(proj);
-        if (cypressTargets.length <= 0) {
-            continue;
-        }
-        for (const target of cypressTargets) {
-            const cypressConfigs = getCypressConfigs(target);
-            for (const config of cypressConfigs) {
-                const cypressConfig = (0, devkit_1.readJson)(tree, config);
-                if (cypressConfig.pluginsFile) {
-                    let pluginPath = (0, path_1.join)((0, path_1.dirname)(config), cypressConfig.pluginsFile);
-                    if (!tree.exists(pluginPath)) {
-                        pluginPath = ['.js', '.ts']
-                            .map((ext) => pluginPath + ext)
-                            .find((path) => tree.exists(path));
-                    }
-                    removePreprocessor(tree, pluginPath);
-                }
-            }
-        }
-    }
-    await (0, devkit_1.formatFiles)(tree);
-}
-exports.default = removeTypescriptPlugin;
-function removePreprocessor(tree, pluginPath) {
-    const pluginContents = tree.read(pluginPath, 'utf-8');
-    const sourceFile = (0, typescript_1.createSourceFile)(pluginPath, pluginContents, typescript_1.ScriptTarget.ESNext, true);
-    const deletions = [];
-    const callback = (node) => {
-        // Look for the invocation of preprocessTypescript
-        if ((0, typescript_1.isCallExpression)(node) &&
-            (0, typescript_1.isIdentifier)(node.expression) &&
-            node.expression.getText(sourceFile) === 'preprocessTypescript' &&
-            node.arguments.length < 2) {
-            // Get the Statement that the function call belongs to
-            let n = node.parent;
-            while (!(0, typescript_1.isExpressionStatement)(n) && n === sourceFile) {
-                n = n.parent;
-            }
-            deletions.push({
-                type: devkit_1.ChangeType.Delete,
-                start: n.getStart(),
-                length: n.getWidth() +
-                    (pluginContents[n.getStart() + n.getWidth()] === ';' ? 1 : 0),
-            });
-        }
-    };
-    // Call the callback for every node in the file
-    sourceFile.forEachChild(recurse);
-    function recurse(node) {
-        callback(node);
-        node.forEachChild((child) => recurse(child));
-    }
-    // Remove the preprocessor from the file
-    tree.write(pluginPath, (0, devkit_1.applyChangesToString)(pluginContents, deletions));
-}
-function getCypressConfigs(target) {
-    if (!target.configurations && !target.options.cypressConfig) {
-        return [];
-    }
-    else if (!target.configurations && target.options.cypressConfig) {
-        return [target.options.cypressConfig];
-    }
-    return [target.options, Object.values(target.configurations)]
-        .filter((options) => !!options.cypressConfig)
-        .map((options) => options.cypressConfig);
-}
-function getCypressTargets(proj) {
-    if (!proj.targets) {
-        return [];
-    }
-    return Object.values(proj.targets).filter((target) => target.executor === '@nrwl/cypress:cypress');
-}

package/src/migrations/update-14-6-1/update-cypress-configs-presets.d.ts

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

package/src/migrations/update-14-6-1/update-cypress-configs-presets.js

@@ -1,122 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateCypressConfigsPresets = 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 cypress_version_1 = require("../../utils/cypress-version");
-const find_target_options_1 = require("../../utils/find-target-options");
-async function updateCypressConfigsPresets(tree) {
-    if ((0, cypress_version_1.installedCypressVersion)() < 10) {
-        return;
-    }
-    const projectsWithoutDevServerTarget = new Set();
-    const updateTasks = [];
-    (0, executor_options_utils_1.forEachExecutorOptions)(tree, '@nrwl/cypress:cypress', (options, projectName, targetName, configName) => {
-        if (options.cypressConfig && tree.exists(options.cypressConfig)) {
-            updatePreset(tree, options, targetName);
-        }
-        const projectConfig = (0, devkit_1.readProjectConfiguration)(tree, projectName);
-        const testingType = options.testingType ||
-            projectConfig.targets[targetName]?.options?.testingType;
-        const devServerTarget = options.devServerTarget ||
-            projectConfig.targets[targetName]?.options?.devServerTarget;
-        if (!devServerTarget && testingType === 'component') {
-            updateTasks.push(addBuildTargetToConfig(tree, projectName, targetName, configName).then((didUpdate) => {
-                if (!didUpdate) {
-                    projectsWithoutDevServerTarget.add(projectName);
-                }
-            }));
-        }
-    });
-    if (updateTasks.length > 0) {
-        cacheComponentTestTarget(tree);
-    }
-    await Promise.all(updateTasks);
-    if (projectsWithoutDevServerTarget.size > 0) {
-        devkit_1.logger.warn(`Unable to find a build target to add to the component testing target in the following projects:`);
-        devkit_1.logger.warn(`- ${Array.from(projectsWithoutDevServerTarget).join('\n- ')}`);
-        devkit_1.logger.warn((0, devkit_1.stripIndents) `
-You can manually add the 'devServerTarget' option to the 
-component testing target to specify the build target to use.
-The build configuration should be using @nrwl/web:webpack as the executor. 
-Usually this is a React app in your workspace. 
-Component testing will fallback to a default configuration if one isn't provided, 
-but might require modifications if your projects are more complex.
-    `);
-    }
-}
-exports.updateCypressConfigsPresets = updateCypressConfigsPresets;
-function updatePreset(tree, options, targetName) {
-    let contents = tsquery_1.tsquery.replace(tree.read(options.cypressConfig, 'utf-8'), 'CallExpression', (node) => {
-        // technically someone could have both component and e2e in the same project.
-        const expression = node.expression.getText();
-        if (expression === 'nxE2EPreset') {
-            return 'nxE2EPreset(__filename)';
-        }
-        else if (expression === 'nxE2EStorybookPreset') {
-            return 'nxE2EStorybookPreset(__filename)';
-        }
-        else if (node.expression.getText() === 'nxComponentTestingPreset') {
-            return targetName && targetName !== 'component-test' // the default
-                ? `nxComponentTestingPreset(__filename, { ctTargetName: '${targetName}' })`
-                : 'nxComponentTestingPreset(__filename)';
-        }
-        return;
-    });
-    tree.write(options.cypressConfig, contents);
-}
-async function addBuildTargetToConfig(tree, projectName, targetName, configName) {
-    const projectWithBuild = await (0, find_target_options_1.findBuildConfig)(tree, {
-        project: projectName,
-        validExecutorNames: new Set(['@nrwl/web:webpack']),
-        skipGetOptions: true,
-    });
-    // didn't find the config so can't update. consumer should collect list of them and display a warning at the end
-    // no reason to fail since the preset will fallback to a default config so should still keep working.
-    if (!projectWithBuild?.target) {
-        return false;
-    }
-    const projectConfig = (0, devkit_1.readProjectConfiguration)(tree, projectName);
-    // if using a custom config and the devServerTarget default args
-    // has a different target, then add it to the custom target config
-    // otherwise add it to the default options
-    if (configName &&
-        projectWithBuild.target !==
-            projectConfig.targets[targetName]?.options?.devServerTarget) {
-        projectConfig.targets[targetName].configurations[configName] = {
-            ...projectConfig.targets[targetName].configurations[configName],
-            devServerTarget: projectWithBuild.target,
-            skipServe: true,
-        };
-    }
-    else {
-        projectConfig.targets[targetName].options = {
-            ...projectConfig.targets[targetName].options,
-            devServerTarget: projectWithBuild.target,
-            skipServe: true,
-        };
-    }
-    (0, devkit_1.updateProjectConfiguration)(tree, projectName, projectConfig);
-    return true;
-}
-function cacheComponentTestTarget(tree) {
-    (0, devkit_1.updateJson)(tree, 'nx.json', (json) => ({
-        ...json,
-        tasksRunnerOptions: {
-            ...json.tasksRunnerOptions,
-            default: {
-                ...json.tasksRunnerOptions?.default,
-                options: {
-                    ...json.tasksRunnerOptions?.default?.options,
-                    cacheableOperations: Array.from(new Set([
-                        ...(json.tasksRunnerOptions?.default?.options
-                            ?.cacheableOperations ?? []),
-                        'component-test',
-                    ])),
-                },
-            },
-        },
-    }));
-}
-exports.default = updateCypressConfigsPresets;

package/src/migrations/update-14-7-0/update-cypress-version-if-10.d.ts

@@ -1,3 +0,0 @@
-import { GeneratorCallback, Tree } from '@nx/devkit';
-export declare function updateCypressVersionIf10(tree: Tree): GeneratorCallback;
-export default updateCypressVersionIf10;

package/src/migrations/update-14-7-0/update-cypress-version-if-10.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateCypressVersionIf10 = void 0;
-const devkit_1 = require("@nx/devkit");
-// don't import from root level to prevent issue where angular isn't installed.
-const semver_1 = require("@nx/devkit/src/utils/semver");
-const semver_2 = require("semver");
-function updateCypressVersionIf10(tree) {
-    const installedVersion = (0, devkit_1.readJson)(tree, 'package.json').devDependencies?.['cypress'];
-    if (!installedVersion) {
-        return;
-    }
-    const normalizedInstalledCypressVersion = (0, semver_1.checkAndCleanWithSemver)('cypress', installedVersion);
-    // not using v10
-    if ((0, semver_2.lt)(normalizedInstalledCypressVersion, '10.0.0') ||
-        (0, semver_2.gte)(normalizedInstalledCypressVersion, '11.0.0')) {
-        return;
-    }
-    const ngComponentTestingVersion = '10.7.0';
-    if ((0, semver_2.lt)(normalizedInstalledCypressVersion, ngComponentTestingVersion)) {
-        (0, devkit_1.updateJson)(tree, 'package.json', (json) => {
-            json.devDependencies['cypress'] = `^${ngComponentTestingVersion}`;
-            return json;
-        });
-        return () => {
-            (0, devkit_1.installPackagesTask)(tree);
-        };
-    }
-}
-exports.updateCypressVersionIf10 = updateCypressVersionIf10;
-exports.default = updateCypressVersionIf10;