@immense/vue-pom-generator 1.0.36 → 1.0.38

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;
 }
 
@@ -4525,8 +4544,9 @@ function getWidgetInstancesForView(componentName, dataTestIdSet, availableClassI
     } else {
       continue;
     }
-    if (!availableClassIdentifiers.has(className))
+    if (!availableClassIdentifiers.has(className)) {
       continue;
+    }
     const viewPrefix = `${componentName}-`;
     const descriptorRaw = stem.startsWith(viewPrefix) ? stem.slice(viewPrefix.length) : stem;
     const descriptorPascal = toPascalCaseLocal(descriptorRaw);
@@ -4595,32 +4615,31 @@ function getConstructor(childrenComponent, componentHierarchyMap, attachmentsFor
   return `${content}
 `;
 }
-function getGenerationMetrics(componentHierarchyMap) {
-  let selectorCount = 0;
-  let generatedMethodCount = 0;
-  for (const deps of componentHierarchyMap.values()) {
-    selectorCount += deps.dataTestIdSet?.size ?? 0;
-    generatedMethodCount += deps.generatedMethods?.size ?? 0;
+function summarizeHierarchyMap(componentHierarchyMap) {
+  let interactiveComponentCount = 0;
+  let dataTestIdCount = 0;
+  for (const dependencies of componentHierarchyMap.values()) {
+    const selectorCount = dependencies.dataTestIdSet?.size ?? 0;
+    if (selectorCount > 0) {
+      interactiveComponentCount += 1;
+      dataTestIdCount += selectorCount;
+    }
   }
   return {
     entryCount: componentHierarchyMap.size,
-    selectorCount,
-    generatedMethodCount
+    interactiveComponentCount,
+    dataTestIdCount
   };
 }
-function isLessRich(current, previous) {
-  if (current.entryCount !== previous.entryCount) {
-    return current.entryCount < previous.entryCount;
+function isLessRich(candidate, previous) {
+  if (candidate.dataTestIdCount !== previous.dataTestIdCount) {
+    return candidate.dataTestIdCount < previous.dataTestIdCount;
   }
-  if (current.selectorCount !== previous.selectorCount) {
-    return current.selectorCount < previous.selectorCount;
+  if (candidate.interactiveComponentCount !== previous.interactiveComponentCount) {
+    return candidate.interactiveComponentCount < previous.interactiveComponentCount;
   }
-  return current.generatedMethodCount < previous.generatedMethodCount;
-}
-function getGenerationMetricsKey(projectRoot, outDir) {
-  return path.resolve(projectRoot, outDir ?? "./pom");
+  return candidate.entryCount < previous.entryCount;
 }
-const buildGenerationMetricsByOutputKey = /* @__PURE__ */ new Map();
 function createBuildProcessorPlugin(options) {
   const {
     componentHierarchyMap,
@@ -4645,6 +4664,11 @@ function createBuildProcessorPlugin(options) {
     routerModuleShims,
     loggerRef
   } = options;
+  let lastGeneratedMetrics = {
+    entryCount: 0,
+    interactiveComponentCount: 0,
+    dataTestIdCount: 0
+  };
   return {
     name: "vue-pom-generator-build",
     // This plugin exists to generate code on build output; it is not needed during dev-server HMR.
@@ -4697,17 +4721,18 @@ function createBuildProcessorPlugin(options) {
       }
       this.addWatchFile(pointerPath);
     },
-    buildEnd() {
-      const metrics = getGenerationMetrics(componentHierarchyMap);
-      if (metrics.entryCount <= 0 || metrics.selectorCount <= 0) {
+    async buildEnd(error) {
+      if (error) {
         return;
       }
-      const generationMetricsKey = getGenerationMetricsKey(projectRootRef.current, outDir);
-      const previousMetrics = buildGenerationMetricsByOutputKey.get(generationMetricsKey);
-      if (previousMetrics && isLessRich(metrics, previousMetrics)) {
+      const metrics = summarizeHierarchyMap(componentHierarchyMap);
+      if (metrics.dataTestIdCount <= 0) {
         return;
       }
-      generateFiles(componentHierarchyMap, vueFilesPathMap, normalizedBasePagePath, {
+      if (isLessRich(metrics, lastGeneratedMetrics)) {
+        return;
+      }
+      await generateFiles(componentHierarchyMap, vueFilesPathMap, normalizedBasePagePath, {
         outDir,
         emitLanguages,
         csharp,
@@ -4724,8 +4749,8 @@ function createBuildProcessorPlugin(options) {
         viewsDir,
         scanDirs
       });
-      buildGenerationMetricsByOutputKey.set(generationMetricsKey, metrics);
-      loggerRef.current.info(`generated POMs (${metrics.entryCount} entries, ${metrics.selectorCount} selectors)`);
+      lastGeneratedMetrics = metrics;
+      loggerRef.current.info(`generated POMs (${metrics.entryCount} entries, ${metrics.interactiveComponentCount} interactive components, ${metrics.dataTestIdCount} selectors)`);
     },
     closeBundle() {
       loggerRef.current.info("build complete");
@@ -5814,7 +5839,6 @@ Fix: remove the explicit ${attrLabel}, or change existingIdBehavior to "overwrit
     }
   };
 }
-const devStartupMetricsByOutputKey = /* @__PURE__ */ new Map();
 function createDevProcessorPlugin(options) {
   const {
     nativeWrappers,
@@ -5980,11 +6004,7 @@ function createDevProcessorPlugin(options) {
                 nativeWrappers,
                 excludedComponents,
                 getViewsDirAbs(),
-                {
-                  existingIdBehavior: "preserve",
-                  testIdAttribute,
-                  wrapperSearchRoots: getWrapperSearchRoots()
-                }
+                { existingIdBehavior: "preserve", testIdAttribute, wrapperSearchRoots: getWrapperSearchRoots() }
               )
             ]
           });
@@ -6016,21 +6036,6 @@ function createDevProcessorPlugin(options) {
         logInfo(`initial compile: ${compiledCount}/${totalVueFiles} files in ${formatMs(t1 - t0)} (components=${snapshotHierarchy.size})`);
       };
       const generateAggregatedFromSnapshot = (reason) => {
-        const metrics = getGenerationMetrics(snapshotHierarchy);
-        if (metrics.entryCount <= 0 || metrics.selectorCount <= 0) {
-          logInfo(`generate(${reason}): skipped empty snapshot (components=${metrics.entryCount}, selectors=${metrics.selectorCount})`);
-          return;
-        }
-        const generationMetricsKey = getGenerationMetricsKey(projectRootRef.current, outDir);
-        if (reason === "startup") {
-          const previousMetrics = devStartupMetricsByOutputKey.get(generationMetricsKey);
-          if (previousMetrics && isLessRich(metrics, previousMetrics)) {
-            logInfo(
-              `generate(${reason}): skipped smaller snapshot (components=${metrics.entryCount}, selectors=${metrics.selectorCount})`
-            );
-            return;
-          }
-        }
         const t0 = node_perf_hooks.performance.now();
         generateFiles(snapshotHierarchy, snapshotVuePathMap, normalizedBasePagePath, {
           outDir,
@@ -6045,15 +6050,10 @@ function createDevProcessorPlugin(options) {
           testIdAttribute,
           vueRouterFluentChaining: routerAwarePoms,
           routerEntry: resolvedRouterEntry,
-          routerType,
-          viewsDir,
-          scanDirs
+          routerType
         });
-        if (reason === "startup") {
-          devStartupMetricsByOutputKey.set(generationMetricsKey, metrics);
-        }
         const t1 = node_perf_hooks.performance.now();
-        logInfo(`generate(${reason}): components=${metrics.entryCount} selectors=${metrics.selectorCount} in ${formatMs(t1 - t0)}`);
+        logInfo(`generate(${reason}): components=${snapshotHierarchy.size} in ${formatMs(t1 - t0)}`);
       };
       const initialBuildPromise = (async () => {
         const t0 = node_perf_hooks.performance.now();
@@ -6300,6 +6300,7 @@ function createSupportPlugins(options) {
     basePageClassPath,
     outDir,
     emitLanguages,
+    csharp,
     generateFixtures,
     customPomAttachments,
     customPomDir,
@@ -6664,7 +6665,7 @@ function createVuePluginWithTestIds(options) {
       };
     }
   };
-  return { metadataCollectorPlugin, internalVuePlugin, nuxtVueBridgePlugin };
+  return { metadataCollectorPlugin, internalVuePlugin, nuxtVueBridgePlugin, templateCompilerOptions };
 }
 function assertNonEmptyString(value, name) {
   if (!value || !value.trim()) {
@@ -6709,6 +6710,58 @@ function assertRouterModuleShims(value, name) {
 function resolveFromProjectRoot(projectRoot, maybePath) {
   return path.isAbsolute(maybePath) ? maybePath : path.resolve(projectRoot, maybePath);
 }
+const sharedGeneratorStateRegistry = /* @__PURE__ */ new Map();
+function toArray(value) {
+  return Array.isArray(value) ? value : [];
+}
+function getSharedGeneratorState(key) {
+  let state = sharedGeneratorStateRegistry.get(key);
+  if (!state) {
+    state = {
+      componentTestIds: /* @__PURE__ */ new Map(),
+      elementMetadata: /* @__PURE__ */ new Map(),
+      semanticNameMap: /* @__PURE__ */ new Map(),
+      componentHierarchyMap: /* @__PURE__ */ new Map(),
+      vueFilesPathMap: /* @__PURE__ */ new Map()
+    };
+    sharedGeneratorStateRegistry.set(key, state);
+  }
+  return state;
+}
+function applyTemplateCompilerOptionsToResolvedVuePlugin(config, templateCompilerOptions, mode) {
+  const viteVuePlugin = (config.plugins ?? []).find((plugin) => plugin.name === "vite:vue");
+  if (!viteVuePlugin?.api) {
+    if (mode === "external") {
+      throw new Error(
+        '[vue-pom-generator] vuePluginOwnership="external" requires the resolved Vite Vue plugin, but none was found. Add vue() to your Vite plugins before spreading createVuePomGeneratorPlugins(...).'
+      );
+    }
+    throw new Error("[vue-pom-generator] Nuxt mode requires the resolved Vite Vue plugin, but none was found.");
+  }
+  const currentOptions = viteVuePlugin.api.options ?? {};
+  const currentTemplate = currentOptions.template ?? {};
+  const currentCompilerOptions = currentTemplate.compilerOptions ?? {};
+  const mergedNodeTransforms = [
+    ...toArray(currentCompilerOptions.nodeTransforms),
+    ...toArray(templateCompilerOptions.nodeTransforms)
+  ];
+  const mergedExpressionPlugins = Array.from(/* @__PURE__ */ new Set([
+    ...toArray(currentCompilerOptions.expressionPlugins),
+    ...toArray(templateCompilerOptions.expressionPlugins)
+  ]));
+  viteVuePlugin.api.options = {
+    ...currentOptions,
+    template: {
+      ...currentTemplate,
+      compilerOptions: {
+        ...currentCompilerOptions,
+        ...templateCompilerOptions,
+        ...mergedExpressionPlugins.length > 0 ? { expressionPlugins: mergedExpressionPlugins } : {},
+        nodeTransforms: mergedNodeTransforms
+      }
+    }
+  };
+}
 function assertNotVitePluginInstance(options) {
   const candidate = options;
   const pluginLikeKeys = [
@@ -6727,7 +6780,7 @@ function assertNotVitePluginInstance(options) {
     return;
   }
   throw new TypeError(
-    `[vue-pom-generator] Invalid options: received an object that looks like a Vite plugin (found key: "${pluginLikeKey}"). Do not pass vue() into createVuePomGeneratorPlugins(...). Pass Vue plugin options via { vueOptions: { ... } } instead.`
+    `[vue-pom-generator] Invalid options: received an object that looks like a Vite plugin (found key: "${pluginLikeKey}"). Do not pass vue() into createVuePomGeneratorPlugins(...). Pass Vue plugin options via { vueOptions: { ... } } instead, or add vue() separately in Vite and use { vuePluginOwnership: "external" }.`
   );
 }
 function createVuePomGeneratorPlugins(options = {}) {
@@ -6751,6 +6804,12 @@ function createVuePomGeneratorPlugins(options = {}) {
   const routerEntry = generationOptions?.router?.entry;
   const routerType = generationOptions?.router?.type ?? "vue-router";
   const routerModuleShims = generationOptions?.router?.moduleShims;
+  const isNuxt = routerType === "nuxt";
+  if (isNuxt && options.vuePluginOwnership === "internal") {
+    throw new Error('[vue-pom-generator] Nuxt projects must use the resolved app-owned vite:vue plugin. Omit vuePluginOwnership or set it to "external".');
+  }
+  const vuePluginOwnership = isNuxt ? "external" : options.vuePluginOwnership ?? "internal";
+  const usesExternalVuePlugin = vuePluginOwnership === "external";
   const csharp = generationOptions?.csharp;
   const generateFixtures = generationOptions?.playwright?.fixtures;
   const customPoms = generationOptions?.playwright?.customPoms;
@@ -6759,6 +6818,17 @@ function createVuePomGeneratorPlugins(options = {}) {
   const resolvedCustomPomImportAliases = customPoms?.importAliases;
   const resolvedCustomPomImportCollisionBehavior = customPoms?.importNameCollisionBehavior ?? "error";
   const basePageClassPathOverride = generationOptions?.basePageClassPath;
+  const sharedStateKey = JSON.stringify({
+    cwd: process.cwd(),
+    viewsDir,
+    scanDirs,
+    wrapperSearchRoots,
+    outDir,
+    testIdAttribute,
+    routerType,
+    vuePluginOwnership
+  });
+  const sharedState = getSharedGeneratorState(sharedStateKey);
   const projectRootRef = { current: process.cwd() };
   const loggerRef = {
     current: createLogger({ verbosity })
@@ -6779,18 +6849,17 @@ function createVuePomGeneratorPlugins(options = {}) {
           assertNonEmptyString(routerEntry, "[vue-pom-generator] generation.router.entry");
         }
       }
+      if (usesExternalVuePlugin) {
+        applyTemplateCompilerOptionsToResolvedVuePlugin(config, templateCompilerOptions, isNuxt ? "nuxt" : vuePluginOwnership);
+      }
       loggerRef.current.info(`projectRoot=${projectRootRef.current}`);
       loggerRef.current.info(`Active plugins: ${config.plugins.map((p) => p.name).filter((n) => n.includes("vue-pom")).join(", ")}`);
     }
   };
   const getViewsDirAbs = () => resolveFromProjectRoot(projectRootRef.current, viewsDir);
   const getWrapperSearchRootsAbs = () => wrapperSearchRoots.map((root) => resolveFromProjectRoot(projectRootRef.current, root));
-  const componentTestIds = /* @__PURE__ */ new Map();
-  const elementMetadata = /* @__PURE__ */ new Map();
-  const semanticNameMap = /* @__PURE__ */ new Map();
-  const componentHierarchyMap = /* @__PURE__ */ new Map();
-  const vueFilesPathMap = /* @__PURE__ */ new Map();
-  const { metadataCollectorPlugin, internalVuePlugin, nuxtVueBridgePlugin } = createVuePluginWithTestIds({
+  const { componentTestIds, elementMetadata, semanticNameMap, componentHierarchyMap, vueFilesPathMap } = sharedState;
+  const { metadataCollectorPlugin, internalVuePlugin, templateCompilerOptions } = createVuePluginWithTestIds({
     vueOptions,
     existingIdBehavior,
     nameCollisionBehavior,
@@ -6834,14 +6903,15 @@ function createVuePomGeneratorPlugins(options = {}) {
     routerType,
     routerModuleShims
   });
-  const isNuxt = routerType === "nuxt";
   if (isNuxt) {
     loggerRef.current.info("Nuxt environment detected. Skipping internal @vitejs/plugin-vue to avoid conflicts.");
+  } else if (usesExternalVuePlugin) {
+    loggerRef.current.info('vuePluginOwnership="external" enabled. Patching the resolved vite:vue plugin instead of creating an internal one.');
   }
   const resultPlugins = [
     configPlugin,
     metadataCollectorPlugin,
-    ...isNuxt ? [nuxtVueBridgePlugin] : [internalVuePlugin],
+    ...usesExternalVuePlugin ? [] : [internalVuePlugin],
     ...supportPlugins
   ];
   if (!generationEnabled) {
@@ -6849,7 +6919,7 @@ function createVuePomGeneratorPlugins(options = {}) {
     return [
       configPlugin,
       metadataCollectorPlugin,
-      ...isNuxt ? [nuxtVueBridgePlugin] : [internalVuePlugin],
+      ...usesExternalVuePlugin ? [] : [internalVuePlugin],
       virtualModules
     ];
   }