@immense/vue-pom-generator 1.0.31 → 1.0.32

package/RELEASE_NOTES.md

@@ -1,57 +1,38 @@
-● I need to see the actual diff content to understand what the fix addressed. Let me get the file
-  diffs:
-
-● Let me look at specific key changes to understand what was fixed:
-
-● Based on the commit and PR details, here are the release notes:
-
-  ---
+● # Release Notes: v1.0.32
 
   ## Highlights
 
-  - Changed default output directory from `tests/playwright/generated` to
-  `tests/playwright/__generated__` for better convention adherence
-  - Improved `.gitattributes` generation: now skips managed entries for paths using
-  `__generated__` heuristic (GitHub Linguist auto-detects these)
-  - Enhanced slot scope key extraction logic for more robust click handler naming in generated
-  POMs
-  - Added comprehensive utility functions for analyzing assignment patterns, object destructuring,
-   and binding identifiers
+  - Fixed handling of missing helpers and keyed ID branches in class generation
+  - Added robust error tolerance for edge cases in Vue component transformation
+  - Expanded test coverage with 109 new test lines across generated TypeScript and utility
+  coverage tests
+  - Introduced PR release-notes preview comments via GitHub Actions
 
   ## Changes
 
-  **Output Directory Convention**
-  - Updated default `generation.outDir` to `tests/playwright/__generated__`
-  - Updated default Playwright fixtures output to use `__generated__` subdirectory
-  - `.gitattributes` entries are now only generated when using custom output directories outside
-  `__generated__`
+  **Bug Fixes**
+  - Tolerate missing helpers and keyed ID branches in class generation logic
+  (`class-generation/index.ts`, `utils.ts`)
 
-  **Click Handler Naming**
-  - Improved slot scope key candidate extraction with priority-based selection
-  - Added support for object destructuring patterns in slot scope analysis
-  - Enhanced fallback key expression generation for slot scoped elements
-  - Better handling of assignment patterns, rest elements, and object properties
+  **Testing**
+  - Added comprehensive tests for generated TypeScript output (`tests/generated-tsc.test.ts`: +74
+  lines)
+  - Expanded utility function coverage tests (`tests/utils-coverage.test.ts`: +35 lines)
 
-  **Code Quality**
-  - Added test coverage for new utility functions in `class-generation-coverage.test.ts` and
-  `utils-coverage.test.ts`
-  - Expanded Babel type guards usage for more precise AST node detection
-  - Refactored slot scope analysis with dedicated helper functions
+  **CI/Automation**
+  - Added automated PR release-notes preview comments to pull requests
 
   ## Breaking Changes
 
-  - **Default output directory** changed from `tests/playwright/generated` to
-  `tests/playwright/__generated__`. If you're relying on the default, generated files will move to
-   the new location. To preserve the old behavior, explicitly set `generation.outDir:
-  "tests/playwright/generated"` in your config.
+  None
 
   ## Pull Requests Included
 
