@nx/playwright 20.1.0-canary.20241026-f84b6e5 → 20.1.0-canary.20241030-62f58eb

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/playwright",
-  "version": "20.1.0-canary.20241026-f84b6e5",
+  "version": "20.1.0-canary.20241030-62f58eb",
   "type": "commonjs",
   "homepage": "https://nx.dev",
   "private": false,
@@ -35,11 +35,11 @@
   },
   "dependencies": {
     "@phenomnomnominal/tsquery": "~5.0.1",
-    "@nx/devkit": "20.1.0-canary.20241026-f84b6e5",
-    "@nx/eslint": "20.1.0-canary.20241026-f84b6e5",
-    "@nx/webpack": "20.1.0-canary.20241026-f84b6e5",
-    "@nx/vite": "20.1.0-canary.20241026-f84b6e5",
-    "@nx/js": "20.1.0-canary.20241026-f84b6e5",
+    "@nx/devkit": "20.1.0-canary.20241030-62f58eb",
+    "@nx/eslint": "20.1.0-canary.20241030-62f58eb",
+    "@nx/webpack": "20.1.0-canary.20241030-62f58eb",
+    "@nx/vite": "20.1.0-canary.20241030-62f58eb",
+    "@nx/js": "20.1.0-canary.20241030-62f58eb",
     "tslib": "^2.3.0",
     "minimatch": "9.0.3"
   },

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

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

package/src/generators/configuration/configuration.js

@@ -3,23 +3,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.configurationGenerator = configurationGenerator;
 exports.configurationGeneratorInternal = configurationGeneratorInternal;
 const devkit_1 = require("@nx/devkit");
+const project_name_and_root_utils_1 = require("@nx/devkit/src/generators/project-name-and-root-utils");
+const prompt_1 = require("@nx/devkit/src/generators/prompt");
 const js_1 = require("@nx/js");
+const package_manager_workspaces_1 = require("@nx/js/src/utils/package-manager-workspaces");
+const ensure_typescript_1 = require("@nx/js/src/utils/typescript/ensure-typescript");
 const ts_solution_setup_1 = require("@nx/js/src/utils/typescript/ts-solution-setup");
-const versions_1 = require("@nx/js/src/utils/versions");
 const child_process_1 = require("child_process");
 const path = require("path");
 const add_linter_1 = require("../../utils/add-linter");
-const versions_2 = require("../../utils/versions");
+const versions_1 = require("../../utils/versions");
 const init_1 = require("../init/init");
 function configurationGenerator(tree, options) {
     return configurationGeneratorInternal(tree, { addPlugin: false, ...options });
 }
