@immense/vue-pom-generator 1.0.8 → 1.0.10

package/RELEASE_NOTES.md

@@ -1,38 +1,28 @@
 ● ## Highlights
-  - Added Nuxt pages introspection to router introspection.
-  - Major overhaul of Vue plugin with expanded support/dev/build plugins and types.
-  - Introduced Playwright types and updated class generation pipeline.
-  - Significant updates to transform and utility modules to support new features.
-  - CI improvements: release on main without gate and a pre-push up-to-date guard.
+  - Adopt native Playwright Page and Locator types for PwPage and PwLocator.
+  - Add test for existingIdBehavior error handling.
+  - Improve type safety in tests by replacing any with specific types.
+  - Fix type error in existing-id-error.test.ts.
+  - Updates across class-generation and plugin modules.
 
   ## Changes
-  - Router Introspection
-    - Enhanced router-introspection.ts to add Nuxt pages introspection functionality.
-  - Plugin System
-    - Overhauled plugin/vue-plugin.ts (+286/- changes) with expanded capabilities.
-    - Updated support plugins: dev-plugin, build-plugin, support-plugins, path-utils, logger, and
-  types.
-    - Improved create-vue-pom-generator-plugins.ts for plugin creation.
-  - Class Generation
-    - Added class-generation/playwright-types.ts.
-    - Updated BasePage, Pointer, index.ts, and method-generation.ts for generation flow.
-  - Transform & Utilities
-    - Refactored transform.ts and utils.ts with substantial changes.
-    - Minor eslint.config.ts adjustments.
-  - CI & Tooling
-    - Updated .github/workflows/release.yml and agentic-release-notes.lock.yml.
-    - Added scripts/git-hooks/pre-push.sh pre-push guard.
-    - Cleaned up .gitignore; updated package.json and package-lock.json for git hooks.
-  - Documentation & Logs
-    - Linted README.md.
-    - Added build_v5.log and build_web_v5.log.
+  - Types
+    - Use native Playwright Page/Locator for PwPage/PwLocator (class-generation/index.ts,
+  class-generation/playwright-types.ts)
+  - Tests
+    - Add tests/existing-id-error.test.ts for existingIdBehavior error handling
+    - Fix type error in tests/existing-id-error.test.ts
+    - Update tests/utils-coverage.test.ts
+  - Plugin
+    - Update plugin/vue-plugin.ts
+  - Tooling/Config
+    - Update eslint.config.ts
+    - Update package.json
 
   ## Pull Requests Included
-  - #1 Add PR release-notes preview comments (https://github.com/immense/vue-pom-generator/pull/1)
-   by @dkattan
+  - #1 Add PR release-notes preview comments — https://github.com/immense/vue-pom-generator/pull/1
+   (by @dkattan)
 
   ## Testing
-  - Updated tests in tests/options.test.ts and tests/utils-coverage.test.ts; adjusted fixture
-  MyComp_CancelButtons_InnerText.vue.
-  - No new test suites added.
+  - New test added and existing tests updated; type errors addressed.
 

package/class-generation/index.ts

@@ -1193,6 +1193,12 @@ async function generateAggregatedFiles(
         throw new Error(`Failed to read playwright-types.ts at ${typesPath}`);
       }
 
+      // Strip the import from the inlined types.
+      typesSource = typesSource.replace(
+        /import\s+type\s*\{\s*Locator\s+as\s+PwLocator\s*,\s*Page\s+as\s+PwPage\s*\}\s*from\s*["']@playwright\/test["'];?\s*/,
+        "",
+      );
+
       return typesSource.trim();
     };
 
