@immense/vue-pom-generator 1.0.37 → 1.0.38

package/README.md

@@ -45,6 +45,10 @@ If `generation.playwright.fixtures` is enabled, it also emits:
 
 - `tests/playwright/__generated__/fixtures.g.ts` (generated; do not edit)
 
+Generated fixtures automatically prefer matching handwritten override classes from
+`tests/playwright/pom/overrides/<ClassName>.ts` (or the sibling `overrides/` directory next to
+your configured `generation.playwright.customPoms.dir`).
+
 ### Vite config example
 
 ```ts
@@ -202,6 +206,13 @@ Defaults:
 
 - when `true`: writes `fixtures.g.ts` alongside generated POMs (under `generation.outDir`)
 
+Convention:
+
+- if `tests/playwright/pom/overrides/<ClassName>.ts` exists, the generated fixture for that page/component
+  instantiates the override class instead of the raw generated `Pom.<ClassName>`
+- the override directory is inferred as the sibling `overrides/` directory next to
+  `generation.playwright.customPoms.dir`
+
 ### Vite config example
 
 - `nativeWrappers` describes common wrapper components (e.g. design-system buttons/inputs)

package/RELEASE_NOTES.md

@@ -1,44 +1,51 @@
-● # Release Notes: v1.0.37
+● Now I have enough information to generate the release notes. The main feature is auto-wiring
+  fixture overrides in Playwright test fixtures.
+
+  ```markdown
+  # Release v1.0.38
 
   ## Highlights
 
-  - Added support for external Vue plugin ownership, enabling better plugin architecture
-  extensibility
-  - Stabilized generator plugin refactor with improved plugin handling and configuration
-  - Enhanced build plugin with expanded functionality (72+ lines added)
-  - Refactored test suite with improved coverage and organization
-  - Added automated PR release-notes preview comments to development workflow
+  - Playwright fixtures now automatically detect and use handwritten POM override classes
+  - Override classes in `overrides/<ClassName>.ts` are auto-wired when generating fixtures
+  - Enhanced test coverage for class generation and TypeScript compilation
+  - Updated documentation with fixture override conventions
 
   ## Changes
 
-  ### Plugin System
-  - Added external Vue plugin ownership support for more flexible plugin architecture
-  - Refactored `create-vue-pom-generator-plugins.ts` with 134 lines of improvements
-  - Enhanced `build-plugin.ts` with additional capabilities and refinements
-  - Simplified `dev-plugin.ts` by removing ~34 lines of redundant code
-  - Updated plugin types with new interfaces and type definitions
+  ### Playwright Fixture Generation
+
+  - Fixtures now automatically prefer matching handwritten override classes from the `overrides/`
+  directory
+  - Override directory location is inferred as sibling to `generation.playwright.customPoms.dir`
+  - Generated fixtures import and instantiate override classes when available (e.g.,
+  `tests/playwright/pom/overrides/<ClassName>.ts`)
+  - Added runtime detection of override files via filesystem checks during generation
 
   ### Documentation
-  - Expanded README.md with 30+ lines of additional documentation
+
+  - Added fixture override convention documentation to README
+  - Updated plugin type definitions with fixture override behavior
+  - Documented override directory structure and lookup rules
 
   ### Testing
-  - Restructured `options.test.ts` with 163 lines of changes for better test coverage and clarity
 
-  ### Code Quality
-  - Improved class generation logic
-  - Refined Vue plugin integration points
+  - Expanded `tests/class-generation-coverage.test.ts` with fixture override scenarios
+  - Enhanced `tests/generated-tsc.test.ts` with 75+ additional lines of TypeScript compilation
+  tests
 
   ## Breaking Changes
 
-  None identified.
+  None.
 
   ## Pull Requests Included
 