-async function configurationGeneratorInternal(tree, options) {
-    (0, ts_solution_setup_1.assertNotUsingTsSolutionSetup)(tree, 'playwright', 'configuration');
-    const nxJson = (0, devkit_1.readNxJson)(tree);
-    options.addPlugin ??=
-        process.env.NX_ADD_PLUGINS !== 'false' &&
-            nxJson.useInferencePlugins !== false;
+async function configurationGeneratorInternal(tree, rawOptions) {
+    const options = await normalizeOptions(tree, rawOptions);
     const tasks = [];
     tasks.push(await (0, init_1.initGenerator)(tree, {
         skipFormat: true,
@@ -27,7 +26,6 @@ async function configurationGeneratorInternal(tree, options) {
         addPlugin: options.addPlugin,
     }));
     const projectConfig = (0, devkit_1.readProjectConfiguration)(tree, options.project);
-    const hasTsConfig = tree.exists((0, devkit_1.joinPathFragments)(projectConfig.root, 'tsconfig.json'));
     const offsetFromProjectRoot = (0, devkit_1.offsetFromRoot)(projectConfig.root);
     (0, devkit_1.generateFiles)(tree, path.join(__dirname, 'files'), projectConfig.root, {
         offsetFromRoot: offsetFromProjectRoot,
@@ -36,13 +34,14 @@ async function configurationGeneratorInternal(tree, options) {
         webServerAddress: options.webServerAddress ?? null,
         ...options,
     });
-    if (!hasTsConfig) {
-        tree.write(`${projectConfig.root}/tsconfig.json`, JSON.stringify({
+    const isTsSolutionSetup = (0, ts_solution_setup_1.isUsingTsSolutionSetup)(tree);
+    const tsconfigPath = (0, devkit_1.joinPathFragments)(projectConfig.root, 'tsconfig.json');
+    if (!tree.exists(tsconfigPath)) {
+        const tsconfig = {
             extends: (0, js_1.getRelativePathToRootTsConfig)(tree, projectConfig.root),
             compilerOptions: {
                 allowJs: true,
                 outDir: `${offsetFromProjectRoot}dist/out-tsc`,
-                module: 'commonjs',
                 sourceMap: false,
             },
             include: [
@@ -55,7 +54,37 @@ async function configurationGeneratorInternal(tree, options) {
                 'src/**/*.test.js',
                 'src/**/*.d.ts',
             ],
-        }, null, 2));
+        };
+        if (isTsSolutionSetup) {
+            tsconfig.compilerOptions.outDir = 'dist';
+            tsconfig.compilerOptions.tsBuildInfoFile = 'dist/tsconfig.tsbuildinfo';
+            if (!options.rootProject) {
+                // add the project tsconfog to the workspace root tsconfig.json references
+                (0, devkit_1.updateJson)(tree, 'tsconfig.json', (json) => {
+                    json.references ??= [];
+                    json.references.push({ path: './' + projectConfig.root });
+                    return json;
+                });
+            }
+        }
+        else {
+            tsconfig.compilerOptions.outDir = `${offsetFromProjectRoot}dist/out-tsc`;
+            tsconfig.compilerOptions.module = 'commonjs';
+        }
+        (0, devkit_1.writeJson)(tree, tsconfigPath, tsconfig);
+    }
+    if (isTsSolutionSetup) {
+        const packageJsonPath = (0, devkit_1.joinPathFragments)(projectConfig.root, 'package.json');
+        if (!tree.exists(packageJsonPath)) {
+            const importPath = (0, project_name_and_root_utils_1.resolveImportPath)(tree, projectConfig.name, projectConfig.root);
+            const packageJson = {
+                name: importPath,
+                version: '0.0.1',
+                private: true,
+            };
+            (0, devkit_1.writeJson)(tree, packageJsonPath, packageJson);
+        }
+        ignoreTestOutput(tree);
     }
     const hasPlugin = (0, devkit_1.readNxJson)(tree).plugins?.some((p) => typeof p === 'string'
         ? p === '@nx/playwright/plugin'
@@ -75,14 +104,14 @@ async function configurationGeneratorInternal(tree, options) {
         addPlugin: options.addPlugin,
     }));
     if (options.js) {
-        const { ModuleKind } = (0, devkit_1.ensurePackage)('typescript', versions_1.typescriptVersion);
+        const { ModuleKind } = (0, ensure_typescript_1.ensureTypescript)();
         (0, devkit_1.toJS)(tree, { extension: '.cjs', module: ModuleKind.CommonJS });
     }
     recommendVsCodeExtensions(tree);
     if (!options.skipPackageJson) {
         tasks.push((0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
             // required since used in playwright config
-            '@nx/devkit': versions_2.nxVersion,
+            '@nx/devkit': versions_1.nxVersion,
         }));
     }
     if (!options.skipInstall) {
@@ -91,8 +120,46 @@ async function configurationGeneratorInternal(tree, options) {
     if (!options.skipFormat) {
         await (0, devkit_1.formatFiles)(tree);
     }
+    if (isTsSolutionSetup) {
+        const projectPackageManagerWorkspaceState = (0, package_manager_workspaces_1.getProjectPackageManagerWorkspaceState)(tree, projectConfig.root);
+        if (projectPackageManagerWorkspaceState !== 'included') {
+            tasks.push((0, package_manager_workspaces_1.getProjectPackageManagerWorkspaceStateWarningTask)(projectPackageManagerWorkspaceState, tree.root));
+        }
+    }
     return (0, devkit_1.runTasksInSerial)(...tasks);
 }
+async function normalizeOptions(tree, options) {
+    const nxJson = (0, devkit_1.readNxJson)(tree);
+    const addPlugin = options.addPlugin ??
+        (process.env.NX_ADD_PLUGINS !== 'false' &&
+            nxJson.useInferencePlugins !== false);
+    const isTsSolutionSetup = (0, ts_solution_setup_1.isUsingTsSolutionSetup)(tree);
+    let linter = options.linter;
+    if (isTsSolutionSetup) {
+        linter ??= await (0, prompt_1.promptWhenInteractive)({
+            type: 'select',
+            name: 'linter',
+            message: `Which linter would you like to use?`,
+            choices: [{ name: 'none' }, { name: 'eslint' }],
+            initial: 0,
+        }, { linter: 'none' }).then(({ linter }) => linter);
+    }
+    else {
+        linter ??= await (0, prompt_1.promptWhenInteractive)({
+            type: 'select',
+            name: 'linter',
+            message: `Which linter would you like to use?`,
+            choices: [{ name: 'eslint' }, { name: 'none' }],
+            initial: 0,
+        }, { linter: 'eslint' }).then(({ linter }) => linter);
+    }
+    return {
+        ...options,
+        addPlugin,
+        linter,
+        directory: options.directory ?? 'e2e',
+    };
+}
 function getBrowsersInstallTask() {
     return () => {
         devkit_1.output.log({
@@ -154,4 +221,15 @@ Rename or remove the existing e2e target.`);
     };
     (0, devkit_1.updateProjectConfiguration)(tree, options.project, projectConfig);
 }
+function ignoreTestOutput(tree) {
+    if (!tree.exists('.gitignore')) {
+        devkit_1.logger.warn(`Couldn't find a root .gitignore file to update.`);
+    }
+    let content = tree.read('.gitignore', 'utf-8');
+    if (/^test-output$/gm.test(content)) {
+        return;
+    }
+    content = `${content}\ntest-output\n`;
+    tree.write('.gitignore', content);
+}
 exports.default = configurationGenerator;

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

@@ -5,13 +5,13 @@ export interface ConfigurationGeneratorSchema {
   /**
    * this is relative to the projectRoot
    **/
-  directory: string;
-  js: boolean; // default is false
-  skipFormat: boolean;
-  skipPackageJson: boolean;
+  directory?: string;
+  js?: boolean; // default is false
+  skipFormat?: boolean;
+  skipPackageJson?: boolean;
   skipInstall?: boolean;
-  linter: Linter | LinterType;
-  setParserOptionsProject: boolean; // default is false
+  linter?: Linter | LinterType;
+  setParserOptionsProject?: boolean; // default is false
   /**
    * command to give playwright to run the web server
    * @example: "npx nx serve my-fe-app"
@@ -25,3 +25,10 @@ export interface ConfigurationGeneratorSchema {
   rootProject?: boolean;
   addPlugin?: boolean;
 }
+
+export interface NormalizedGeneratorOptions
+  extends ConfigurationGeneratorSchema {
+  addPlugin: boolean;
+  directory: string;
+  linter: Linter | LinterType;
+}

package/src/generators/configuration/schema.json

@@ -20,6 +20,12 @@
       "x-priority": "important",
       "default": "e2e"
     },
+    "linter": {
+      "description": "The tool to use for running lint checks.",
+      "type": "string",
+      "enum": ["none", "eslint"],
+      "x-priority": "important"
+    },
     "js": {
       "type": "boolean",
       "description": "Generate JavaScript files rather than TypeScript files.",
@@ -33,12 +39,6 @@
       "type": "string",
       "description": "The address of the web server."
     },
-    "linter": {
-      "description": "The tool to use for running lint checks.",
-      "type": "string",
-      "enum": ["eslint", "none"],
-      "default": "eslint"
-    },
     "setParserOptionsProject": {
       "type": "boolean",
       "description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",

package/src/generators/init/init.js

@@ -4,14 +4,12 @@ exports.initGenerator = initGenerator;
 exports.initGeneratorInternal = initGeneratorInternal;
 const devkit_1 = require("@nx/devkit");
 const add_plugin_1 = require("@nx/devkit/src/utils/add-plugin");
-const ts_solution_setup_1 = require("@nx/js/src/utils/typescript/ts-solution-setup");
 const plugin_1 = require("../../plugins/plugin");
 const versions_1 = require("../../utils/versions");
 function initGenerator(tree, options) {
     return initGeneratorInternal(tree, { addPlugin: false, ...options });
 }
 async function initGeneratorInternal(tree, options) {
-    (0, ts_solution_setup_1.assertNotUsingTsSolutionSetup)(tree, 'playwright', 'init');
     const tasks = [];
     const nxJson = (0, devkit_1.readNxJson)(tree);
     const addPluginDefault = process.env.NX_ADD_PLUGINS !== 'false' &&

package/src/utils/preset.js

@@ -2,9 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.nxE2EPreset = nxE2EPreset;
 const devkit_1 = require("@nx/devkit");
+const ts_solution_setup_1 = require("@nx/js/src/utils/typescript/ts-solution-setup");
+const test_1 = require("@playwright/test");
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
-const test_1 = require("@playwright/test");
 /**
  * nx E2E Preset for Playwright
  * @description
@@ -33,8 +34,13 @@ function nxE2EPreset(pathToConfig, options) {
         : (0, node_path_1.dirname)(pathToConfig);
     const projectPath = (0, node_path_1.relative)(devkit_1.workspaceRoot, normalizedPath);
     const offset = (0, node_path_1.relative)(normalizedPath, devkit_1.workspaceRoot);
-    const testResultOuputDir = (0, node_path_1.join)(offset, 'dist', '.playwright', projectPath, 'test-output');
-    const reporterOutputDir = (0, node_path_1.join)(offset, 'dist', '.playwright', projectPath, 'playwright-report');
+    const isTsSolutionSetup = (0, ts_solution_setup_1.isUsingTsSolutionSetup)();
+    const testResultOuputDir = isTsSolutionSetup
+        ? 'test-output/playwright/output'
+        : (0, node_path_1.join)(offset, 'dist', '.playwright', projectPath, 'test-output');
+    const reporterOutputDir = isTsSolutionSetup
+        ? 'test-output/playwright/report'
+        : (0, node_path_1.join)(offset, 'dist', '.playwright', projectPath, 'playwright-report');
     return (0, test_1.defineConfig)({
         testDir: options?.testDir ?? './src',
         outputDir: testResultOuputDir,