@immense/vue-pom-generator 1.0.39 → 1.0.41

package/RELEASE_NOTES.md

@@ -1,40 +1,41 @@
-● # Release Notes: v1.0.39
+● # Release Notes - v1.0.41
 
   ## Highlights
 
-  - **Flattened helper attachments**: New capability in class generation for handling helper
-  attachments in a flattened structure
-  - **Extensive documentation updates**: README expanded with over 1,100 new lines of
-  documentation
-  - **Enhanced test coverage**: Added 89 lines of new tests for generated TypeScript compilation
-  - **PR automation**: Added release notes preview comments on pull requests
+  - Fixed keyed click test ID scoping to prevent conflicts
+  - Aligned attachment scopes for consistent behavior
+  - Aligned dev snapshot options across plugin configurations
+  - Added PR release notes preview comments via GitHub Actions
+  - Expanded test coverage with new dev plugin options tests
 
   ## Changes
 
-  ### Features
-  - Add flattened helper attachments support in class generation (`class-generation/index.ts`)
+  **Bug Fixes**
+  - Fixed keyed click test ID scoping issues
+  - Aligned attachment scopes for proper C# navigation returns
+  - Aligned dev snapshot options across build and dev plugins
 
-  ### Documentation
-  - Significantly expanded README with detailed documentation (+1,118 lines)
+  **Tooling & CI**
+  - Updated release workflow to use npm 11.5.1 via npx
+  - Added automated PR release notes preview comments
 
-  ### Testing
-  - Enhanced `tests/generated-tsc.test.ts` with additional test cases (+89 lines)
+  **Testing**
+  - Added comprehensive dev plugin options test suite (`tests/dev-plugin-options.test.ts`)
+  - Expanded transform tests with additional coverage
 
-  ### Tooling
-  - Added PR release-notes preview comment automation
-  - Minor updates to plugin type definitions and support files
-
-  ## Breaking Changes
-
-  None
+  **Internal**
+  - Updated utility functions for improved scoping logic
+  - Refined plugin configuration handling
 
   ## Pull Requests Included
 