@@ -1555,7 +1561,7 @@ async function generateAggregatedFiles(
 
   const base = ensureDir(outDir);
   const outputFile = path.join(base, "page-object-models.g.ts");
-  const header = `/// <reference lib="es2015" />\n${eslintSuppressionHeader}/**\n * Aggregated generated POMs\n${AUTO_GENERATED_COMMENT}`;
+  const header = `/// <reference lib="es2015" />\n${eslintSuppressionHeader}import type { Locator as PwLocator, Page as PwPage } from "@playwright/test";\n/**\n * Aggregated generated POMs\n${AUTO_GENERATED_COMMENT}`;
   const content = makeAggregatedContent(header, path.dirname(outputFile), [...views, ...components]);
 
   const indexFile = path.join(base, "index.ts");

package/class-generation/playwright-types.ts

@@ -1,23 +1,5 @@
-export interface PwLocator {
-  locator: (selector: string) => PwLocator;
-  first: () => PwLocator;
-  count: () => Promise<number>;
-  click: (options?: { force?: boolean }) => Promise<void>;
-  fill: (value: string, options?: { force?: boolean; timeout?: number }) => Promise<void>;
-  getAttribute: (name: string) => Promise<string | null>;
-  scrollIntoViewIfNeeded: (options?: { timeout?: number }) => Promise<void>;
-}
+import type { Locator as PwLocator, Page as PwPage } from "@playwright/test";
 
-export type PwSelectOption = string | { value?: string; label?: string; index?: number };
+export type { PwLocator, PwPage };
 
-export interface PwPage {
-  locator: (selector: string) => PwLocator;
-  url: () => string;
-  waitForTimeout: (timeout: number) => Promise<void>;
-  evaluate: <R, Arg>(pageFunction: (arg: Arg) => R | Promise<R>, arg: Arg) => Promise<R>;
-  isVisible: (selector: string, options?: { timeout?: number }) => Promise<boolean>;
-  textContent: (selector: string, options?: { timeout?: number }) => Promise<string | null>;
-  waitForSelector: (selector: string, options?: { timeout?: number }) => Promise<object | null>;
-  hover: (selector: string, options?: { timeout?: number }) => Promise<void>;
-  selectOption: (selector: string, values: PwSelectOption | PwSelectOption[], options?: { timeout?: number }) => Promise<string[]>;
-}
+export type PwSelectOption = string | { value?: string; label?: string; index?: number };

package/dist/index.cjs

@@ -3462,6 +3462,10 @@ async function generateAggregatedFiles(componentHierarchyMap, vueFilesPathMap, b
       } catch {
         throw new Error(`Failed to read playwright-types.ts at ${typesPath}`);
       }
+      typesSource = typesSource.replace(
+        /import\s+type\s*\{\s*Locator\s+as\s+PwLocator\s*,\s*Page\s+as\s+PwPage\s*\}\s*from\s*["']@playwright\/test["'];?\s*/,
+        ""
+      );
       return typesSource.trim();
     };
     const inlinePointerModule = () => {
@@ -3727,7 +3731,8 @@ async function generateAggregatedFiles(componentHierarchyMap, vueFilesPathMap, b
   const base = ensureDir(outDir);
   const outputFile = path.join(base, "page-object-models.g.ts");
   const header = `/// <reference lib="es2015" />
-${eslintSuppressionHeader}/**
+${eslintSuppressionHeader}import type { Locator as PwLocator, Page as PwPage } from "@playwright/test";
+/**
  * Aggregated generated POMs
 ${AUTO_GENERATED_COMMENT}`;
   const content = makeAggregatedContent(header, path.dirname(outputFile), [...views, ...components]);
@@ -5365,8 +5370,16 @@ function createVuePluginWithTestIds(options) {
     ...userCompilerOptions,
     prefixIdentifiers: true,
     nodeTransforms: [
-      // This will be used if the user uses the returned vue plugin.
-      // We'll populate it via the hook below for better compatibility.
+      ...userNodeTransforms,
+      (node, context) => {
+        const filename = context.filename;
+        if (!filename || !filename.endsWith(".vue") || !isFileInScope(filename)) {
+          return;
+        }
+        const transforms = getNodeTransforms(filename);
+        const ourTransform = transforms[transforms.length - 1];
+        return ourTransform(node, context);
+      }
     ]
   };
   const metadataCollectorPlugin = {
@@ -5382,21 +5395,17 @@ function createVuePluginWithTestIds(options) {
       }
       const componentName = getComponentNameFromPath(cleanPath);
       loggerRef.current.debug(`Collecting metadata for ${cleanPath} (component: ${componentName})`);
-      try {
-        const { parse } = await import("@vue/compiler-sfc");
-        const compilerDom2 = await import("@vue/compiler-dom");
-        const compile = compilerDom2.compile;
-        const { descriptor } = parse(code, { filename: cleanPath });
-        if (descriptor.template) {
-          compile(descriptor.template.content, {
-            ...userCompilerOptions,
-            filename: cleanPath,
-            nodeTransforms: getNodeTransforms(cleanPath, componentName)
-          });
-          loggerRef.current.debug(`Metadata collected for ${cleanPath}`);
-        }
-      } catch (e) {
-        loggerRef.current.warn(`Metadata collection failed for ${cleanPath}: ${e}`);
+      const { parse } = await import("@vue/compiler-sfc");
+      const compilerDom2 = await import("@vue/compiler-dom");
+      const compile = compilerDom2.compile;
+      const { descriptor } = parse(code, { filename: cleanPath });
+      if (descriptor.template) {
+        compile(descriptor.template.content, {
+          ...userCompilerOptions,
+          filename: cleanPath,
+          nodeTransforms: getNodeTransforms(cleanPath, componentName)
+        });
+        loggerRef.current.debug(`Metadata collected for ${cleanPath}`);
       }
       return null;
     }