@trackunit/iris-app-playwright 0.1.39 → 0.2.2

package/README.md

@@ -33,7 +33,7 @@ This creates:
 - `playwright/support/fixtures.ts` — re-exports `test`, `expect`, and `describe`
 - `playwright/fixtures/auth.json` — fill in credentials
 - `playwright/tests/app.spec.ts` — sample login spec
-- `e2e-pw` and `e2e-pw-ui` targets in `project.json`
+- `e2e` and `e2e-ui` targets in `project.json`
 
 ### 2. Fill in credentials
 
@@ -64,10 +64,10 @@ describe("My Feature", () => {
 
 ```bash
 # Against dev environment (headless)
-yarn nx run my-app:e2e-pw --configuration=dev
+yarn nx run my-app:e2e --configuration=dev
 
 # Interactive UI mode
-yarn nx run my-app:e2e-pw-ui --configuration=local
+yarn nx run my-app:e2e-ui --configuration=local
 ```
 
 > **Outside the devcontainer:** Playwright browser binaries are not bundled. Run
@@ -193,7 +193,7 @@ Defaults to Playwright's behaviour (`undefined`, project-level setting wins). Se
 Set the `codeowner` environment variable to append a `[team-name]` suffix to all describe titles in the test report:
 
 ```bash
-codeowner=team-gluon-fe yarn nx run my-app:e2e-pw --configuration=dev
+codeowner=team-gluon-fe yarn nx run my-app:e2e --configuration=dev
 ```
 
 Use the `describe` wrapper exported from `@trackunit/iris-app-playwright/support` (not Playwright's built-in `test.describe`) to get this behaviour.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/iris-app-playwright",
-  "version": "0.1.39",
+  "version": "0.2.2",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "generators": "./generators.json",

package/src/generators/playwright-configuration/generator.js

@@ -2,6 +2,33 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.playwrightConfigurationGenerator = playwrightConfigurationGenerator;
 const devkit_1 = require("@nx/devkit");
+const PLAYWRIGHT_TSCONFIG_REFERENCE = "./playwright/tsconfig.json";
+/**
+ * Registers the scaffolded `playwright/tsconfig.json` as a project reference in the
+ * project's root `tsconfig.json`. Without this, the playwright tsconfig is orphaned:
+ * a solution-style root tsconfig only type-checks what it references, so editors and
+ * `tsc-validate` never pick up the spec files.
+ *
+ * No-ops when the project has no root `tsconfig.json`, or when the reference is already
+ * present (so re-runs stay idempotent).
+ */
+function addPlaywrightTsConfigReference(tree, projectRoot) {
+    const tsConfigPath = (0, devkit_1.joinPathFragments)(projectRoot, "tsconfig.json");
+    if (!tree.exists(tsConfigPath)) {
+        return;
+    }
+    (0, devkit_1.updateJson)(tree, tsConfigPath, tsConfig => {
+        const references = tsConfig.references ?? [];
+        const alreadyReferenced = references.some(reference => reference.path === PLAYWRIGHT_TSCONFIG_REFERENCE);
+        if (alreadyReferenced) {
+            return tsConfig;
+        }
+        return {
+            ...tsConfig,
+            references: [...references, { path: PLAYWRIGHT_TSCONFIG_REFERENCE }],
+        };
+    });
+}
 /**
  * Generates Playwright E2E test configuration for an existing project.
  *
@@ -47,7 +74,7 @@ async function playwrightConfigurationGenerator(tree, options) {
         ...existingProjectConfig,
         targets: {
             ...existingProjectConfig.targets,
-            "e2e-pw-ui": {
+            "e2e-ui": {
                 executor: "nx:run-commands",
                 options: {
                     command: `playwright test --config=playwright.config.ts --headed --ui`,
@@ -55,7 +82,7 @@ async function playwrightConfigurationGenerator(tree, options) {
                 },
                 configurations,
             },
-            "e2e-pw": {
+            e2e: {
                 executor: "nx:run-commands",
                 options: {
                     command: `playwright test --config=playwright.config.ts`,
@@ -69,9 +96,13 @@ async function playwrightConfigurationGenerator(tree, options) {
         ...options,
         tmpl: "",
     });
+    addPlaywrightTsConfigReference(tree, projectRoot);
     await (0, devkit_1.formatFiles)(tree);
     return () => {
-        devkit_1.logger.info(`\n\n\n✅ 🚀 Please open this file to get started\n${(0, devkit_1.joinPathFragments)(projectRoot, "playwright/tests/app.spec.ts")}`);
+        devkit_1.logger.info(`\n\n✅ 🚀 \nPlease update credentials in: 
+  ${(0, devkit_1.joinPathFragments)(projectRoot, "playwright/fixtures/auth.json")}
+and open this file to get started writing tests:
+  ${(0, devkit_1.joinPathFragments)(projectRoot, "playwright/tests/app.spec.ts")}`);
     };
 }
 //# sourceMappingURL=generator.js.map