-  - #1 Add PR release-notes preview comments (https://github.com/immense/vue-pom-generator/pull/1)
-   by @dkattan
+  - [#4 Fix keyed POM dedupe and C# navigation
+  returns](https://github.com/immense/vue-pom-generator/pull/4) (@dkattan)
+  - [#1 Add PR release-notes preview
+  comments](https://github.com/immense/vue-pom-generator/pull/1) (@dkattan)
 
   ## Testing
 
-  Tests updated and expanded to cover new flattened helper attachments functionality. Added 89
-  lines of test coverage in `tests/generated-tsc.test.ts`.
+  Added 160+ lines of new tests for dev plugin options. Existing transform tests expanded with
+  additional assertions.
 

package/class-generation/index.ts

@@ -75,7 +75,7 @@ interface CustomPomAttachment {
   className: string;
   propertyName: string;
   attachWhenUsesComponents: string[];
-  attachTo?: "views" | "components" | "both";
+  attachTo?: "views" | "components" | "both" | "pagesAndComponents";
   flatten?: boolean;
 }
 
@@ -855,6 +855,7 @@ function generateAggregatedCSharpFiles(
         chunks.push("    {");
         if (pom.formattedDataTestId.includes("${") || allTestIds.length <= 1) {
           chunks.push(`        await ${locatorName}${pom.formattedDataTestId.includes("${") ? `(${args})` : ""}.ClickAsync();`);
+          chunks.push(`        return new ${target}(Page);`);
         }
         else {
           chunks.push("        Exception? lastError = null;");
@@ -876,7 +877,6 @@ function generateAggregatedCSharpFiles(
           chunks.push("        }");
           chunks.push("        throw lastError ?? new System.Exception(\"[pom] Failed to navigate using any candidate test id.\");");
         }
-        chunks.push(`        return new ${target}(Page);`);
         chunks.push("    }");
         chunks.push("");
         continue;

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

@@ -8,7 +8,7 @@ interface CustomPomAttachment {
     className: string;
     propertyName: string;
     attachWhenUsesComponents: string[];
-    attachTo?: "views" | "components" | "both";
+    attachTo?: "views" | "components" | "both" | "pagesAndComponents";
     flatten?: boolean;
 }
 export interface GenerateFilesOptions {

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../class-generation/index.ts"],"names":[],"mappings":"AAMA,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;AASD,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,CAAC;IAC3C,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AA8PD,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,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,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;AA+BD,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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../class-generation/index.ts"],"names":[],"mappings":"AAMA,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;AASD,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;AA8PD,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,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,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;AA+BD,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

@@ -739,14 +739,16 @@ function nodeHasForDirective(node) {
 function getKeyDirective(node) {
   return findDirectiveByName(node, "bind", "key") ?? null;
 }
-function getKeyDirectiveValue(node, context = null) {
+function getKeyDirectiveValue(node, _context = null) {
   const keyDirective = getKeyDirective(node);
-  let value = keyDirective?.exp?.loc.source;
-  if (value) {
-    if (context) {
-      value = compilerCore.stringifyExpression(keyDirective.exp);
-    }
-    return `\${${value}}`;
+  const rawSource = keyDirective?.exp?.loc.source?.trim();
+  if (rawSource) {
+    return `\${${rawSource}}`;
+  }
+  if (keyDirective?.exp) {
+    const value = compilerCore.stringifyExpression(keyDirective.exp);
+    if (value)
+      return `\${${value}}`;
   }
   return null;
 }
@@ -2095,9 +2097,6 @@ Fix: either (1) include ${args.bestKeyPlaceholder} in your :${attrLabel} templat
   })();
   const tryMergeWithExistingPrimary = (candidateActionName) => {
     const mergeKey = (args.pomMergeKey ?? "").trim();
-    if (isKeyed) {
-      return false;
-    }
     const existingEntry = primaryByActionName.get(candidateActionName);
     const existingPom = existingEntry?.pom;
     if (!existingEntry || !existingPom) {
@@ -2108,6 +2107,9 @@ Fix: either (1) include ${args.bestKeyPlaceholder} in your :${attrLabel} templat
       ...existingPom.alternateFormattedDataTestIds ?? []
     ];
     const sharesSelectorIdentity = existingSelectors.includes(formattedDataTestIdForPom);
+    if (isKeyed && !sharesSelectorIdentity) {
+      return false;
+    }
     if (!mergeKey && !sharesSelectorIdentity) {
       return false;
     }
@@ -2154,6 +2156,11 @@ Fix: either (1) include ${args.bestKeyPlaceholder} in your :${attrLabel} templat
           conflicts = false;
         }
       }
+      if (conflicts && nameCollisionBehavior === "error" && tryMergeWithExistingPrimary(actionName)) {
+        methodName = candidate;
+        mergedIntoExisting = true;
+        break;
+      }
       if (conflicts && nameCollisionBehavior === "error") {
         const roleSuffix = upperFirst(normalizedRole || "Element");
         const baseNameUpper = upperFirst(baseWithSuffix);
@@ -2200,11 +2207,6 @@ Fix: either (1) include ${args.bestKeyPlaceholder} in your :${attrLabel} templat
         reservedMembers.add(actionName);
         break;
       }
-      if (nameCollisionBehavior === "error" && tryMergeWithExistingPrimary(actionName)) {
-        methodName = candidate;
-        mergedIntoExisting = true;
-        break;
-      }
       if (!collisionDetails) {
         collisionDetails = { getterName: chosenGetterName, actionName };
         collisionHint = hint || (args.semanticNameHint ?? "").trim() || null;
@@ -3781,6 +3783,7 @@ function generateAggregatedCSharpFiles(componentHierarchyMap, outDir, options =
         chunks.push("    {");
         if (pom.formattedDataTestId.includes("${") || allTestIds.length <= 1) {
           chunks.push(`        await ${locatorName}${pom.formattedDataTestId.includes("${") ? `(${args})` : ""}.ClickAsync();`);
+          chunks.push(`        return new ${target}(Page);`);
         } else {
           chunks.push("        Exception? lastError = null;");
           chunks.push(`        foreach (var testId in new[] { ${allTestIds.map(toCSharpTestIdExpression).join(", ")} })`);
@@ -3801,7 +3804,6 @@ function generateAggregatedCSharpFiles(componentHierarchyMap, outDir, options =
           chunks.push("        }");
           chunks.push('        throw lastError ?? new System.Exception("[pom] Failed to navigate using any candidate test id.");');
         }
-        chunks.push(`        return new ${target}(Page);`);
         chunks.push("    }");
         chunks.push("");
         continue;
@@ -6008,6 +6010,7 @@ function createDevProcessorPlugin(options) {
     customPomDir,
     customPomImportAliases,
     customPomImportNameCollisionBehavior,
+    nameCollisionBehavior = "suffix",
     testIdAttribute,
     routerAwarePoms,
     resolvedRouterEntry,
@@ -6155,7 +6158,14 @@ function createDevProcessorPlugin(options) {
                 nativeWrappers,
                 excludedComponents,
                 getViewsDirAbs(),
-                { existingIdBehavior: "preserve", testIdAttribute, wrapperSearchRoots: getWrapperSearchRoots() }
+                {
+                  existingIdBehavior: "preserve",
+                  nameCollisionBehavior,
+                  testIdAttribute,
+                  warn: (message) => loggerRef.current.warn(message),
+                  vueFilesPathMap: snapshotVuePathMap,
+                  wrapperSearchRoots: getWrapperSearchRoots()
+                }
               )
             ]
           });
@@ -6198,6 +6208,8 @@ function createDevProcessorPlugin(options) {
           customPomDir,
           customPomImportAliases,
           customPomImportNameCollisionBehavior,
+          viewsDir,
+          scanDirs,
           testIdAttribute,
           vueRouterFluentChaining: routerAwarePoms,
           routerEntry: resolvedRouterEntry,
@@ -6381,6 +6393,7 @@ function createSupportPlugins(options) {
     viewsDir,
     scanDirs,
     getWrapperSearchRoots,
+    nameCollisionBehavior = "suffix",
     outDir,
     emitLanguages,
     csharp,
@@ -6457,6 +6470,7 @@ function createSupportPlugins(options) {
     customPomDir,
     customPomImportAliases,
     customPomImportNameCollisionBehavior,
+    nameCollisionBehavior,
     testIdAttribute,
     routerAwarePoms,
     routerType,
@@ -7037,6 +7051,7 @@ function createVuePomGeneratorPlugins(options = {}) {
     viewsDir,
     scanDirs,
     getWrapperSearchRoots: getWrapperSearchRootsAbs,
+    nameCollisionBehavior,
     outDir,
     emitLanguages,
     csharp,