@nx/playwright 0.0.0-pr-22179-271588f

package/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2017-2023 Narwhal Technologies Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,66 @@
+<p style="text-align: center;">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-dark.svg">
+    <img alt="Nx - Smart Monorepos · Fast CI" src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-light.svg" width="100%">
+  </picture>
+</p>
+
+<div style="text-align: center;">
+
+[![CircleCI](https://circleci.com/gh/nrwl/nx.svg?style=svg)](https://circleci.com/gh/nrwl/nx)
+[![License](https://img.shields.io/npm/l/@nx/workspace.svg?style=flat-square)]()
+[![NPM Version](https://badge.fury.io/js/%40nrwl%2Fworkspace.svg)](https://www.npmjs.com/@nx/workspace)
+[![Semantic Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)]()
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+[![Join the chat at https://gitter.im/nrwl-nx/community](https://badges.gitter.im/nrwl-nx/community.svg)](https://gitter.im/nrwl-nx/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Join us on the Official Nx Discord Server](https://img.shields.io/discord/1143497901675401286?label=discord)](https://go.nx.dev/community)
+
+</div>
+
+
+<hr>
+
+# Nx: Smart Monorepos · Fast CI
+
+Nx is a build system with built-in tooling and advanced CI capabilities. It helps you maintain and scale monorepos, both locally and on CI.
+
+## Getting Started
+
+### Creating an Nx Workspace
+
+**Using `npx`**
+
+```bash
+npx create-nx-workspace
+```
+
+**Using `npm init`**
+
+```bash
+npm init nx-workspace
+```
+
+**Using `yarn create`**
+
+```bash
+yarn create nx-workspace
+```
+
+### Adding Nx to an Existing Repository
+
+Run:
+
+```bash
+npx nx@latest init
+```
+
+## Documentation & Resources
+
+- [Nx.Dev: Documentation, Guides, Tutorials](https://nx.dev)
+- [Intro to Nx](https://nx.dev/getting-started/intro)
+- [Official Nx YouTube Channel](https://www.youtube.com/@NxDevtools)
+- [Blog Posts About Nx](https://blog.nrwl.io/nx/home)
+
+<p style="text-align: center;"><a href="https://nx.dev/#learning-materials" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-courses-and-videos.svg" 
+width="100%" alt="Nx - Smart Monorepos · Fast CI"></a></p>
+

package/executors.json

@@ -0,0 +1,9 @@
+{
+  "executors": {
+    "playwright": {
+      "implementation": "./src/executors/playwright/playwright.impl",
+      "schema": "./src/executors/playwright/schema.json",
+      "description": "Run Playwright tests."
+    }
+  }
+}

package/generators.json

@@ -0,0 +1,16 @@
+{
+  "name": "Nx Playwright",
+  "version": "0.1",
+  "generators": {
+    "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#initGeneratorInternal",
+      "schema": "./src/generators/init/schema.json",
+      "description": "Initializes a Playwright project in the current workspace"
+    }
+  }
+}

package/index.d.ts

@@ -0,0 +1,3 @@
+export { playwrightExecutor, PlaywrightExecutorSchema, } from './src/executors/playwright/playwright.impl';
+export { initGenerator } from './src/generators/init/init';
+export { configurationGenerator } from './src/generators/configuration/configuration';

package/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configurationGenerator = exports.initGenerator = exports.playwrightExecutor = void 0;
+var playwright_impl_1 = require("./src/executors/playwright/playwright.impl");
+Object.defineProperty(exports, "playwrightExecutor", { enumerable: true, get: function () { return playwright_impl_1.playwrightExecutor; } });
+var init_1 = require("./src/generators/init/init");
+Object.defineProperty(exports, "initGenerator", { enumerable: true, get: function () { return init_1.initGenerator; } });
+var configuration_1 = require("./src/generators/configuration/configuration");
+Object.defineProperty(exports, "configurationGenerator", { enumerable: true, get: function () { return configuration_1.configurationGenerator; } });

package/migrations.json

@@ -0,0 +1,16 @@
+{
+  "generators": {
+    "17-3-1-add-project-to-config": {
+      "cli": "nx",
+      "version": "17.3.1-beta.0",
+      "description": "Add project property to playwright config",
+      "implementation": "./src/migrations/update-17-3-1/add-project-to-config"
+    },
+    "18-1-0-remove-baseUrl-from-project-json": {
+      "cli": "nx",
+      "version": "18.1.0-beta.3",
+      "description": "Remove invalid baseUrl option from @nx/playwright:playwright targets in project.json.",
+      "implementation": "./src/migrations/update-18-1-0/remove-baseUrl-from-project-json"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@nx/playwright",
+  "version": "0.0.0-pr-22179-271588f",
+  "type": "commonjs",
+  "homepage": "https://nx.dev",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "The Nx Plugin for Playwright contains executors and generators allowing your workspace to use the powerful Playwright integration testing capabilities.",
+  "keywords": [
+    "Monorepo",
+    "Angular",
+    "React",
+    "Web",
+    "Node",
+    "Nest",
+    "Jest",
+    "Playwright",
+    "CLI"
+  ],
+  "main": "./index.js",
+  "typings": "./index.d.ts",
+  "author": "Victor Savkin",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/nrwl/nx/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nrwl/nx.git",
+    "directory": "packages/playwright"
+  },
+  "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",
+    "tslib": "^2.3.0",
+    "minimatch": "9.0.3"
+  },
+  "peerDependencies": {
+    "@playwright/test": "^1.36.0"
+  },
+  "peerDependenciesMeta": {
+    "@playwright/test": {
+      "optional": true
+    }
+  },
+  "executors": "./executors.json",
+  "generators": "./generators.json",
+  "exports": {
+    ".": "./index.js",
+    "./package.json": "./package.json",
+    "./migrations.json": "./migrations.json",
+    "./generators.json": "./generators.json",
+    "./generators/*/schema.json": "./src/generators/*/schema.json",
+    "./executors.json": "./executors.json",
+    "./executors/*/schema.json": "./src/executors/*/schema.json",
+    "./plugin": "./plugin.js",
+    "./preset": "./src/utils/preset.js"
+  },
+  "nx-migrations": {
+    "migrations": "./migrations.json"
+  }
+}

package/plugin.d.ts

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

package/plugin.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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/preset.d.ts

@@ -0,0 +1 @@
+export * from './src/utils/preset';

package/preset.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./src/utils/preset"), exports);

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

@@ -0,0 +1,37 @@
+import { ExecutorContext } from '@nx/devkit';
+export interface PlaywrightExecutorSchema {
+    browser?: 'all' | 'chromium' | 'firefox' | 'webkit' | string;
+    config?: string;
+    debug?: boolean;
+    forbidOnly?: boolean;
+    fullyParallel?: boolean;
+    grep?: string;
+    globalTimeout?: number;
+    grepInvert?: string;
+    testFiles?: string[];
+    headed?: boolean;
+    ignoreSnapshots?: boolean;
+    workers?: string;
+    list?: boolean;
+    maxFailures?: number | boolean;
+    noDeps?: boolean;
+    output?: string;
+    passWithNoTests?: boolean;
+    project?: string[];
+    quiet?: boolean;
+    repeatEach?: number;
+    reporter?: 'list' | 'line' | 'dot' | 'json' | 'junit' | 'null' | 'github' | 'html' | 'blob';
+    retries?: number;
+    shard?: string;
+    timeout?: number;
+    trace?: 'on' | 'off' | 'on-first-retry' | 'on-all-retries' | 'retain-on-failure';
+    updateSnapshots?: boolean;
+    ui?: boolean;
+    uiHost?: string;
+    uiPort?: string;
+    skipInstall?: boolean;
+}
+export declare function playwrightExecutor(options: PlaywrightExecutorSchema, context: ExecutorContext): Promise<{
+    success: boolean;
+}>;
+export default playwrightExecutor;

package/src/executors/playwright/playwright.impl.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.playwrightExecutor = void 0;
+const child_process_1 = require("child_process");
+const devkit_1 = require("@nx/devkit");
+async function playwrightExecutor(options, context) {
+    const projectRoot = context.projectGraph?.nodes?.[context?.projectName]?.data?.root;
+    if (!projectRoot) {
+        throw new Error(`Unable to find the Project Root for ${context.projectName}. Is it set in the project.json?`);
+    }
+    if (!options.skipInstall) {
+        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,
+            stdio: 'inherit',
+        });
+    }
+    const args = createArgs(options);
+    const p = runPlaywright(args, context.root);
+    p.stdout.on('data', (message) => {
+        process.stdout.write(message);
+    });
+    p.stderr.on('data', (message) => {
+        process.stderr.write(message);
+    });
+    return new Promise((resolve) => {
+        p.on('close', (code) => {
+            resolve({ success: code === 0 });
+        });
+    });
+}
+exports.playwrightExecutor = playwrightExecutor;
+function createArgs(opts, exclude = ['skipInstall']) {
+    const args = [];
+    const { testFiles, ...rest } = opts;
+    if (testFiles) {
+        args.push(...testFiles);
+    }
+    for (const key in rest) {
+        if (exclude.includes(key))
+            continue;
+        const value = opts[key];
+        // NOTE: playwright doesn't accept pascalCase args, only kebab-case
+        const arg = (0, devkit_1.names)(key).fileName;
+        if (Array.isArray(value)) {
+            args.push(...value.map((v) => `--${arg}=${v.trim()}`));
+        }
+        else if (typeof value === 'boolean') {
+            // NOTE: playwright don't accept --arg=false, instead just don't pass the arg.
+            if (value) {
+                args.push(`--${arg}`);
+            }
+        }
+        else {
+            args.push(`--${arg}=${value}`);
+        }
+    }
+    return args;
+}
+function runPlaywright(args, cwd) {
+    try {
+        const cli = require.resolve('@playwright/test/cli');
+        return (0, child_process_1.fork)(cli, ['test', ...args], {
+            stdio: ['pipe', 'pipe', 'pipe', 'ipc'],
+            cwd,
+        });
+    }
+    catch (e) {
+        console.error(e);
+        throw new Error('Unable to run playwright. Is @playwright/test installed?');
+    }
+}
+exports.default = playwrightExecutor;

package/src/executors/playwright/schema.json

@@ -0,0 +1,168 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "version": 2,
+  "title": "Playwright executor",
+  "description": "Run Playwright tests.",
+  "type": "object",
+  "properties": {
+    "browser": {
+      "type": "string",
+      "description": "Browser to use for tests, one of 'all', 'chromium', 'firefox' or 'webkit'. If a playwright config is provided/discovered then the browserName value is expected from the configured 'projects'",
+      "x-priority": "important"
+    },
+    "config": {
+      "type": "string",
+      "description": "Configuration file, or a test directory with optional",
+      "x-completion-type": "file",
+      "x-completion-glob": "playwright?(*)@(.js|.cjs|.mjs|.ts|.cts|.mtx)",
+      "x-priority": "important"
+    },
+    "debug": {
+      "type": "boolean",
+      "description": "Run tests with Playwright Inspector. Shortcut for 'PWDEBUG=1' environment variable and '--timeout=0',--max-failures=1 --headed --workers=1' options"
+    },
+    "forbidOnly": {
+      "type": "boolean",
+      "description": "Fail if test.only is called"
+    },
+    "fullyParallel": {
+      "type": "boolean",
+      "description": "Run all tests in parallel"
+    },
+    "grep": {
+      "alias": "g",
+      "type": "string",
+      "description": "Only run tests matching this regular expression"
+    },
+    "globalTimeout": {
+      "type": "number",
+      "description": "Maximum time this test suite can run in milliseconds"
+    },
+    "grepInvert": {
+      "alias": "gv",
+      "type": "string",
+      "description": "Only run tests that do not match this regular expression"
+    },
+    "testFiles": {
+      "alias": "t",
+      "type": "array",
+      "description": "Test files to run",
+      "items": {
+        "type": "string"
+      }
+    },
+    "headed": {
+      "type": "boolean",
+      "description": "Run tests in headed browsers",
+      "x-priority": "important"
+    },
+    "ignoreSnapshots": {
+      "type": "boolean",
+      "description": "Ignore screenshot and snapshot expectations"
+    },
+    "workers": {
+      "alias": "j",
+      "type": "string",
+      "description": "Number of concurrent workers or percentage of logical CPU cores, use 1 to run in a single worker"
+    },
+    "list": {
+      "type": "boolean",
+      "description": "Collect all the tests and report them, but do not run"
+    },
+    "maxFailures": {
+      "alias": "x",
+      "oneOf": [{ "type": "number" }, { "type": "boolean" }],
+      "description": "Stop after the first N failures"
+    },
+    "noDeps": {
+      "type": "boolean",
+      "description": "Do not run project dependencies"
+    },
+    "output": {
+      "type": "string",
+      "description": "Folder for output artifacts"
+    },
+    "passWithNoTests": {
+      "type": "boolean",
+      "description": "Makes test run succeed even if no tests were found",
+      "default": true
+    },
+    "project": {
+      "description": "Only run tests from the specified list of projects",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "quiet": {
+      "alias": "q",
+      "type": "boolean",
+      "description": "Suppress stdio"
+    },
+    "repeatEach": {
+      "type": "number",
+      "description": "Run each test N times"
+    },
+    "reporter": {
+      "type": "string",
+      "enum": [
+        "list",
+        "line",
+        "dot",
+        "json",
+        "junit",
+        "null",
+        "github",
+        "html",
+        "blob"
+      ],
+      "description": "Reporter to use, comma-separated, can be 'list', 'line', 'dot', 'json', 'junit', 'null', 'github', 'html', 'blob'. To configure reporter options, use the playwright configuration."
+    },
+    "retries": {
+      "type": "number",
+      "description": "Maximum retry count for flaky tests, zero for no retries"
+    },
+    "shard": {
+      "type": "string",
+      "description": "Shard tests and execute only the selected shard, specify in the form 'current/all', 1-based, for example '3/5'"
+    },
+    "timeout": {
+      "type": "number",
+      "description": "Specify test timeout threshold in milliseconds, zero for unlimited"
+    },
+    "trace": {
+      "type": "string",
+      "enum": [
+        "on",
+        "off",
+        "on-first-retry",
+        "on-all-retries",
+        "retain-on-failure"
+      ],
+      "description": "Force tracing mode, can be 'on', 'off', 'on-first-retry', 'on-all-retries', 'retain-on-failure'"
+    },
+    "updateSnapshots": {
+      "alias": "u",
+      "type": "boolean",
+      "description": "Update snapshots with actual results. Snapshots will be created if missing."
+    },
+    "ui": {
+      "type": "boolean",
+      "description": "Run tests in interactive UI mode"
+    },
+    "uiHost": {
+      "type": "string",
+      "description": "Host to serve UI on; specifying this option opens UI in a browser tab"
+    },
+    "uiPort": {
+      "type": "string",
+      "description": "Port to serve UI on, 0 for any free port; specifying this option opens UI in a browser tab"
+    },
+    "skipInstall": {
+      "type": "boolean",
+      "description": "Skip running playwright install before running playwright tests. This is to ensure that playwright browsers are installed before running tests.",
+      "default": false
+    }
+  },
+  "required": []
+}

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

@@ -0,0 +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;