@nx/playwright 17.3.0-canary.20240116-42aefd8 → 17.3.0-canary.20240118-8ccf327

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/playwright",
-  "version": "17.3.0-canary.20240116-42aefd8",
+  "version": "17.3.0-canary.20240118-8ccf327",
   "type": "commonjs",
   "homepage": "https://nx.dev",
   "private": false,
@@ -32,9 +32,9 @@
     "directory": "packages/playwright"
   },
   "dependencies": {
-    "@nx/devkit": "17.3.0-canary.20240116-42aefd8",
-    "@nx/eslint": "17.3.0-canary.20240116-42aefd8",
-    "@nx/js": "17.3.0-canary.20240116-42aefd8",
+    "@nx/devkit": "17.3.0-canary.20240118-8ccf327",
+    "@nx/eslint": "17.3.0-canary.20240118-8ccf327",
+    "@nx/js": "17.3.0-canary.20240118-8ccf327",
     "tslib": "^2.3.0",
     "minimatch": "3.0.5"
   },

package/src/generators/configuration/configuration.js

@@ -2,14 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 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");
+const child_process_1 = require("child_process");
 const path = require("path");
-const init_1 = require("../init/init");
 const add_linter_1 = require("../../utils/add-linter");
-const versions_1 = require("@nx/js/src/utils/versions");
-const js_1 = require("@nx/js");
+const versions_2 = require("../../utils/versions");
+const init_1 = require("../init/init");
 async function configurationGenerator(tree, options) {
     const tasks = [];
-    tasks.push(await (0, init_1.default)(tree, {
+    tasks.push(await (0, init_1.initGenerator)(tree, {
         skipFormat: true,
         skipPackageJson: options.skipPackageJson,
     }));
@@ -62,12 +64,48 @@ async function configurationGenerator(tree, options) {
         const { ModuleKind } = (0, devkit_1.ensurePackage)('typescript', versions_1.typescriptVersion);
         (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,
+        }));
+    }
+    if (!options.skipInstall) {
+        tasks.push(getBrowsersInstallTask());
+    }
     if (!options.skipFormat) {
         await (0, devkit_1.formatFiles)(tree);
     }
     return (0, devkit_1.runTasksInSerial)(...tasks);
 }
 exports.configurationGenerator = configurationGenerator;
+function getBrowsersInstallTask() {
+    return () => {
+        devkit_1.output.log({
+            title: 'Ensuring Playwright is installed.',
+            bodyLines: ['use --skipInstall to skip installation.'],
+        });
+        const pmc = (0, devkit_1.getPackageManagerCommand)();
+        (0, child_process_1.execSync)(`${pmc.exec} playwright install`, { cwd: devkit_1.workspaceRoot });
+    };
+}
+function recommendVsCodeExtensions(tree) {
+    if (tree.exists('.vscode/extensions.json')) {
+        (0, devkit_1.updateJson)(tree, '.vscode/extensions.json', (json) => {
+            json.recommendations ??= [];
+            const recs = new Set(json.recommendations);
+            recs.add('ms-playwright.playwright');
+            json.recommendations = Array.from(recs);
+            return json;
+        });
+    }
+    else {
+        (0, devkit_1.writeJson)(tree, '.vscode/extensions.json', {
+            recommendations: ['ms-playwright.playwright'],
+        });
+    }
+}
 function setupE2ETargetDefaults(tree) {
     const nxJson = (0, devkit_1.readNxJson)(tree);
     if (!nxJson.namedInputs) {

package/src/generators/configuration/files/playwright.config.ts.template

@@ -1,4 +1,4 @@
-import { defineConfig } from '@playwright/test';
+import { defineConfig, devices } from '@playwright/test';
 import { nxE2EPreset } from '@nx/playwright/preset';
 <% if(!webServerCommand || !webServerAddress) { %>// eslint-disable-next-line @typescript-eslint/no-unused-vars <% } %>
 import { workspaceRoot } from '@nx/devkit';
@@ -35,4 +35,40 @@ export default defineConfig({
   //   reuseExistingServer: !process.env.CI,
   //   cwd: workspaceRoot,
   // },<% } %>
+  projects: [
+    {
+      name: "chromium",
+      use: { ...devices["Desktop Chrome"] },
+    },
+
+    {
+      name: "firefox",
+      use: { ...devices["Desktop Firefox"] },
+    },
+
+    {
+      name: "webkit",
+      use: { ...devices["Desktop Safari"] },
+    },
+    
+    // Uncomment for mobile browsers support
+    /* {
+      name: 'Mobile Chrome',
+      use: { ...devices['Pixel 5'] },
+    },
+    {
+      name: 'Mobile Safari',
+      use: { ...devices['iPhone 12'] },
+    }, */
+
+    // Uncomment for branded browsers
+    /* {
+      name: 'Microsoft Edge',
+      use: { ...devices['Desktop Edge'], channel: 'msedge' },
+    },
+    {
+      name: 'Google Chrome',
+      use: { ...devices['Desktop Chrome'], channel: 'chrome' },
+    } */
+  ],
 });

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

@@ -9,6 +9,7 @@ export interface ConfigurationGeneratorSchema {
   js: boolean; // default is false
   skipFormat: boolean;
   skipPackageJson: boolean;
+  skipInstall?: boolean;
   linter: Linter;
   setParserOptionsProject: boolean; // default is false
   /**

package/src/generators/configuration/schema.json

@@ -62,6 +62,11 @@
       "default": false,
       "hidden": true,
       "x-priority": "internal"
+    },
+    "skipInstall": {
+      "type": "boolean",
+      "description": "Skip running `playwright install`. This is to ensure that playwright browsers are installed.",
+      "default": false
     }
   },
   "required": ["project"]

package/src/generators/init/init.js

@@ -3,46 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.initGenerator = void 0;
 const devkit_1 = require("@nx/devkit");
 const versions_1 = require("../../utils/versions");
-const child_process_1 = require("child_process");
 async function initGenerator(tree, options) {
     const tasks = [];
     if (!options.skipPackageJson) {
         tasks.push((0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
             '@nx/playwright': versions_1.nxVersion,
-            // required since used in playwright config
-            '@nx/devkit': versions_1.nxVersion,
             '@playwright/test': versions_1.playwrightVersion,
-        }));
-    }
-    if (!options.skipFormat) {
-        await (0, devkit_1.formatFiles)(tree);
-    }
-    if (tree.exists('.vscode/extensions.json')) {
-        (0, devkit_1.updateJson)(tree, '.vscode/extensions.json', (json) => {
-            json.recommendations ??= [];
-            const recs = new Set(json.recommendations);
-            recs.add('ms-playwright.playwright');
-            json.recommendations = Array.from(recs);
-            return json;
-        });
-    }
-    else {
-        tree.write('.vscode/extensions.json', JSON.stringify({
-            recommendations: ['ms-playwright.playwright'],
-        }, null, 2));
+        }, undefined, options.keepExistingVersions));
     }
     if (process.env.NX_PCV3 === 'true') {
         addPlugin(tree);
     }
-    if (!options.skipInstall) {
-        tasks.push(() => {
-            devkit_1.output.log({
-                title: 'Ensuring Playwright is installed.',
-                bodyLines: ['use --skipInstall to skip installation.'],
-            });
-            const pmc = (0, devkit_1.getPackageManagerCommand)();
-            (0, child_process_1.execSync)(`${pmc.exec} playwright install`, { cwd: devkit_1.workspaceRoot });
-        });
+    if (!options.skipFormat) {
+        await (0, devkit_1.formatFiles)(tree);
     }
     return (0, devkit_1.runTasksInSerial)(...tasks);
 }

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

@@ -1,5 +1,5 @@
 export interface InitGeneratorSchema {
-  skipFormat: boolean;
-  skipPackageJson: boolean;
-  skipInstall?: boolean;
+  skipFormat?: boolean;
+  skipPackageJson?: boolean;
+  keepExistingVersions?: boolean;
 }

package/src/generators/init/schema.json

@@ -17,9 +17,10 @@
       "description": "Do not add dependencies to `package.json`.",
       "x-priority": "internal"
     },
-    "skipInstall": {
+    "keepExistingVersions": {
       "type": "boolean",
-      "description": "Skip running `playwright install`. This is to ensure that playwright browsers are installed.",
+      "x-priority": "internal",
+      "description": "Keep existing dependencies versions",
       "default": false
     }
   },

package/src/utils/preset.d.ts

@@ -4,16 +4,6 @@ export interface NxPlaywrightOptions {
      * @default './src'
      **/
     testDir?: string;
-    /**
-     * Include Mobile Chome and Mobile Safari browsers in test projects
-     * @default false
-     **/
-    includeMobileBrowsers?: boolean;
-    /**
-     * Include Microsoft Edge and Google Chrome browsers in test projects
-     * @default false
-     **/
-    includeBrandedBrowsers?: boolean;
 }
 /**
  * nx E2E Preset for Playwright
@@ -25,6 +15,7 @@ export interface NxPlaywrightOptions {
  * - chromium
  * - firefox
  * - webkit
+ * These are generated by default.
  *
  * you can easily extend this within your playwright config via spreading the preset
  * @example

package/src/utils/preset.js

@@ -15,6 +15,7 @@ const test_1 = require("@playwright/test");
  * - chromium
  * - firefox
  * - webkit
+ * These are generated by default.
  *
  * you can easily extend this within your playwright config via spreading the preset
  * @example
@@ -34,44 +35,6 @@ function nxE2EPreset(pathToConfig, options) {
     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 projects = [
-        {
-            name: 'chromium',
-            use: { ...test_1.devices['Desktop Chrome'] },
-        },
-        {
-            name: 'firefox',
-            use: { ...test_1.devices['Desktop Firefox'] },
-        },
-        {
-            name: 'webkit',
-            use: { ...test_1.devices['Desktop Safari'] },
-        },
-    ];
-    if (options?.includeMobileBrowsers) {
-        projects.push(...[
-            {
-                name: 'Mobile Chrome',
-                use: { ...test_1.devices['Pixel 5'] },
-            },
-            {
-                name: 'Mobile Safari',
-                use: { ...test_1.devices['iPhone 12'] },
-            },
-        ]);
-    }
-    if (options?.includeBrandedBrowsers) {
-        projects.push(...[
-            {
-                name: 'Microsoft Edge',
-                use: { ...test_1.devices['Desktop Edge'], channel: 'msedge' },
-            },
-            {
-                name: 'Google Chrome',
-                use: { ...test_1.devices['Desktop Chrome'], channel: 'chrome' },
-            },
-        ]);
-    }
     return (0, test_1.defineConfig)({
         testDir: options?.testDir ?? './src',
         outputDir: testResultOuputDir,
@@ -92,7 +55,6 @@ function nxE2EPreset(pathToConfig, options) {
                 },
             ],
         ],
-        projects,
     });
 }
 exports.nxE2EPreset = nxE2EPreset;