-  - [#1 Add PR release-notes preview
-  comments](https://github.com/immense/vue-pom-generator/pull/1) by @dkattan
+  - [#1](https://github.com/immense/vue-pom-generator/pull/1) Add PR release-notes preview
+  comments (@dkattan)
 
   ## Testing
 
-  Added test coverage for new utility functions covering class generation and slot scope analysis
-  edge cases.
+  Significant test additions: 74 lines in generated TypeScript tests and 35 lines in utility
+  coverage tests validate the fix for missing helpers and keyed ID branches.
 

package/class-generation/index.ts

@@ -407,6 +407,7 @@ interface GenerateContentOptions {
   customPomDir?: string;
   customPomImportAliases?: Record<string, string>;
   customPomClassIdentifierMap?: Record<string, string>;
+  customPomAvailableClassIdentifiers?: Set<string>;
 
   /** Attribute name to treat as the test id. Defaults to `data-testid`. */
   testIdAttribute?: string;
@@ -1153,8 +1154,14 @@ function generateViewObjectModelContent(
     return false;
   };
 
+  const customPomClassIdentifierMap = options.customPomClassIdentifierMap ?? {};
+  const customPomAvailableClassIdentifiers = options.customPomAvailableClassIdentifiers ?? new Set<string>();
+
   const attachmentsForThisClass = customPomAttachments
     .filter((a) => {
+      if (!Object.prototype.hasOwnProperty.call(customPomClassIdentifierMap, a.className))
+        return false;
+
       const scope = a.attachTo ?? "views";
       const scopeOk = isView
         ? (scope === "views" || scope === "both")
@@ -1164,7 +1171,7 @@ function generateViewObjectModelContent(
       return a.attachWhenUsesComponents.some(c => hasChildComponent(c));
     })
     .map(a => ({
-      className: options.customPomClassIdentifierMap?.[a.className] ?? a.className,
+      className: customPomClassIdentifierMap[a.className]!,
       propertyName: a.propertyName,
     }));
 
@@ -1218,7 +1225,7 @@ function generateViewObjectModelContent(
   content += `\nexport class ${className} extends BasePage {\n`;
 
   const widgetInstances = isView
-    ? getWidgetInstancesForView(componentName, dependencies.dataTestIdSet)
+    ? getWidgetInstancesForView(componentName, dependencies.dataTestIdSet, customPomAvailableClassIdentifiers)
     : [];
 
   // For views, `childrenComponentSet` only includes component tags on which we applied a data-testid.
@@ -1489,6 +1496,7 @@ async function generateAggregatedFiles(
     };
 
     const customPomClassIdentifierMap = addCustomPomImports();
+    const customPomAvailableClassIdentifiers = new Set(Object.values(customPomClassIdentifierMap ?? {}));
 
     // Collect any navigation return types referenced by generated methods so we can emit
     // stub classes when the destination view has no generated test ids (and therefore no
@@ -1690,6 +1698,7 @@ async function generateAggregatedFiles(
 
         customPomAttachments: options.customPomAttachments ?? [],
         customPomClassIdentifierMap,
+        customPomAvailableClassIdentifiers,
         testIdAttribute: options.testIdAttribute,
         vueRouterFluentChaining: options.vueRouterFluentChaining,
         routeMetaByComponent: options.routeMetaByComponent,
@@ -1817,7 +1826,11 @@ interface WidgetInstance {
   testId: string;
 }
 
-function getWidgetInstancesForView(componentName: string, dataTestIdSet: Set<IDataTestId>): WidgetInstance[] {
+function getWidgetInstancesForView(
+  componentName: string,
+  dataTestIdSet: Set<IDataTestId>,
+  availableClassIdentifiers: Set<string>,
+): WidgetInstance[] {
   const out: WidgetInstance[] = [];
   const usedPropNames = new Set<string>();
 
@@ -1858,6 +1871,9 @@ function getWidgetInstancesForView(componentName: string, dataTestIdSet: Set<IDa
       continue;
     }
 
+    if (!availableClassIdentifiers.has(className))
+      continue;
+
     // Prefer stripping the view prefix (e.g. PreferencesPage-) for cleaner member names.
     const viewPrefix = `${componentName}-`;
     const descriptorRaw = stem.startsWith(viewPrefix) ? stem.slice(viewPrefix.length) : stem;

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;AAyOD,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,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CAClD;AAuCD,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,iBA2EnC"}
+{"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;AAyOD,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,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,iBA2EnC"}

package/dist/index.cjs

@@ -1859,6 +1859,12 @@ function applyResolvedDataTestId(args) {
   const existingIdBehavior = args.existingIdBehavior ?? "preserve";
   const nameCollisionBehavior = args.nameCollisionBehavior ?? "suffix";
   const warn = args.warn;
+  const getBestKeyAccessCandidates = (expr) => {
+    if (!expr) {
+      return [];
+    }
+    return expr.split("??").map((part) => part.trim()).filter(Boolean);
+  };
   let dataTestId = args.preferredGeneratedValue;
   let fromExisting = false;
   const existing = tryGetExistingElementDataTestId(args.element, testIdAttribute);
@@ -1881,6 +1887,7 @@ Bulk cleanup: run ESLint with the @immense/vue-pom-generator/remove-existing-tes
     if (existingIdBehavior === "preserve") {
       if (existing.isDynamic) {
         if (existing.template) {
+          const existingTemplate = existing.template;
           if ((existing.templateExpressionCount ?? 0) !== 1) {
             throw new Error(
               `[vue-pom-generator] Existing ${attrLabel} is a template literal with multiple interpolations and cannot be preserved safely.
@@ -1891,8 +1898,8 @@ Existing ${attrLabel}: ${JSON.stringify(existing.value)}
 Fix: reduce the template to a single key-based interpolation, or remove the explicit ${attrLabel} so it can be auto-generated.`
             );
           }
-          const hasExact = args.bestKeyPlaceholder && existing.template.includes(args.bestKeyPlaceholder);
-          const hasVarAccess = args.bestKeyVariable && existing.template.includes(args.bestKeyVariable);
+          const hasExact = args.bestKeyPlaceholder && existingTemplate.includes(args.bestKeyPlaceholder);
+          const hasVarAccess = getBestKeyAccessCandidates(args.bestKeyVariable).some((candidate) => existingTemplate.includes(candidate));
           if (!hasExact && !hasVarAccess && args.bestKeyPlaceholder) {
             throw new Error(
               `[vue-pom-generator] Existing ${attrLabel} appears to be missing the key placeholder needed to keep it unique.
@@ -3883,14 +3890,18 @@ function generateViewObjectModelContent(componentName, dependencies, componentHi
     }
     return false;
   };
+  const customPomClassIdentifierMap = options.customPomClassIdentifierMap ?? {};
+  const customPomAvailableClassIdentifiers = options.customPomAvailableClassIdentifiers ?? /* @__PURE__ */ new Set();
   const attachmentsForThisClass = customPomAttachments.filter((a) => {
+    if (!Object.prototype.hasOwnProperty.call(customPomClassIdentifierMap, a.className))
+      return false;
     const scope = a.attachTo ?? "views";
     const scopeOk = isView ? scope === "views" || scope === "both" : scope === "components" || scope === "both";
     if (!scopeOk)
       return false;
     return a.attachWhenUsesComponents.some((c) => hasChildComponent(c));
   }).map((a) => ({
-    className: options.customPomClassIdentifierMap?.[a.className] ?? a.className,
+    className: customPomClassIdentifierMap[a.className],
     propertyName: a.propertyName
   }));
   let content = "";
@@ -3930,7 +3941,7 @@ function generateViewObjectModelContent(componentName, dependencies, componentHi
   content += `
 export class ${className} extends BasePage {
 `;
-  const widgetInstances = isView ? getWidgetInstancesForView(componentName, dependencies.dataTestIdSet) : [];
+  const widgetInstances = isView ? getWidgetInstancesForView(componentName, dependencies.dataTestIdSet, customPomAvailableClassIdentifiers) : [];
   const componentRefsForInstances = isView ? usedComponentSet?.size ? usedComponentSet : childrenComponentSet : childrenComponentSet;
   if (isView && (componentRefsForInstances.size > 0 || attachmentsForThisClass.length > 0 || widgetInstances.length > 0)) {
     content += getComponentInstances(componentRefsForInstances, componentHierarchyMap, attachmentsForThisClass, widgetInstances);
@@ -4088,6 +4099,7 @@ Fix by setting generation.playwright.customPoms.importAliases["${exportName}"] t
       return customPomClassIdentifierMap2;
     };
     const customPomClassIdentifierMap = addCustomPomImports();
+    const customPomAvailableClassIdentifiers = new Set(Object.values(customPomClassIdentifierMap ?? {}));
     const referencedTargets = /* @__PURE__ */ new Set();
     for (const [, deps] of items) {
       for (const dt of deps.dataTestIdSet) {
@@ -4240,6 +4252,7 @@ Fix by setting generation.playwright.customPoms.importAliases["${exportName}"] t
         aggregated: true,
         customPomAttachments: options.customPomAttachments ?? [],
         customPomClassIdentifierMap,
+        customPomAvailableClassIdentifiers,
         testIdAttribute: options.testIdAttribute,
         vueRouterFluentChaining: options.vueRouterFluentChaining,
         routeMetaByComponent: options.routeMetaByComponent
@@ -4334,7 +4347,7 @@ function toPascalCaseLocal(str) {
     return preserveInternalCaps ? upperFirst(word) : upperFirst(word.toLowerCase());
   }).join("");
 }
-function getWidgetInstancesForView(componentName, dataTestIdSet) {
+function getWidgetInstancesForView(componentName, dataTestIdSet, availableClassIdentifiers) {
   const out = [];
   const usedPropNames = /* @__PURE__ */ new Set();
   const ensureUnique = (base) => {
@@ -4365,6 +4378,8 @@ function getWidgetInstancesForView(componentName, dataTestIdSet) {
     } else {
       continue;
     }
+    if (!availableClassIdentifiers.has(className))
+      continue;
     const viewPrefix = `${componentName}-`;
     const descriptorRaw = stem.startsWith(viewPrefix) ? stem.slice(viewPrefix.length) : stem;
     const descriptorPascal = toPascalCaseLocal(descriptorRaw);