@nx/playwright 0.0.0-pr-22179-271588f → 0.0.0-pr-26482-ebe2dba

package/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2017-2023 Narwhal Technologies Inc.
+Copyright (c) 2017-2024 Narwhal Technologies Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

package/generators.json

@@ -11,6 +11,11 @@
       "factory": "./src/generators/init/init#initGeneratorInternal",
       "schema": "./src/generators/init/schema.json",
       "description": "Initializes a Playwright project in the current workspace"
+    },
+    "convert-to-inferred": {
+      "factory": "./src/generators/convert-to-inferred/convert-to-inferred",
+      "schema": "./src/generators/convert-to-inferred/schema.json",
+      "description": "Convert existing Playwright project(s) using `@nx/playwright:playwright` executor to use `@nx/playwright/plugin`."
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/playwright",
-  "version": "0.0.0-pr-22179-271588f",
+  "version": "0.0.0-pr-26482-ebe2dba",
   "type": "commonjs",
   "homepage": "https://nx.dev",
   "private": false,
@@ -17,7 +17,9 @@
     "Nest",
     "Jest",
     "Playwright",
-    "CLI"
+    "CLI",
+    "Testing",
+    "Front-end"
   ],
   "main": "./index.js",
   "typings": "./index.d.ts",
@@ -33,9 +35,9 @@
   },
   "dependencies": {
     "@phenomnomnominal/tsquery": "~5.0.1",
-    "@nx/devkit": "0.0.0-pr-22179-271588f",
-    "@nx/eslint": "0.0.0-pr-22179-271588f",
-    "@nx/js": "0.0.0-pr-22179-271588f",
+    "@nx/devkit": "0.0.0-pr-26482-ebe2dba",
+    "@nx/eslint": "0.0.0-pr-26482-ebe2dba",
+    "@nx/js": "0.0.0-pr-26482-ebe2dba",
     "tslib": "^2.3.0",
     "minimatch": "9.0.3"
   },

package/plugin.d.ts

@@ -1 +1 @@
-export { createNodes, PlaywrightPluginOptions, createDependencies, } from './src/plugins/plugin';
+export { createNodes, createNodesV2, PlaywrightPluginOptions, } from './src/plugins/plugin';

package/plugin.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDependencies = exports.createNodes = void 0;
+exports.createNodesV2 = exports.createNodes = void 0;
 var plugin_1 = require("./src/plugins/plugin");
 Object.defineProperty(exports, "createNodes", { enumerable: true, get: function () { return plugin_1.createNodes; } });
-Object.defineProperty(exports, "createDependencies", { enumerable: true, get: function () { return plugin_1.createDependencies; } });
+Object.defineProperty(exports, "createNodesV2", { enumerable: true, get: function () { return plugin_1.createNodesV2; } });

package/src/executors/playwright/playwright.impl.d.ts

@@ -28,7 +28,7 @@ export interface PlaywrightExecutorSchema {
     updateSnapshots?: boolean;
     ui?: boolean;
     uiHost?: string;
-    uiPort?: string;
+    uiPort?: number;
     skipInstall?: boolean;
 }
 export declare function playwrightExecutor(options: PlaywrightExecutorSchema, context: ExecutorContext): Promise<{

package/src/executors/playwright/schema.json

@@ -155,7 +155,7 @@
       "description": "Host to serve UI on; specifying this option opens UI in a browser tab"
     },
     "uiPort": {
-      "type": "string",
+      "type": "number",
       "description": "Port to serve UI on, 0 for any free port; specifying this option opens UI in a browser tab"
     },
     "skipInstall": {

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,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertToInferred = void 0;
+const devkit_1 = require("@nx/devkit");
+const plugin_1 = require("../../plugins/plugin");
+const executor_to_plugin_migrator_1 = require("@nx/devkit/src/generators/plugin-migrations/executor-to-plugin-migrator");
+async function convertToInferred(tree, options) {
+    const projectGraph = await (0, devkit_1.createProjectGraphAsync)();
+    const migratedProjects = await (0, executor_to_plugin_migrator_1.migrateExecutorToPlugin)(tree, projectGraph, '@nx/playwright:playwright', '@nx/playwright/plugin', (targetName) => ({ targetName, ciTargetName: 'e2e-ci' }), postTargetTransformer, plugin_1.createNodesV2, options.project);
+    if (migratedProjects.size === 0) {
+        throw new Error('Could not find any targets to migrate.');
+    }
+    if (!options.skipFormat) {
+        await (0, devkit_1.formatFiles)(tree);
+    }
+}
+exports.convertToInferred = convertToInferred;
+function postTargetTransformer(target) {
+    if (target.options) {
+        if (target.options?.config) {
+            delete target.options.config;
+        }
+        for (const [key, value] of Object.entries(target.options)) {
+            const newKeyName = (0, devkit_1.names)(key).fileName;
+            delete target.options[key];
+            target.options[newKeyName] = value;
+        }
+    }
+    return target;
+}
+exports.default = convertToInferred;

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

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "$id": "NxPlaywrightConvertToInferred",
+  "description": "Convert existing Playwright project(s) using `@nx/playwright:playwright` executor to use `@nx/playwright/plugin`. Defaults to migrating all projects. Pass '--project' to migrate only one target.",
+  "title": "Convert Playwright project from executor to plugin",
+  "type": "object",
+  "properties": {
+    "project": {
+      "type": "string",
+      "description": "The project to convert from using the `@nx/playwright:playwright` executor to use `@nx/playwright/plugin`.",
+      "x-priority": "important"
+    },
+    "skipFormat": {
+      "type": "boolean",
+      "description": "Whether to format files at the end of the migration.",
+      "default": false
+    }
+  }
+}