-  - [#1](https://github.com/immense/vue-pom-generator/pull/1) Add PR release-notes preview
-  comments (@dkattan)
+  - #1 Add PR release-notes preview comments https://github.com/immense/vue-pom-generator/pull/1
+  (by @dkattan)
 
   ## Testing
 
-  Test suite refactored and expanded in `tests/options.test.ts` with improved organization and
-  coverage.
+  Test coverage expanded significantly with new test cases for fixture override auto-wiring and
+  TypeScript compilation validation.
+  ```
 

package/class-generation/index.ts

@@ -321,6 +321,10 @@ export interface GenerateFilesOptions {
    * Default output (when `true`):
    * - `<projectRoot>/<outDir>/fixtures.g.ts`
    *
+   * Convention:
+   * - fixtures automatically prefer matching handwritten override classes from
+   *   `<dirname(customPomDir)>/overrides/<ClassName>.ts` when present
+   *
    * Accepted values:
    * - `true`: enable with defaults
    * - `"path"`: enable and write the fixture file under this directory (resolved relative to projectRoot),
@@ -505,6 +509,7 @@ export async function generateFiles(
       generateFixtures,
       pomOutDir: outDir,
       projectRoot,
+      customPomDir,
     });
     if (fixtureRegistryFile) {
       writeGeneratedFile(fixtureRegistryFile);
@@ -1004,6 +1009,7 @@ function maybeGenerateFixtureRegistry(
     generateFixtures: GenerateFilesOptions["generateFixtures"];
     pomOutDir: string;
     projectRoot?: string;
+    customPomDir?: string;
   },
 ): GeneratedFileOutput | null {
   const { generateFixtures, pomOutDir } = options;
@@ -1030,6 +1036,12 @@ function maybeGenerateFixtureRegistry(
     ? fixtureOutDirRel
     : path.resolve(root, fixtureOutDirRel);
 
+  const customPomDirRel = options.customPomDir ?? "tests/playwright/pom/custom";
+  const customPomDirAbs = path.isAbsolute(customPomDirRel)
+    ? customPomDirRel
+    : path.resolve(root, customPomDirRel);
+  const overridePomDirAbs = path.resolve(path.dirname(customPomDirAbs), "overrides");
+
   // Resolve the directory that contains the POM barrel export (e.g. <root>/pom).
   const pomDirAbs = path.isAbsolute(pomOutDir) ? pomOutDir : path.resolve(root, pomOutDir);
 
@@ -1066,6 +1078,29 @@ function maybeGenerateFixtureRegistry(
     })
     .sort((a, b) => a.localeCompare(b));
 
+  const fixtureClassNames = [...viewClassNames, ...componentClassNames];
+  const overrideCtorEntries = fixtureClassNames
+    .map((name) => {
+      const overrideFilePath = path.join(overridePomDirAbs, `${name}.ts`);
+      if (!fs.existsSync(overrideFilePath))
+        return null;
+
+      return {
+        className: name,
+        localIdentifier: `${name}Override`,
+        importSpecifier: stripExtension(toPosixRelativePath(fixtureOutDirAbs, overrideFilePath)),
+      };
+    })
+    .filter((entry): entry is { className: string; localIdentifier: string; importSpecifier: string } => !!entry);
+  const overrideCtorByClassName = new Map(overrideCtorEntries.map(entry => [entry.className, entry.localIdentifier]));
+  const overrideImports = overrideCtorEntries.length
+    ? `${overrideCtorEntries
+        .map(entry => `import { ${entry.className} as ${entry.localIdentifier} } from "${entry.importSpecifier}";`)
+        .join("\n")}\n\n`
+    : "";
+
+  const fixtureCtorExpression = (name: string) => overrideCtorByClassName.get(name) ?? `Pom.${name}`;
+
   const header = `${eslintSuppressionHeader}/**\n`
     + ` * DO NOT MODIFY BY HAND\n`
     + ` *\n`
@@ -1079,11 +1114,11 @@ function maybeGenerateFixtureRegistry(
   // View POMs implement goTo() directly, so fixtures can be strongly typed without
   // casting/augmenting at runtime.
   const fixturesTypeEntries = viewClassNames
-    .map(name => `  ${lowerFirst(name)}: Pom.${name},`)
+    .map(name => `  ${lowerFirst(name)}: ${fixtureCtorExpression(name)},`)
     .join("\n");
 
   const componentFixturesTypeEntries = componentClassNames
-    .map(name => `  ${lowerFirst(name)}: Pom.${name},`)
+    .map(name => `  ${lowerFirst(name)}: ${fixtureCtorExpression(name)},`)
     .join("\n");
 
   const pomFactoryType = `export type PomConstructor<T> = new (page: PwPage) => T;\n\n`
@@ -1100,7 +1135,8 @@ function maybeGenerateFixtureRegistry(
   }/** Generated Playwright fixtures (typed page objects). */\n\n`
   + `import { expect, test as base } from "@playwright/test";\n`
   + `import type { Page as PwPage } from "@playwright/test";\n`
-  + `import * as Pom from "${pomImport}";\n\n`
+  + `import * as Pom from "${pomImport}";\n`
+  + `${overrideImports}`
   + `export interface PlaywrightOptions {\n`
   + `  animation: Pom.PlaywrightAnimationOptions;\n`
   + `}\n\n`

package/dist/class-generation/index.d.ts

@@ -17,6 +17,10 @@ export interface GenerateFilesOptions {
      * Default output (when `true`):
      * - `<projectRoot>/<outDir>/fixtures.g.ts`
      *
+     * Convention:
+     * - fixtures automatically prefer matching handwritten override classes from
+     *   `<dirname(customPomDir)>/overrides/<ClassName>.ts` when present
+     *
      * Accepted values:
      * - `true`: enable with defaults
      * - `"path"`: enable and write the fixture file under this directory (resolved relative to projectRoot),

package/dist/class-generation/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../class-generation/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,oCAAoC,EAAE,MAAM,sBAAsB,CAAC;AAE5E,OAAO,EAAE,sBAAsB,EAAoE,MAAM,UAAU,CAAC;AAQpH,OAAO,EAAE,oCAAoC,EAAE,CAAC;AA8ChD,UAAU,SAAS;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAuPD,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;;OAWG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAE1D;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;OAOG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhD;;;;;OAKG;IACH,oCAAoC,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAEzD;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC;QAC3B,SAAS,EAAE,MAAM,CAAC;QAClB,YAAY,EAAE,MAAM,CAAC;QACrB,wBAAwB,EAAE,MAAM,EAAE,CAAC;QAEnC;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,YAAY,GAAG,MAAM,CAAC;KAC5C,CAAC,CAAC;IAEH,yEAAyE;IACzE,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,uDAAuD;IACvD,aAAa,CAAC,EAAE,KAAK,CAAC,IAAI,GAAG,QAAQ,CAAC,CAAC;IAEvC,6BAA6B;IAC7B,MAAM,CAAC,EAAE;QACP,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IAEF,6EAA6E;IAC7E,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC,2FAA2F;IAC3F,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,mDAAmD;IACnD,UAAU,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC;IAEnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CAClD;AAwCD,wBAAsB,aAAa,CACjC,qBAAqB,EAAE,GAAG,CAAC,MAAM,EAAE,sBAAsB,CAAC,EAC1D,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EACpC,iBAAiB,EAAE,MAAM,EACzB,OAAO,GAAE,oBAAyB,iBAkFnC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../class-generation/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,oCAAoC,EAAE,MAAM,sBAAsB,CAAC;AAE5E,OAAO,EAAE,sBAAsB,EAAoE,MAAM,UAAU,CAAC;AAQpH,OAAO,EAAE,oCAAoC,EAAE,CAAC;AA8ChD,UAAU,SAAS;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAuPD,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAE1D;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;OAOG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhD;;;;;OAKG;IACH,oCAAoC,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAEzD;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC;QAC3B,SAAS,EAAE,MAAM,CAAC;QAClB,YAAY,EAAE,MAAM,CAAC;QACrB,wBAAwB,EAAE,MAAM,EAAE,CAAC;QAEnC;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,YAAY,GAAG,MAAM,CAAC;KAC5C,CAAC,CAAC;IAEH,yEAAyE;IACzE,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,uDAAuD;IACvD,aAAa,CAAC,EAAE,KAAK,CAAC,IAAI,GAAG,QAAQ,CAAC,CAAC;IAEvC,6BAA6B;IAC7B,MAAM,CAAC,EAAE;QACP,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IAEF,6EAA6E;IAC7E,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC,2FAA2F;IAC3F,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,mDAAmD;IACnD,UAAU,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC;IAEnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CAClD;AAwCD,wBAAsB,aAAa,CACjC,qBAAqB,EAAE,GAAG,CAAC,MAAM,EAAE,sBAAsB,CAAC,EAC1D,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EACpC,iBAAiB,EAAE,MAAM,EACzB,OAAO,GAAE,oBAAyB,iBAmFnC"}

package/dist/index.cjs

@@ -3519,7 +3519,8 @@ async function generateFiles(componentHierarchyMap, vueFilesPathMap, basePageCla
     const fixtureRegistryFile = maybeGenerateFixtureRegistry(componentHierarchyMap, {
       generateFixtures,
       pomOutDir: outDir,
-      projectRoot
+      projectRoot,
+      customPomDir
     });
     if (fixtureRegistryFile) {
       writeGeneratedFile(fixtureRegistryFile);
@@ -3918,6 +3919,9 @@ function maybeGenerateFixtureRegistry(componentHierarchyMap, options) {
   const fixtureFileName = looksLikeFilePath ? path.basename(fixtureOutRel) : "fixtures.g.ts";
   const root = options.projectRoot ?? process.cwd();
   const fixtureOutDirAbs = path.isAbsolute(fixtureOutDirRel) ? fixtureOutDirRel : path.resolve(root, fixtureOutDirRel);
+  const customPomDirRel = options.customPomDir ?? "tests/playwright/pom/custom";
+  const customPomDirAbs = path.isAbsolute(customPomDirRel) ? customPomDirRel : path.resolve(root, customPomDirRel);
+  const overridePomDirAbs = path.resolve(path.dirname(customPomDirAbs), "overrides");
   const pomDirAbs = path.isAbsolute(pomOutDir) ? pomOutDir : path.resolve(root, pomOutDir);
   const pomImport = toPosixRelativePath(fixtureOutDirAbs, pomDirAbs);
   const viewClassNames = Array.from(componentHierarchyMap.entries()).filter(([, deps]) => !!deps.isView).map(([name]) => name).sort((a, b) => a.localeCompare(b));
@@ -3940,6 +3944,22 @@ function maybeGenerateFixtureRegistry(componentHierarchyMap, options) {
       return false;
     return true;
   }).sort((a, b) => a.localeCompare(b));
+  const fixtureClassNames = [...viewClassNames, ...componentClassNames];
+  const overrideCtorEntries = fixtureClassNames.map((name) => {
+    const overrideFilePath = path.join(overridePomDirAbs, `${name}.ts`);
+    if (!fs.existsSync(overrideFilePath))
+      return null;
+    return {
+      className: name,
+      localIdentifier: `${name}Override`,
+      importSpecifier: stripExtension(toPosixRelativePath(fixtureOutDirAbs, overrideFilePath))
+    };
+  }).filter((entry) => !!entry);
+  const overrideCtorByClassName = new Map(overrideCtorEntries.map((entry) => [entry.className, entry.localIdentifier]));
+  const overrideImports = overrideCtorEntries.length ? `${overrideCtorEntries.map((entry) => `import { ${entry.className} as ${entry.localIdentifier} } from "${entry.importSpecifier}";`).join("\n")}
+
+` : "";
+  const fixtureCtorExpression = (name) => overrideCtorByClassName.get(name) ?? `Pom.${name}`;
   const header = `${eslintSuppressionHeader}/**
  * DO NOT MODIFY BY HAND
  *
@@ -3948,8 +3968,8 @@ function maybeGenerateFixtureRegistry(componentHierarchyMap, options) {
  */
 
 `;
-  const fixturesTypeEntries = viewClassNames.map((name) => `  ${lowerFirst(name)}: Pom.${name},`).join("\n");
-  const componentFixturesTypeEntries = componentClassNames.map((name) => `  ${lowerFirst(name)}: Pom.${name},`).join("\n");
+  const fixturesTypeEntries = viewClassNames.map((name) => `  ${lowerFirst(name)}: ${fixtureCtorExpression(name)},`).join("\n");
+  const componentFixturesTypeEntries = componentClassNames.map((name) => `  ${lowerFirst(name)}: ${fixtureCtorExpression(name)},`).join("\n");
   const pomFactoryType = `export type PomConstructor<T> = new (page: PwPage) => T;
 
 export interface PomFactory {
@@ -3962,8 +3982,7 @@ export interface PomFactory {
 import { expect, test as base } from "@playwright/test";
 import type { Page as PwPage } from "@playwright/test";
 import * as Pom from "${pomImport}";
-
-export interface PlaywrightOptions {
+${overrideImports}export interface PlaywrightOptions {
   animation: Pom.PlaywrightAnimationOptions;
 }