@immense/vue-pom-generator 1.0.65 → 1.0.67

package/AGENTS.md

@@ -28,6 +28,27 @@ Stop and ask for guidance instead of implementing a fallback. Explain:
 - which consumers/call sites are affected,
 - and what the clean breaking change would look like.
 
+## Local source wiring into a consumer app
+
+When testing `vue-pom-generator` from a local checkout, do **not** import `../vue-pom-generator/index.ts` directly from the consumer's Vite config.
+That pulls in this repo's source-level TypeScript types and its own `vite` dependency tree, which causes avoidable type/runtime mismatches.
+
+Use this flow instead:
+
+1. Build this repo first:
+   - `cd /path/to/vue-pom-generator`
+   - `npm run build`
+2. In the consumer app's `package.json`, point the dependency at the local checkout:
+   - `"@immense/vue-pom-generator": "file:../../../vue-pom-generator"`
+   - adjust the relative path for that consumer repo
+3. Keep imports by package name:
+   - `import { defineVuePomGeneratorConfig, vuePomGenerator } from "@immense/vue-pom-generator";`
+4. Reinstall in the consumer:
+   - `npm install`
+5. If the consumer has type friction around `PluginOption[]`, prefer a local cast in the consumer helper rather than importing this repo's TS source directly.
+
+Short version: **build here, use a `file:` dependency there, keep package-name imports.**
+
 ## Scope
 
 These rules apply to:

package/README.md

@@ -625,6 +625,7 @@ Current caveats:
 - there are no generated `openXPage` helpers; tests call `goTo()` explicitly when available
 - override preference only affects fixture construction
 - component fixtures are skipped when their lower-camel-case name would collide with reserved Playwright fixture names such as `page`, `context`, `browser`, or `request`
+- generic wrapper-only component fallbacks whose best standalone name is just their wrapper class are skipped so parent views/components keep the more meaningful handler-derived API
 - an override class still needs a `new (page)`-compatible constructor because that is what fixtures call
 
 By default the runtime uses a simple red fallback bubble. The example below uses the optional floating-ui renderer so the callout can auto-place around nearby UI and point back to the target with an arrow.

package/RELEASE_NOTES.md

@@ -1,31 +1,94 @@
-● ## v1.0.65
+● ## Highlights
 
-  ### Highlights
+  - **Runtime annotator metadata** – New runtime metadata collection and annotation capabilities
+  for enhanced POM generation
+  - **Accessibility audit warnings** – Automatic detection and reporting of accessibility issues
+  in Vue components
+  - **Manifest and locator descriptions** – Human-readable descriptions for generated test
+  locators and manifests
+  - **Zero runtime dependencies** – All runtime dependencies eliminated for smaller bundle size
+  and fewer supply-chain risks
+  - **Build–serve parity** – Dev mode POM generation now matches build mode behavior with
+  comprehensive regression tests
 
-  - Fixed parsing of guarded handler expressions (e.g., `@click="condition && handler"`)
-  - Improved semantic name resolution for wrapped and conditional event handlers
-  - Enhanced Vue compiler AST traversal to handle logical expressions (`&&` operators)
+  ## Changes
 
