@nx/playwright 18.0.0-canary.20240202-ea5befb → 18.0.0

package/generators.json

@@ -3,12 +3,12 @@
   "version": "0.1",
   "generators": {
     "configuration": {
-      "factory": "./src/generators/configuration/configuration",
+      "factory": "./src/generators/configuration/configuration#configurationGeneratorInternal",
       "schema": "./src/generators/configuration/schema.json",
       "description": "Add Nx Playwright configuration to your project"
     },
     "init": {
-      "factory": "./src/generators/init/init",
+      "factory": "./src/generators/init/init#initGeneratorInternal",
       "schema": "./src/generators/init/schema.json",
       "description": "Initializes a Playwright project in the current workspace"
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/playwright",
-  "version": "18.0.0-canary.20240202-ea5befb",
+  "version": "18.0.0",
   "type": "commonjs",
   "homepage": "https://nx.dev",
   "private": false,
@@ -33,9 +33,9 @@
   },
   "dependencies": {
     "@phenomnomnominal/tsquery": "~5.0.1",
-    "@nx/devkit": "18.0.0-canary.20240202-ea5befb",
-    "@nx/eslint": "18.0.0-canary.20240202-ea5befb",
-    "@nx/js": "18.0.0-canary.20240202-ea5befb",
+    "@nx/devkit": "18.0.0",
+    "@nx/eslint": "18.0.0",
+    "@nx/js": "18.0.0",
     "tslib": "^2.3.0",
     "minimatch": "9.0.3"
   },

package/plugin.d.ts

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

package/plugin.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createNodes = void 0;
+exports.createDependencies = 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; } });

package/src/generators/configuration/configuration.d.ts

@@ -1,4 +1,5 @@
 import { GeneratorCallback, Tree } from '@nx/devkit';
 import { ConfigurationGeneratorSchema } from './schema';
 export declare function configurationGenerator(tree: Tree, options: ConfigurationGeneratorSchema): Promise<GeneratorCallback>;
+export declare function configurationGeneratorInternal(tree: Tree, options: ConfigurationGeneratorSchema): Promise<GeneratorCallback>;
 export default configurationGenerator;

package/src/generators/configuration/configuration.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.configurationGenerator = void 0;
+exports.configurationGeneratorInternal = exports.configurationGenerator = void 0;
 const devkit_1 = require("@nx/devkit");
 const js_1 = require("@nx/js");
 const versions_1 = require("@nx/js/src/utils/versions");
@@ -9,11 +9,17 @@ const path = require("path");
 const add_linter_1 = require("../../utils/add-linter");
 const versions_2 = require("../../utils/versions");
 const init_1 = require("../init/init");
-async function configurationGenerator(tree, options) {
+function configurationGenerator(tree, options) {
+    return configurationGeneratorInternal(tree, { addPlugin: false, ...options });
+}
+exports.configurationGenerator = configurationGenerator;
+async function configurationGeneratorInternal(tree, options) {
+    options.addPlugin ??= process.env.NX_ADD_PLUGINS !== 'false';
     const tasks = [];
     tasks.push(await (0, init_1.initGenerator)(tree, {
         skipFormat: true,
         skipPackageJson: options.skipPackageJson,
+        addPlugin: options.addPlugin,
     }));
     const projectConfig = (0, devkit_1.readProjectConfiguration)(tree, options.project);
     const hasTsConfig = tree.exists((0, devkit_1.joinPathFragments)(projectConfig.root, 'tsconfig.json'));
@@ -59,6 +65,7 @@ async function configurationGenerator(tree, options) {
         directory: options.directory,
         setParserOptionsProject: options.setParserOptionsProject,
         rootProject: options.rootProject ?? projectConfig.root === '.',
+        addPlugin: options.addPlugin,
     }));
     if (options.js) {
         const { ModuleKind } = (0, devkit_1.ensurePackage)('typescript', versions_1.typescriptVersion);
@@ -79,7 +86,7 @@ async function configurationGenerator(tree, options) {
     }
     return (0, devkit_1.runTasksInSerial)(...tasks);
 }
