@immense/vue-pom-generator 1.0.30 → 1.0.32

package/dist/index.mjs

@@ -4,7 +4,7 @@ import { pathToFileURL, fileURLToPath } from "node:url";
 import fs from "node:fs";
 import { JSDOM } from "jsdom";
 import { NodeTypes, stringifyExpression, ConstantTypes, createSimpleExpression } from "@vue/compiler-core";
-import { isArrayExpression, isStringLiteral, isTemplateLiteral, isAssignmentExpression, isIdentifier, isMemberExpression, isCallExpression, isExpressionStatement, isOptionalMemberExpression, isObjectExpression, isFile, isArrowFunctionExpression, isBlockStatement, isOptionalCallExpression, isLogicalExpression, isConditionalExpression, isSequenceExpression, isObjectProperty, isProgram, VISITOR_KEYS } from "@babel/types";
+import { isArrayExpression, isStringLiteral, isTemplateLiteral, isAssignmentExpression, isIdentifier, isMemberExpression, isCallExpression, isExpressionStatement, isArrowFunctionExpression, isOptionalMemberExpression, isObjectExpression, isFile, isBlockStatement, isOptionalCallExpression, isLogicalExpression, isConditionalExpression, isSequenceExpression, isAssignmentPattern, isRestElement, isObjectPattern, isObjectProperty, isProgram, VISITOR_KEYS, isBooleanLiteral, isNumericLiteral, isNullLiteral } from "@babel/types";
 import { parseExpression, parse } from "@babel/parser";
 import { performance } from "node:perf_hooks";
 import * as compilerDom from "@vue/compiler-dom";
@@ -565,6 +565,124 @@ function getTemplateSlotScope(node) {
   }
   return null;
 }