package/src/generators/init/init.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.initGeneratorInternal = exports.initGenerator = void 0;
 const devkit_1 = require("@nx/devkit");
-const update_package_scripts_1 = require("@nx/devkit/src/utils/update-package-scripts");
+const add_plugin_1 = require("@nx/devkit/src/utils/add-plugin");
 const plugin_1 = require("../../plugins/plugin");
 const versions_1 = require("../../utils/versions");
 function initGenerator(tree, options) {
@@ -22,10 +22,7 @@ async function initGeneratorInternal(tree, options) {
         }, undefined, options.keepExistingVersions));
     }
     if (options.addPlugin) {
-        addPlugin(tree);
-    }
-    if (options.updatePackageScripts) {
-        await (0, update_package_scripts_1.updatePackageScripts)(tree, plugin_1.createNodes);
+        await (0, add_plugin_1.addPlugin)(tree, await (0, devkit_1.createProjectGraphAsync)(), '@nx/playwright/plugin', plugin_1.createNodesV2, { targetName: ['e2e', 'playwright:e2e', 'playwright-e2e'] }, options.updatePackageScripts);
     }
     if (!options.skipFormat) {
         await (0, devkit_1.formatFiles)(tree);
@@ -33,19 +30,4 @@ async function initGeneratorInternal(tree, options) {
     return (0, devkit_1.runTasksInSerial)(...tasks);
 }
 exports.initGeneratorInternal = initGeneratorInternal;
-function addPlugin(tree) {
-    const nxJson = (0, devkit_1.readNxJson)(tree);
-    nxJson.plugins ??= [];
-    if (!nxJson.plugins.some((p) => typeof p === 'string'
-        ? p === '@nx/playwright/plugin'
-        : p.plugin === '@nx/playwright/plugin')) {
-        nxJson.plugins.push({
-            plugin: '@nx/playwright/plugin',
-            options: {
-                targetName: 'e2e',
-            },
-        });
-        (0, devkit_1.updateNxJson)(tree, nxJson);
-    }
-}
 exports.default = initGenerator;

package/src/plugins/plugin.d.ts

@@ -1,7 +1,11 @@
-import { CreateDependencies, CreateNodes } from '@nx/devkit';
+import { CreateNodes, CreateNodesV2 } from '@nx/devkit';
 export interface PlaywrightPluginOptions {
     targetName?: string;
     ciTargetName?: string;
 }
-export declare const createDependencies: CreateDependencies;
+export declare const createNodesV2: CreateNodesV2<PlaywrightPluginOptions>;
+/**
+ * @deprecated This is replaced with {@link createNodesV2}. Update your plugin to export its own `createNodesV2` function that wraps this one instead.
+ * This function will change to the v2 function in Nx 20.
+ */
 export declare const createNodes: CreateNodes<PlaywrightPluginOptions>;

package/src/plugins/plugin.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createNodes = exports.createDependencies = void 0;
+exports.createNodes = exports.createNodesV2 = void 0;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const devkit_1 = require("@nx/devkit");
@@ -11,47 +11,61 @@ const minimatch_1 = require("minimatch");
 const cache_directory_1 = require("nx/src/utils/cache-directory");
 const js_1 = require("@nx/js");
 const config_utils_1 = require("@nx/devkit/src/utils/config-utils");
-const cachePath = (0, path_1.join)(cache_directory_1.projectGraphCacheDirectory, 'playwright.hash');
-const targetsCache = (0, fs_1.existsSync)(cachePath) ? readTargetsCache() : {};
-const calculatedTargets = {};
-function readTargetsCache() {
-    return (0, devkit_1.readJsonFile)(cachePath);
+const file_hasher_1 = require("nx/src/hasher/file-hasher");
+function readTargetsCache(cachePath) {
+    return (0, fs_1.existsSync)(cachePath) ? (0, devkit_1.readJsonFile)(cachePath) : {};
 }
-function writeTargetsToCache(targets) {
-    (0, devkit_1.writeJsonFile)(cachePath, targets);
+function writeTargetsToCache(cachePath, results) {
+    (0, devkit_1.writeJsonFile)(cachePath, results);
 }
-const createDependencies = () => {
-    writeTargetsToCache(calculatedTargets);
-    return [];
-};
-exports.createDependencies = createDependencies;
-exports.createNodes = [
-    '**/playwright.config.{js,ts,cjs,cts,mjs,mts}',
-    async (configFilePath, options, context) => {
-        const projectRoot = (0, path_1.dirname)(configFilePath);
-        // Do not create a project if package.json and project.json isn't there.
-        const siblingFiles = (0, fs_1.readdirSync)((0, path_1.join)(context.workspaceRoot, projectRoot));
-        if (!siblingFiles.includes('package.json') &&
-            !siblingFiles.includes('project.json')) {
-            return {};
+const playwrightConfigGlob = '**/playwright.config.{js,ts,cjs,cts,mjs,mts}';
+exports.createNodesV2 = [
+    playwrightConfigGlob,
+    async (configFilePaths, options, context) => {
+        const optionsHash = (0, file_hasher_1.hashObject)(options);
+        const cachePath = (0, path_1.join)(cache_directory_1.workspaceDataDirectory, `playwright-${optionsHash}.hash`);
+        const targetsCache = readTargetsCache(cachePath);
+        try {
+            return await (0, devkit_1.createNodesFromFiles)((configFile, options, context) => createNodesInternal(configFile, options, context, targetsCache), configFilePaths, options, context);
+        }
+        finally {
+            writeTargetsToCache(cachePath, targetsCache);
         }
-        const normalizedOptions = normalizeOptions(options);
-        const hash = (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(projectRoot, options, context, [
-            (0, js_1.getLockFileName)((0, devkit_1.detectPackageManager)(context.workspaceRoot)),
-        ]);
-        const targets = targetsCache[hash] ??
-            (await buildPlaywrightTargets(configFilePath, projectRoot, normalizedOptions, context));
-        calculatedTargets[hash] = targets;
-        return {
-            projects: {
-                [projectRoot]: {
-                    root: projectRoot,
-                    targets,
-                },
-            },
-        };
     },
 ];
+/**
+ * @deprecated This is replaced with {@link createNodesV2}. Update your plugin to export its own `createNodesV2` function that wraps this one instead.
+ * This function will change to the v2 function in Nx 20.
+ */
+exports.createNodes = [
+    playwrightConfigGlob,
+    async (configFile, options, context) => {
+        devkit_1.logger.warn('`createNodes` is deprecated. Update your plugin to utilize createNodesV2 instead. In Nx 20, this will change to the createNodesV2 API.');
+        return createNodesInternal(configFile, options, context, {});
+    },
+];
+async function createNodesInternal(configFilePath, options, context, targetsCache) {
+    const projectRoot = (0, path_1.dirname)(configFilePath);
+    // Do not create a project if package.json and project.json isn't there.
+    const siblingFiles = (0, fs_1.readdirSync)((0, path_1.join)(context.workspaceRoot, projectRoot));
+    if (!siblingFiles.includes('package.json') &&
+        !siblingFiles.includes('project.json')) {
+        return {};
+    }
+    const normalizedOptions = normalizeOptions(options);
+    const hash = await (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(projectRoot, options, context, [(0, js_1.getLockFileName)((0, devkit_1.detectPackageManager)(context.workspaceRoot))]);
+    targetsCache[hash] ??= await buildPlaywrightTargets(configFilePath, projectRoot, normalizedOptions, context);
+    const { targets, metadata } = targetsCache[hash];
+    return {
+        projects: {
+            [projectRoot]: {
+                root: projectRoot,
+                targets,
+                metadata,
+            },
+        },
+    };
+}
 async function buildPlaywrightTargets(configFilePath, projectRoot, options, context) {
     // Playwright forbids importing the `@playwright/test` module twice. This would affect running the tests,
     // but we're just reading the config so let's delete the variable they are using to detect this.
@@ -60,41 +74,60 @@ async function buildPlaywrightTargets(configFilePath, projectRoot, options, cont
     const playwrightConfig = await (0, config_utils_1.loadConfigFile)((0, path_1.join)(context.workspaceRoot, configFilePath));
     const namedInputs = (0, get_named_inputs_1.getNamedInputs)(projectRoot, context);
     const targets = {};
+    let metadata;
     const baseTargetConfig = {
         command: 'playwright test',
         options: {
             cwd: '{projectRoot}',
         },
+        metadata: {
+            technologies: ['playwright'],
+            description: 'Runs Playwright Tests',
+        },
     };
     targets[options.targetName] = {
         ...baseTargetConfig,
         cache: true,
-        inputs: 'production' in namedInputs
-            ? ['default', '^production']
-            : ['default', '^default'],
+        inputs: [
+            ...('production' in namedInputs
+                ? ['default', '^production']
+                : ['default', '^default']),
+            { externalDependencies: ['@playwright/test'] },
+        ],
         outputs: getOutputs(projectRoot, playwrightConfig),
     };
     if (options.ciTargetName) {
         const ciBaseTargetConfig = {
             ...baseTargetConfig,
             cache: true,
-            inputs: 'production' in namedInputs
-                ? ['default', '^production']
-                : ['default', '^default'],
+            inputs: [
+                ...('production' in namedInputs
+                    ? ['default', '^production']
+                    : ['default', '^default']),
+                { externalDependencies: ['@playwright/test'] },
+            ],
             outputs: getOutputs(projectRoot, playwrightConfig),
         };
+        const groupName = 'E2E (CI)';
+        metadata = { targetGroups: { [groupName]: [] } };
+        const ciTargetGroup = metadata.targetGroups[groupName];
         const testDir = playwrightConfig.testDir
             ? (0, devkit_1.joinPathFragments)(projectRoot, playwrightConfig.testDir)
             : projectRoot;
         // Playwright defaults to the following pattern.
         playwrightConfig.testMatch ??= '**/*.@(spec|test).?(c|m)[jt]s?(x)';
         const dependsOn = [];
-        forEachTestFile((testFile) => {
-            const relativeToProjectRoot = (0, devkit_1.normalizePath)((0, path_1.relative)(projectRoot, testFile));
-            const targetName = `${options.ciTargetName}--${relativeToProjectRoot}`;
+        await forEachTestFile((testFile) => {
+            const relativeSpecFilePath = (0, devkit_1.normalizePath)((0, path_1.relative)(projectRoot, testFile));
+            const targetName = `${options.ciTargetName}--${relativeSpecFilePath}`;
+            ciTargetGroup.push(targetName);
             targets[targetName] = {
                 ...ciBaseTargetConfig,
-                command: `${baseTargetConfig.command} ${relativeToProjectRoot}`,
+                command: `${baseTargetConfig.command} ${relativeSpecFilePath}`,
+                metadata: {
+                    technologies: ['playwright'],
+                    description: `Runs Playwright Tests in ${relativeSpecFilePath} in CI`,
+                },
             };
             dependsOn.push({
                 target: targetName,
@@ -113,12 +146,17 @@ async function buildPlaywrightTargets(configFilePath, projectRoot, options, cont
             inputs: ciBaseTargetConfig.inputs,
             outputs: ciBaseTargetConfig.outputs,
             dependsOn,
+            metadata: {
+                technologies: ['playwright'],
+                description: 'Runs Playwright Tests in CI',
+            },
         };
+        ciTargetGroup.push(options.ciTargetName);
     }
-    return targets;
+    return { targets, metadata };
 }
 async function forEachTestFile(cb, opts) {
-    const files = (0, workspace_context_1.getFilesInDirectoryUsingContext)(opts.context.workspaceRoot, opts.path);
+    const files = await (0, workspace_context_1.getFilesInDirectoryUsingContext)(opts.context.workspaceRoot, opts.path);
     const matcher = createMatcher(opts.config.testMatch);
     const ignoredMatcher = opts.config.testIgnore
         ? createMatcher(opts.config.testIgnore)

package/src/utils/add-linter.js

@@ -31,7 +31,8 @@ async function addLinterToPlaywrightProject(tree, options) {
     tasks.push(!options.skipPackageJson
         ? (0, devkit_1.addDependenciesToPackageJson)(tree, {}, { 'eslint-plugin-playwright': versions_1.eslintPluginPlaywrightVersion })
         : () => { });
-    if ((0, eslint_file_1.isEslintConfigSupported)(tree)) {
+    if ((0, eslint_file_1.isEslintConfigSupported)(tree, projectConfig.root) ||
+        (0, eslint_file_1.isEslintConfigSupported)(tree)) {
         (0, eslint_file_1.addExtendsToLintConfig)(tree, projectConfig.root, 'plugin:playwright/recommended');
         if (options.rootProject) {
             (0, eslint_file_1.addPluginsToLintConfig)(tree, projectConfig.root, '@nx');