-exports.configurationGenerator = configurationGenerator;
+exports.configurationGeneratorInternal = configurationGeneratorInternal;
 function getBrowsersInstallTask() {
     return () => {
         devkit_1.output.log({

package/src/generators/configuration/schema.d.ts

@@ -23,4 +23,5 @@ export interface ConfigurationGeneratorSchema {
    **/
   webServerAddress?: string;
   rootProject?: boolean;
+  addPlugin?: boolean;
 }

package/src/generators/init/init.d.ts

@@ -1,4 +1,5 @@
 import { GeneratorCallback, Tree } from '@nx/devkit';
 import { InitGeneratorSchema } from './schema';
 export declare function initGenerator(tree: Tree, options: InitGeneratorSchema): Promise<GeneratorCallback>;
+export declare function initGeneratorInternal(tree: Tree, options: InitGeneratorSchema): Promise<GeneratorCallback>;
 export default initGenerator;

package/src/generators/init/init.js

@@ -1,19 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initGenerator = void 0;
+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 plugin_1 = require("../../plugins/plugin");
 const versions_1 = require("../../utils/versions");
-async function initGenerator(tree, options) {
+function initGenerator(tree, options) {
+    return initGeneratorInternal(tree, { addPlugin: false, ...options });
+}
+exports.initGenerator = initGenerator;
+async function initGeneratorInternal(tree, options) {
     const tasks = [];
+    options.addPlugin ??= process.env.NX_ADD_PLUGINS !== 'false';
     if (!options.skipPackageJson) {
         tasks.push((0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
             '@nx/playwright': versions_1.nxVersion,
             '@playwright/test': versions_1.playwrightVersion,
         }, undefined, options.keepExistingVersions));
     }
-    if (process.env.NX_PCV3 === 'true') {
+    if (options.addPlugin) {
         addPlugin(tree);
     }
     if (options.updatePackageScripts) {
@@ -24,7 +29,7 @@ async function initGenerator(tree, options) {
     }
     return (0, devkit_1.runTasksInSerial)(...tasks);
 }
-exports.initGenerator = initGenerator;
+exports.initGeneratorInternal = initGeneratorInternal;
 function addPlugin(tree) {
     const nxJson = (0, devkit_1.readNxJson)(tree);
     nxJson.plugins ??= [];

package/src/generators/init/schema.d.ts

@@ -3,4 +3,5 @@ export interface InitGeneratorSchema {
   skipPackageJson?: boolean;
   keepExistingVersions?: boolean;
   updatePackageScripts?: boolean;
+  addPlugin?: boolean;
 }

package/src/plugins/plugin.js

@@ -8,9 +8,9 @@ const get_named_inputs_1 = require("@nx/devkit/src/utils/get-named-inputs");
 const calculate_hash_for_create_nodes_1 = require("@nx/devkit/src/utils/calculate-hash-for-create-nodes");
 const workspace_context_1 = require("nx/src/utils/workspace-context");
 const minimatch_1 = require("minimatch");
-const load_config_file_1 = require("../utils/load-config-file");
 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 = {};
@@ -53,7 +53,11 @@ exports.createNodes = [
     },
 ];
 async function buildPlaywrightTargets(configFilePath, projectRoot, options, context) {
-    const playwrightConfig = await (0, load_config_file_1.loadPlaywrightConfig)((0, path_1.join)(context.workspaceRoot, configFilePath));
+    // 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.
+    // See: https://github.com/microsoft/playwright/pull/11218/files
+    delete process['__pw_initiator__'];
+    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 = {};
     const baseTargetConfig = {

package/src/utils/add-linter.d.ts

@@ -11,5 +11,6 @@ export interface PlaywrightLinterOptions {
      * Directory from the project root, where the playwright files will be located.
      **/
     directory: string;
+    addPlugin?: boolean;
 }
 export declare function addLinterToPlaywrightProject(tree: Tree, options: PlaywrightLinterOptions): Promise<GeneratorCallback>;

package/src/utils/add-linter.js

@@ -22,6 +22,7 @@ async function addLinterToPlaywrightProject(tree, options) {
             setParserOptionsProject: options.setParserOptionsProject,
             skipPackageJson: options.skipPackageJson,
             rootProject: options.rootProject,
+            addPlugin: options.addPlugin,
         }));
     }
     if (!options.linter || options.linter !== eslint_1.Linter.EsLint) {

package/src/utils/load-config-file.d.ts

@@ -1,3 +0,0 @@
-import type { PlaywrightTestConfig } from '@playwright/test';
-export declare let dynamicImport: Function;
-export declare function loadPlaywrightConfig(configFilePath: any): Promise<PlaywrightTestConfig>;

package/src/utils/load-config-file.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadPlaywrightConfig = exports.dynamicImport = void 0;
-const path_1 = require("path");
-const js_1 = require("@nx/js");
-const internal_1 = require("@nx/js/src/internal");
-exports.dynamicImport = new Function('modulePath', 'return import(modulePath);');
-async function loadPlaywrightConfig(configFilePath) {
-    {
-        let module;
-        const configPathWithTimestamp = `${configFilePath}?t=${Date.now()}`;
-        if ((0, path_1.extname)(configFilePath) === '.ts') {
-            const tsConfigPath = (0, js_1.getRootTsConfigPath)();
-            if (tsConfigPath) {
-                const unregisterTsProject = (0, internal_1.registerTsProject)(tsConfigPath);
-                try {
-                    module = await (0, exports.dynamicImport)(configPathWithTimestamp);
-                }
-                finally {
-                    unregisterTsProject();
-                }
-            }
-            else {
-                module = await (0, exports.dynamicImport)(configPathWithTimestamp);
-            }
-        }
-        else {
-            module = await (0, exports.dynamicImport)(configPathWithTimestamp);
-        }
-        return module.default ?? module;
-    }
-}
-exports.loadPlaywrightConfig = loadPlaywrightConfig;
-const packageInstallationDirectories = ['node_modules', '.yarn'];