+function isSimpleScopeIdentifier(value) {
+  return /^[A-Za-z_$][A-Za-z0-9_$]*$/.test(value);
+}
+function buildSlotScopeFallbackKeyExpression(identifier) {
+  return `${identifier}.key ?? ${identifier}.data?.id ?? ${identifier}.id ?? ${identifier}.value ?? ${identifier}`;
+}
+function tryGetBindingIdentifierName(node) {
+  if (!node) {
+    return null;
+  }
+  if (isIdentifier(node)) {
+    return node.name;
+  }
+  if (isAssignmentPattern(node)) {
+    return tryGetBindingIdentifierName(node.left);
+  }
+  if (isRestElement(node)) {
+    return tryGetBindingIdentifierName(node.argument);
+  }
+  return null;
+}
+function getSlotScopeObjectPropertyKeyName(node) {
+  if (isIdentifier(node)) {
+    return node.name;
+  }
+  if (isStringLiteral(node)) {
+    return node.value;
+  }
+  return null;
+}
+function tryGetSlotScopeKeyCandidate(node) {
+  if (!node) {
+    return null;
+  }
+  if (isIdentifier(node)) {
+    return {
+      priority: 2,
+      expression: buildSlotScopeFallbackKeyExpression(node.name)
+    };
+  }
+  if (isAssignmentPattern(node)) {
+    return tryGetSlotScopeKeyCandidate(node.left);
+  }
+  if (isRestElement(node)) {
+    return tryGetSlotScopeKeyCandidate(node.argument);
+  }
+  if (!isObjectPattern(node)) {
+    return null;
+  }
+  let best = null;
+  for (const property of node.properties) {
+    let candidate = null;
+    if (isRestElement(property)) {
+      candidate = tryGetSlotScopeKeyCandidate(property.argument);
+      if (candidate) {
+        candidate = { ...candidate, priority: Math.max(candidate.priority, 2) };
+      }
+    } else if (isObjectProperty(property)) {
+      const keyName = getSlotScopeObjectPropertyKeyName(property.key);
+      const bindingName = tryGetBindingIdentifierName(property.value) ?? tryGetBindingIdentifierName(property.key);
+      if (bindingName) {
+        if (keyName === "key" || bindingName === "key") {
+          candidate = {
+            priority: 0,
+            expression: bindingName
+          };
+        } else {
+          candidate = {
+            priority: keyName === "data" ? 1 : 2,
+            expression: buildSlotScopeFallbackKeyExpression(bindingName)
+          };
+        }
+      }
+    }
+    if (candidate && (!best || candidate.priority < best.priority)) {
+      best = candidate;
+    }
+  }
+  return best;
+}
+function tryGetTemplateSlotScopeKeyExpression(scope) {
+  const trimmed = scope.trim();
+  if (!trimmed) {
+    return null;
+  }
+  if (isSimpleScopeIdentifier(trimmed)) {
+    return buildSlotScopeFallbackKeyExpression(trimmed);
+  }
+  try {
+    const parsed = parse(`(${trimmed}) => {}`, {
+      sourceType: "module",
+      plugins: ["typescript"]
+    });
+    const statement = parsed.program.body[0];
+    if (statement && isExpressionStatement(statement) && isArrowFunctionExpression(statement.expression)) {
+      return tryGetSlotScopeKeyCandidate(statement.expression.params[0])?.expression ?? null;
+    }
+  } catch {
+  }
+  if (trimmed.startsWith("{") && trimmed.endsWith("}")) {
+    const inner = trimmed.slice(1, -1).trim();
+    let cutIdx = -1;
+    const commaIdx = inner.indexOf(",");
+    const colonIdx = inner.indexOf(":");
+    if (commaIdx !== -1 && colonIdx !== -1) {
+      cutIdx = Math.min(commaIdx, colonIdx);
+    } else if (commaIdx !== -1) {
+      cutIdx = commaIdx;
+    } else if (colonIdx !== -1) {
+      cutIdx = colonIdx;
+    }
+    const first = (cutIdx === -1 ? inner : inner.slice(0, cutIdx)).trim();
+    if (first && isSimpleScopeIdentifier(first)) {
+      return buildSlotScopeFallbackKeyExpression(first);
+    }
+  }
+  return trimmed;
+}
 function nodeHasToDirective(node) {
   const toDirective = findDirectiveByName(node, "bind", "to");
   if (toDirective?.exp) {
@@ -640,25 +758,7 @@ function getContainedInSlotDataKeyValue(node, hierarchyMap2) {
     if (parent.type === NodeTypes.ELEMENT && parent.tag === "template") {
       const scope = getTemplateSlotScope(parent);
       if (scope) {
-        let key = scope.trim();
-        if (key.startsWith("{") && key.endsWith("}")) {
-          const inner = key.slice(1, -1).trim();
-          let cutIdx = -1;
-          const commaIdx = inner.indexOf(",");
-          const colonIdx = inner.indexOf(":");
-          if (commaIdx !== -1 && colonIdx !== -1) {
-            cutIdx = Math.min(commaIdx, colonIdx);
-          } else if (commaIdx !== -1) {
-            cutIdx = commaIdx;
-          } else if (colonIdx !== -1) {
-            cutIdx = colonIdx;
-          }
-          const first = (cutIdx === -1 ? inner : inner.slice(0, cutIdx)).trim();
-          if (first) {
-            key = first;
-          }
-        }
-        return key;
+        return tryGetTemplateSlotScopeKeyExpression(scope);
       }
     }
     parent = getParent(hierarchyMap2, parent);
@@ -1309,11 +1409,11 @@ function getStableClickHandlerNameFromExpression(exp) {
     return extractNameFromCallee(callee);
   }
   if (isAssignmentExpression(exp)) {
-    const left = exp.left;
-    if (isIdentifier(left))
-      return left.name;
-    if (isMemberExpression(left) || isOptionalMemberExpression(left))
-      return extractMemberPropertyName(left);
+    const left = getAssignmentTargetNameFromBabel(exp.left);
+    if (left) {
+      const right = getStableAssignmentValueSuffixFromBabel(exp.right);
+      return `Set${toPascalCase(left)}${right}`;
+    }
     return "";
   }
   if (isOptionalMemberExpression(exp)) {
@@ -1388,6 +1488,71 @@ function extractMemberPropertyName(member) {
   }
   return "";
 }
+function getLastIdentifierFromMemberChainBabel(node) {
+  if (!node) {
+    return "";
+  }
+  if (isIdentifier(node)) {
+    return node.name;
+  }
+  if (isMemberExpression(node) || isOptionalMemberExpression(node)) {
+    if (!node.computed) {
+      if (isIdentifier(node.property)) {
+        return node.property.name;
+      }
+    } else if (isStringLiteral(node.property)) {
+      return node.property.value;
+    }
+  }
+  return "";
+}
+function getAssignmentTargetNameFromBabel(node) {
+  if (!node) {
+    return "";
+  }
+  if (isIdentifier(node)) {
+    return node.name;
+  }
+  if (isMemberExpression(node) || isOptionalMemberExpression(node)) {
+    if (!node.computed && isIdentifier(node.property) && node.property.name === "value") {
+      return getLastIdentifierFromMemberChainBabel(node.object);
+    }
+    return getLastIdentifierFromMemberChainBabel(node);
+  }
+  return "";
+}
+function getStableAssignmentValueSuffixFromBabel(node) {
+  if (!node) {
+    return "";
+  }
+  if (isBooleanLiteral(node)) {
+    return node.value ? "True" : "False";
+  }
+  if (isNumericLiteral(node)) {
+    return `Value${String(node.value)}`;
+  }
+  if (isNullLiteral(node)) {
+    return "Null";
+  }
+  if (isStringLiteral(node)) {
+    const cleaned = (node.value ?? "").trim();
+    return cleaned ? toPascalCase(cleaned.slice(0, 24)) : "";
+  }
+  if (isTemplateLiteral(node) && node.expressions.length === 0) {
+    const value = node.quasis.map((q) => q.value?.cooked ?? "").join("").trim();
+    return value ? toPascalCase(value.slice(0, 24)) : "";
+  }
+  if (isMemberExpression(node) || isOptionalMemberExpression(node)) {
+    const name = getLastIdentifierFromMemberChainBabel(node);
+    return name ? toPascalCase(name.slice(0, 24)) : "";
+  }
+  if (isIdentifier(node)) {
+    const firstChar = node.name.charAt(0);
+    const isUpperAlpha = firstChar !== "" && firstChar === firstChar.toUpperCase() && firstChar !== firstChar.toLowerCase();
+    return isUpperAlpha ? toPascalCase(node.name.slice(0, 24)) : "";
+  }
+  return "";
+}
 function isCompilerGeneratedReferenceRoot(name) {
   return name.startsWith("_") || name.startsWith("$");
 }
@@ -1653,6 +1818,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);
@@ -1675,6 +1846,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.
@@ -1685,8 +1857,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.
@@ -3199,6 +3371,10 @@ function escapeGitAttributesPattern(value) {
   }
   return output;
 }
+function pathUsesGeneratedHeuristic(filePath) {
+  const normalized = path.normalize(filePath);
+  return normalized.split(path.sep).includes("__generated__");
+}
 function buildManagedGitAttributesBlock(entries) {
   return [
     GENERATED_GITATTRIBUTES_BLOCK_START,
@@ -3246,6 +3422,9 @@ function buildGeneratedGitAttributesFiles(generatedFilePaths) {
     if (path.basename(resolvedFilePath) === ".gitattributes") {
       continue;
     }
+    if (pathUsesGeneratedHeuristic(resolvedFilePath)) {
+      continue;
+    }
     const dir = path.dirname(resolvedFilePath);
     const entry = `${escapeGitAttributesPattern(path.basename(resolvedFilePath))} linguist-generated`;
     const entries = entriesByDir.get(dir) ?? /* @__PURE__ */ new Set();
@@ -3670,14 +3849,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 = "";
@@ -3717,7 +3900,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);
@@ -3875,6 +4058,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) {
@@ -4027,6 +4211,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
@@ -4121,7 +4306,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) => {
@@ -4152,6 +4337,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);
@@ -6156,7 +6343,7 @@ function createVuePomGeneratorPlugins(options = {}) {
   const excludedComponents = injection.excludeComponents ?? [];
   const testIdAttribute = (injection.attribute ?? "data-testid").trim() || "data-testid";
   const existingIdBehavior = injection.existingIdBehavior ?? "preserve";
-  const outDir = (generationOptions?.outDir ?? "tests/playwright/generated").trim();
+  const outDir = (generationOptions?.outDir ?? "tests/playwright/__generated__").trim();
   const emitLanguages = generationOptions?.emit && generationOptions.emit.length ? generationOptions.emit : ["ts"];
   const nameCollisionBehavior = generationOptions?.nameCollisionBehavior ?? "suffix";
   const routerEntry = generationOptions?.router?.entry;