-  ### Changes
+  **Features**
+  - Add runtime annotator metadata with Vue component detection (#27)
+  - Add accessibility audit metadata and warnings (#25)
+  - Add manifest and locator descriptions (#24)
+  - Add split Playwright POM output for improved discoverability (#12)
+  - Fail fast on unnameable wrapper handlers (#11)
 
-  **Parser Improvements**
-  - Added support for `LogicalExpression` nodes in handler attribute parsing
-  - Introduced `unwrapSemanticHelperCall` to handle Vue compiler helpers (`_unref`,
-  `_withModifiers`, etc.)
-  - Refactored `resolveSemanticName` to recursively unwrap nested expressions and guarded calls
-  - Handler names now correctly extracted from conditional expressions like `isValid &&
-  submitForm`
+  **Fixes**
+  - Parse TypeScript template expressions + allow submit-button fallback (#20)
+  - Avoid reparsing generated test IDs (#21)
+  - Harden local app integration (#19)
+  - Restore router DOM globals after introspection (#18)
+  - Support awaited handler wrappers (#17)
+  - Resolve Nuxt app-root dev POM clobber (#15)
+  - Guard manual releases (#16)
+  - Fail fast on dev snapshot generation errors (#6)
+  - Dev-mode POM generation parity with build mode (#5)
+  - Fix keyed POM dedupe and C# navigation returns (#4)
 
-  **Testing**
-  - Added test coverage for guarded handler scenarios
-  - Updated transform and utils test suites to validate new parsing logic
+  **Refactoring**
+  - Eliminate all runtime dependencies (#9)
+  - Rename `plugin/support` → `plugin/internal` (internal restructuring)
 
-  ### Pull Requests Included
+  **Dependencies**
+  - Relax Vite peer dependency range (#13)
 
-  No pull request was created for this fix; it was committed directly to `main`.
+  **Developer Experience**
+  - Add PR release-notes preview comments (#1)
 
-  ### Testing
+  ## Breaking Changes
 
-  Validated with expanded unit test coverage in `tests/transform.test.ts` and
-  `tests/utils-coverage.test.ts`.
+  - Internal plugin structure reorganized: `plugin/support-plugins.ts` →
+  `plugin/internal-plugins.ts` and `plugin/support/*` → `plugin/internal/*`. This should not
+  affect public API users.
+
+  ## Pull Requests Included
+
+  - #27 feat: add runtime annotator metadata
+  (https://github.com/immense/vue-pom-generator/pull/27)
+  - #25 feat: add accessibility audit metadata and warnings
+  (https://github.com/immense/vue-pom-generator/pull/25)
+  - #24 feat: add manifest and locator descriptions
+  (https://github.com/immense/vue-pom-generator/pull/24)
+  - #21 fix: avoid reparsing generated test ids
+  (https://github.com/immense/vue-pom-generator/pull/21)
+  - #20 fix: parse TypeScript template expressions + allow submit-button fallback
+  (https://github.com/immense/vue-pom-generator/pull/20)
+  - #19 fix: harden local app integration (https://github.com/immense/vue-pom-generator/pull/19)
+  - #18 fix: restore router DOM globals after introspection
+  (https://github.com/immense/vue-pom-generator/pull/18)
+  - #17 fix: support awaited handler wrappers
+  (https://github.com/immense/vue-pom-generator/pull/17)
+  - #16 fix: guard manual releases (https://github.com/immense/vue-pom-generator/pull/16)
+  - #15 fix: resolve Nuxt app-root dev POM clobber
+  (https://github.com/immense/vue-pom-generator/pull/15)
+  - #13 Relax Vite peer dependency range (https://github.com/immense/vue-pom-generator/pull/13)
+  - #12 feat: add split Playwright POM output for discoverability
+  (https://github.com/immense/vue-pom-generator/pull/12)
+  - #11 feat: fail fast on unnameable wrapper handlers
+  (https://github.com/immense/vue-pom-generator/pull/11)
+  - #9 refactor(deps): eliminate all runtime dependencies
+  (https://github.com/immense/vue-pom-generator/pull/9)
+  - #8 chore: bump version to 1.0.43 (https://github.com/immense/vue-pom-generator/pull/8)
+  - #7 test: add build–serve parity regression tests
+  (https://github.com/immense/vue-pom-generator/pull/7)
+  - #6 fix: fail fast on dev snapshot generation errors
+  (https://github.com/immense/vue-pom-generator/pull/6)
+  - #5 fix: dev-mode POM generation parity with build mode
+  (https://github.com/immense/vue-pom-generator/pull/5)
+  - #4 Fix keyed POM dedupe and C# navigation returns
+  (https://github.com/immense/vue-pom-generator/pull/4)
+  - #1 Add PR release-notes preview comments (https://github.com/immense/vue-pom-generator/pull/1)
+
+  ## Testing
+
+  Comprehensive test coverage added including build–serve parity regression tests (#7), class
+  generation coverage tests, generated TypeScript compilation tests, and virtual test ID tests.
+  All new features and fixes include corresponding test coverage.
 

package/class-generation/index.ts

@@ -54,6 +54,7 @@ import {
   PomExtraClickMethodSpec,
   PomPrimarySpec,
   PomSelectorSpec,
+  shouldSuppressStandaloneWrapperFallbackSurface,
   toPascalCase,
   upperFirst,
 } from "../utils";
@@ -663,6 +664,11 @@ export async function generateFiles(
         layoutDirs,
       })
       : undefined);
+  const emittableComponentHierarchyMap = new Map(
+    Array.from(componentHierarchyMap.entries()).filter(([componentName, dependencies]) => {
+      return !shouldSuppressStandaloneWrapperFallbackSurface(componentName, dependencies);
+    }),
+  );
   const generatedFilePaths: string[] = [];
   const writeGeneratedFile = (file: GeneratedFileOutput) => {
     const resolvedFilePath = path.resolve(file.filePath);
@@ -672,7 +678,7 @@ export async function generateFiles(
 
   if (emitLanguages.includes("ts")) {
     const files = typescriptOutputStructure === "split"
-      ? await generateSplitTypeScriptFiles(componentHierarchyMap, vueFilesPathMap, basePageClassPath, outDir, {
+      ? await generateSplitTypeScriptFiles(emittableComponentHierarchyMap, vueFilesPathMap, basePageClassPath, outDir, {
         customPomAttachments,
         projectRoot,
         customPomDir,
@@ -683,7 +689,7 @@ export async function generateFiles(
         routeMetaByComponent,
         vueRouterFluentChaining,
       })
-      : await generateAggregatedFiles(componentHierarchyMap, vueFilesPathMap, basePageClassPath, outDir, {
+      : await generateAggregatedFiles(emittableComponentHierarchyMap, vueFilesPathMap, basePageClassPath, outDir, {
         customPomAttachments,
         projectRoot,
         customPomDir,
@@ -699,7 +705,7 @@ export async function generateFiles(
       writeGeneratedFile(file);
     }
 
-    const fixtureRegistryFile = maybeGenerateFixtureRegistry(componentHierarchyMap, {
+    const fixtureRegistryFile = maybeGenerateFixtureRegistry(emittableComponentHierarchyMap, {
       generateFixtures,
       pomOutDir: outDir,
       projectRoot,
@@ -711,7 +717,7 @@ export async function generateFiles(
   }
 
   if (emitLanguages.includes("csharp")) {
-    const csFiles = generateAggregatedCSharpFiles(componentHierarchyMap, outDir, {
+    const csFiles = generateAggregatedCSharpFiles(emittableComponentHierarchyMap, outDir, {
       projectRoot,
       testIdAttribute,
       csharp,
@@ -1636,7 +1642,12 @@ function prepareViewObjectModelClass(
     : childrenComponentSet;
   const componentRefsForInstances = new Set<string>();
   for (const ref of rawComponentRefsForInstances) {
-    componentRefsForInstances.add(resolveTrackedComponentRef(ref) ?? normalizeTrackedComponentRef(ref));
+    const resolvedRef = resolveTrackedComponentRef(ref) ?? normalizeTrackedComponentRef(ref);
+    const resolvedDependencies = componentHierarchyMap.get(resolvedRef);
+    if (!resolvedDependencies?.dataTestIdSet.size) {
+      continue;
+    }
+    componentRefsForInstances.add(resolvedRef);
   }
 
   const hasChildComponent = (needle: string) => {
@@ -1710,9 +1721,9 @@ function prepareViewObjectModelClass(
     members.push(...getComponentInstances(componentRefsForInstances, componentHierarchyMap, attachmentsForThisClass, widgetInstances));
     members.push(getConstructor(componentRefsForInstances, componentHierarchyMap, attachmentsForThisClass, widgetInstances, { testIdAttribute }));
   }
-  if (!isView && attachmentsForThisClass.length > 0) {
-    members.push(...getComponentInstances(new Set(), componentHierarchyMap, attachmentsForThisClass));
-    members.push(getConstructor(new Set(), componentHierarchyMap, attachmentsForThisClass, [], { testIdAttribute }));
+  if (!isView && (componentRefsForInstances.size > 0 || attachmentsForThisClass.length > 0)) {
+    members.push(...getComponentInstances(componentRefsForInstances, componentHierarchyMap, attachmentsForThisClass));
+    members.push(getConstructor(componentRefsForInstances, componentHierarchyMap, attachmentsForThisClass, [], { testIdAttribute }));
   }
 
   members.push(
@@ -1771,7 +1782,10 @@ function generateViewObjectModelContent(
   const basePageImport = path.relative(fromAbs, toAbs).replace(/\\/g, "/");
   const basePageImportNoExt = stripExtension(basePageImport).replace(/\\/g, "/");
   const basePageImportSpecifier = basePageImportNoExt.startsWith(".") ? basePageImportNoExt : `./${basePageImportNoExt}`;
-  const needsPlaywrightPageImport = prepared.isView || prepared.attachmentsForThisClass.length > 0;
+  const needsPlaywrightPageImport = prepared.isView
+    || prepared.attachmentsForThisClass.length > 0
+    || prepared.componentRefsForInstances.size > 0
+    || prepared.widgetInstances.length > 0;
   const customPomImportSpecifiersByClass = options.customPomImportSpecifiersByClass ?? {};
 
   const customImports = Array.from(

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../class-generation/index.ts"],"names":[],"mappings":"AAUA,OAAO,EAAkC,oCAAoC,EAAE,MAAM,sBAAsB,CAAC;AAwC5G,OAAO,EACL,sBAAsB,EAOvB,MAAM,UAAU,CAAC;AAQlB,OAAO,EAAE,oCAAoC,EAAE,CAAC;AA2ChD,UAAU,SAAS;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAID,UAAU,mBAAmB;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,wBAAwB,EAAE,MAAM,EAAE,CAAC;IACnC,QAAQ,CAAC,EAAE,OAAO,GAAG,YAAY,GAAG,MAAM,GAAG,oBAAoB,CAAC;IAClE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AASD,MAAM,MAAM,yBAAyB,GAAG,YAAY,GAAG,OAAO,CAAC;AAqW/D,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;IACtB,gFAAgF;IAChF,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;;;;;;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,mBAAmB,EAAE,CAAC;IAE7C,yEAAyE;IACzE,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,uDAAuD;IACvD,aAAa,CAAC,EAAE,KAAK,CAAC,IAAI,GAAG,QAAQ,CAAC,CAAC;IAEvC;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,yBAAyB,CAAC;IAEtD,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,EAAE,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtB,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CAClD;AAsCD,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,iBAoGnC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../class-generation/index.ts"],"names":[],"mappings":"AAUA,OAAO,EAAkC,oCAAoC,EAAE,MAAM,sBAAsB,CAAC;AAwC5G,OAAO,EACL,sBAAsB,EAQvB,MAAM,UAAU,CAAC;AAQlB,OAAO,EAAE,oCAAoC,EAAE,CAAC;AA2ChD,UAAU,SAAS;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAID,UAAU,mBAAmB;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,wBAAwB,EAAE,MAAM,EAAE,CAAC;IACnC,QAAQ,CAAC,EAAE,OAAO,GAAG,YAAY,GAAG,MAAM,GAAG,oBAAoB,CAAC;IAClE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AASD,MAAM,MAAM,yBAAyB,GAAG,YAAY,GAAG,OAAO,CAAC;AAqW/D,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;IACtB,gFAAgF;IAChF,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;;;;;;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,mBAAmB,EAAE,CAAC;IAE7C,yEAAyE;IACzE,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,uDAAuD;IACvD,aAAa,CAAC,EAAE,KAAK,CAAC,IAAI,GAAG,QAAQ,CAAC,CAAC;IAEvC;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,yBAAyB,CAAC;IAEtD,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,EAAE,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtB,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CAClD;AAsCD,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,iBAyGnC"}

package/dist/compiler-metadata-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"compiler-metadata-utils.d.ts","sourceRoot":"","sources":["../compiler-metadata-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,aAAa,EACb,WAAW,EACX,oBAAoB,EAGrB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,aAAa,GAAG,SAAS,CAAC;AAEvE,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,WAAW,EAAE,aAAa,GAAE,MAAsB,GAAG,cAAc,CAQ9G;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,cAAc,GAAG,MAAM,GAAG,IAAI,CAcrE;AAED,wBAAgB,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,oBAAoB,GAAG,SAAS,GAAG,MAAM,EAAE,GAAG,SAAS,CA+C/G;AAkCD,wBAAgB,wBAAwB,CAAC,IAAI,EAAE;IAC7C,OAAO,EAAE,WAAW,CAAC;IACrB,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,oCAAoC,EAAE,OAAO,CAAC;IAC9C,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,GAAG,eAAe,GAAG,IAAI,CA2DzB"}
+{"version":3,"file":"compiler-metadata-utils.d.ts","sourceRoot":"","sources":["../compiler-metadata-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,aAAa,EACb,WAAW,EACX,oBAAoB,EAGrB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,aAAa,GAAG,SAAS,CAAC;AAEvE,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,WAAW,EAAE,aAAa,GAAE,MAAsB,GAAG,cAAc,CAQ9G;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,cAAc,GAAG,MAAM,GAAG,IAAI,CAcrE;AAED,wBAAgB,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,oBAAoB,GAAG,SAAS,GAAG,MAAM,EAAE,GAAG,SAAS,CA+C/G;AAkCD,wBAAgB,wBAAwB,CAAC,IAAI,EAAE;IAC7C,OAAO,EAAE,WAAW,CAAC;IACrB,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,oCAAoC,EAAE,OAAO,CAAC;IAC9C,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,GAAG,eAAe,GAAG,IAAI,CA6DzB"}