@immense/vue-pom-generator 1.0.52 → 1.0.53

package/README.md

@@ -191,9 +191,10 @@ Exports:
 - `createVuePomGeneratorPlugins()`
 - `vuePomGenerator()` (alias)
 - `defineVuePomGeneratorConfig()`
+- `defineNuxtPomGeneratorConfig()`
 - `@immense/vue-pom-generator/eslint`
 
-## Basic Vite setup
+## Basic Vue/Vite setup
 
 ```ts
 import { defineConfig } from "vite";
@@ -208,7 +209,8 @@ const pomConfig = defineVuePomGeneratorConfig({
   injection: {
     attribute: "data-testid",
     viewsDir: "src/views",
-    scanDirs: ["src"],
+    componentDirs: ["src/components"],
+    layoutDirs: ["src/layouts"],
     wrapperSearchRoots: ["../shared-ui/src/components"],
     nativeWrappers: {
       AppButton: { role: "button" },
@@ -261,6 +263,29 @@ export default defineConfig({
 });
 ```
 
+## Basic Nuxt setup
+
+```ts
+import { defineNuxtConfig } from "nuxt/config";
+import { defineNuxtPomGeneratorConfig, vuePomGenerator } from "@immense/vue-pom-generator";
+
+const pomConfig = defineNuxtPomGeneratorConfig({
+  generation: {
+    outDir: "tests/playwright/__generated__",
+  },
+});
+
+export default defineNuxtConfig({
+  vite: {
+    plugins: [
+      ...vuePomGenerator(pomConfig),
+    ],
+  },
+});
+```
+
+Nuxt projects are auto-detected from standard project artifacts, and their pages/layouts/components are resolved from Nuxt's own config. That means custom page directories such as `dir.pages = "views"` come from `nuxt.config`, while component directories are picked up automatically from Nuxt conventions/config. `defineNuxtPomGeneratorConfig(...)` is optional, but it keeps the config surface Nuxt-specific at type-check time.
+
 ### Important Vite ownership rule
 
 By default, this package creates and returns its own `@vitejs/plugin-vue` instance.
@@ -289,7 +314,7 @@ export default defineConfig({
 });
 ```
 
-Nuxt-style routing also uses the resolved app-owned Vue plugin. In practice, if you use `generation.router.type: "nuxt"`, think in terms of external Vue plugin ownership.
+Nuxt-style routing also uses the resolved app-owned Vue plugin. In practice, Nuxt projects are auto-detected and use external Vue plugin ownership automatically.
 
 ## What gets generated
 
@@ -320,7 +345,7 @@ If you emit outside a `__generated__` path, the generator also manages `.gitattr
 
 This is important if you are deciding whether the tool will fit into a real codebase.
 
-- **Dev server:** on startup, it scans the configured `scanDirs`, compiles each `.vue` file into a snapshot, writes the configured TypeScript outputs once, then batches add/change/delete events and regenerates incrementally.
+- **Dev server:** on startup, it scans the configured Vue page/component/layout directories (or the directories resolved from Nuxt config in Nuxt mode), compiles each `.vue` file into a snapshot, writes the configured TypeScript outputs once, then batches add/change/delete events and regenerates incrementally.
 - **Build:** it generates from the richest build pass it sees, which matters because Vite can run multiple passes (for example SSR plus client). The generator avoids letting a thinner pass clobber a richer one.
 - **Always-on virtual module:** `virtual:testids` is registered whether generation is enabled or disabled.
 - **Generation can be disabled:** `generation: false` still keeps compile-time test-id injection and the virtual module, but skips emitted POM files.
@@ -857,6 +882,30 @@ The sections below follow the actual `VuePomGeneratorPluginOptions` shape from `
   injection: { viewsDir: "app/pages" }
   ```
 
+#### `injection.componentDirs`
+
+- **What it does:** Lists the directories that should be treated as reusable component roots.
+- **Why it exists:** Vue apps often keep components outside a single catch-all tree, and the generator needs explicit component roots now that generic scan lists are gone.
+- **Benefit:** component naming and filesystem supplementation stay aligned with the directories you actually consider components.
+- **Without it:** the generator uses `["src/components"]`.
+- **Example:**
+
+  ```ts
+  injection: { componentDirs: ["src/components", "../shared-ui/src/components"] }
+  ```
+
+#### `injection.layoutDirs`
+
+- **What it does:** Lists layout-style Vue directories that should be included in generation and naming.
+- **Why it exists:** some Vue apps keep shell components outside `views` and `components`, but still want them in the generated POM graph.
+- **Benefit:** layouts participate explicitly without falling back to a generic scan of unrelated folders.
+- **Without it:** the generator uses `["src/layouts"]`.
+- **Example:**
+
+  ```ts
+  injection: { layoutDirs: ["src/layouts"] }
+  ```
+
 #### `injection.nativeWrappers`
 
 - **What it does:** Describes wrapper components so the generator can treat them like native controls.
@@ -910,24 +959,12 @@ The sections below follow the actual `VuePomGeneratorPluginOptions` shape from `
   injection: { excludeComponents: ["LegacyWidget"] }
   ```
 
-#### `injection.scanDirs`
-
-- **What it does:** Sets which directories are scanned for `.vue` files when building the POM graph.
-- **Why it exists:** real projects rarely keep all SFCs under one folder, especially in Nuxt or monorepos.
-- **Benefit:** generation sees the same files your app actually uses.
-- **Without it:** the generator scans `src`.
-- **Example:**
-
-  ```ts
-  injection: { scanDirs: ["src", "components", "layouts"] }
-  ```
-
 #### `injection.wrapperSearchRoots`
 
-- **What it does:** Adds extra roots for wrapper inference outside `scanDirs`.
+- **What it does:** Adds extra roots for wrapper inference outside the configured page/component/layout directories.
 - **Why it exists:** wrapper components often live in sibling packages or shared UI workspaces.
 - **Benefit:** local wrapper inference can still work across package boundaries.
-- **Without it:** no extra wrapper lookup is done outside the scanned app directories.
+- **Without it:** no extra wrapper lookup is done outside the configured app directories.
 - **Example:**
 
   ```ts
@@ -1013,13 +1050,13 @@ If omitted, router introspection is off.
 
 #### `generation.router.type`
 
-- **What it does:** Chooses the router discovery strategy.
-- **Why it exists:** standard Vue-router apps and Nuxt file-based routing need different discovery paths.
-- **Benefit:** one config field covers both app styles.
+- **What it does:** Chooses the Vue-router discovery strategy for standard Vue apps.
+- **Why it exists:** some Vue apps want router introspection without any Nuxt integration.
+- **Benefit:** keeps Vue-router discovery explicit.
 - **Without it:** defaults to `"vue-router"`.
+- **Nuxt note:** Nuxt projects are auto-detected. Do not set `generation.router.type: "nuxt"`.
 - **Current options:**
   - `"vue-router"`
-  - `"nuxt"`
 
 #### `generation.router.moduleShims`
 

package/RELEASE_NOTES.md

@@ -1,43 +1,63 @@
-● # Release Notes: v1.0.52
+● # Release Notes: v1.0.53
 
   ## Highlights
 
-  - Relaxed Vite peer dependency constraint to support newer Vite versions
-  - Improved AST-based handling of nullish coalescing in key expressions
-  - Fixed repository-wide lint failures and updated lint configuration
-  - Enhanced test coverage for utility functions and transform edge cases
+  - **Nuxt auto-detection**: Framework mode is now automatically detected—no manual configuration
+  required
+  - **Simplified configuration**: Removed `scanDirs` option in favor of automatic discovery
+  - **Improved dev-mode reliability**: Multiple fixes for Nuxt app-root POM generation and
+  snapshot preservation
+  - **Cleaner codebase**: Removed unused generation-metrics feature
 
   ## Changes
 
-  **Dependencies**
-  - Relaxed Vite peer dependency version range to improve compatibility with downstream projects
+  ### Configuration & Auto-detection
+  - Auto-detect Nuxt mode without requiring explicit `mode` config
+  - Remove `scanDirs` configuration option (replaced by automatic discovery)
 
-  **Code Quality & Linting**
-  - Added ESLint rule exceptions for generated runtime code patterns
-  - Clarified AST and lint rule interactions in configuration
-  - Polished lint cleanup helper utilities
-  - Fixed existing lint violations across the codebase
+  ### Bug Fixes
+  - Resolve Nuxt app-root dev POM clobber issue
+  - Preserve richer dev POM snapshots during generation
+  - Confirm incomplete dev snapshots to prevent silent failures
 
-  **AST & Transform Logic**
-  - Implemented AST-based splitting for nullish coalescing key expressions
-  - Updated transform logic to handle edge cases more robustly
-  - Improved runtime generation to meet updated lint expectations
-
-  **Testing**
-  - Added test coverage for new utility functions
-  - Updated test expectations for class generation coverage
-  - Enhanced transform tests with additional edge case scenarios
+  ### Internal
+  - Add dedicated Nuxt discovery module (`plugin/nuxt-discovery.ts`)
+  - Remove generation-metrics feature and associated code
+  - Refactor path utilities and plugin creation logic
 
   ## Breaking Changes
 
-  None.
+  - **Removed `scanDirs` config option**: The plugin now uses automatic directory discovery.
+  Remove any `scanDirs` configuration from your setup.
+  - **Removed generation-metrics**: The generation metrics tracking feature has been removed along
+   with `plugin/support/generation-metrics.ts`.
 
   ## Pull Requests Included
 
-  - #13 Relax Vite peer dependency range (https://github.com/immense/vue-pom-generator/pull/13)
+  - #15 [fix: resolve Nuxt app-root dev POM
+  clobber](https://github.com/immense/vue-pom-generator/pull/15) (@dkattan)
+  - #13 [Relax Vite peer dependency range](https://github.com/immense/vue-pom-generator/pull/13)
+  (@Copilot)
+  - #12 [feat: add split Playwright POM output for
+  discoverability](https://github.com/immense/vue-pom-generator/pull/12) (@dkattan)
+  - #11 [feat: fail fast on unnameable wrapper
+  handlers](https://github.com/immense/vue-pom-generator/pull/11) (@dkattan)
+  - #8 [chore: bump version to 1.0.43](https://github.com/immense/vue-pom-generator/pull/8)
+  (@mayfieldiv)
+  - #7 [test: add build–serve parity regression
+  tests](https://github.com/immense/vue-pom-generator/pull/7) (@mayfieldiv)
+  - #6 [fix: fail fast on dev snapshot generation
+  errors](https://github.com/immense/vue-pom-generator/pull/6) (@dkattan)
+  - #5 [fix: dev-mode POM generation parity with build
+  mode](https://github.com/immense/vue-pom-generator/pull/5) (@mayfieldiv)
+  - #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
 
-  All changes validated through existing test suite (`npm test`). Added test coverage for new
-  utility functions and transform edge cases.
+  Added `tests/nuxt-discovery.test.ts` for new Nuxt auto-detection. Significantly expanded
+  `tests/build-serve-parity.test.ts` (+210 lines) and updated multiple test suites for
+  configuration and dev-plugin changes.
 

package/class-generation/index.ts

@@ -336,23 +336,29 @@ async function getRouteMetaByComponent(
   routerEntry?: string,
   routerType?: "vue-router" | "nuxt",
   options: {
-    viewsDir?: string;
-    scanDirs?: string[];
+    pageDirs?: string[];
+    componentDirs?: string[];
+    layoutDirs?: string[];
   } = {},
 ): Promise<Record<string, RouteMeta>> {
   const root = projectRoot ?? process.cwd();
-  const viewsDir = options.viewsDir ?? "src/views";
-  const viewsDirAbs = path.isAbsolute(viewsDir) ? viewsDir : path.resolve(root, viewsDir);
-  const scanDirs = options.scanDirs?.length ? options.scanDirs : ["src"];
+  const pageDirs = options.pageDirs?.length ? options.pageDirs : ["src/views"];
+  const pageDirsAbs = pageDirs.map(dir => path.isAbsolute(dir) ? dir : path.resolve(root, dir));
+  const primaryPageDirAbs = pageDirsAbs[0] ?? path.resolve(root, "src/views");
+  const sourceDirs = [
+    ...pageDirs,
+    ...(options.componentDirs?.length ? options.componentDirs : ["src/components"]),
+    ...(options.layoutDirs?.length ? options.layoutDirs : ["src/layouts"]),
+  ];
   const extraRoots = process.cwd() !== root ? [process.cwd()] : [];
 
   const { routeMetaEntries } = routerType === "nuxt"
-    ? await introspectNuxtPages(root)
+    ? await introspectNuxtPages(root, { pageDirs: pageDirsAbs })
     : await parseRouterFileFromCwd(resolveRouterEntry(root, routerEntry), {
       componentNaming: {
         projectRoot: root,
-        viewsDirAbs,
-        scanDirs,
+        viewsDirAbs: primaryPageDirAbs,
+        sourceDirs,
         extraRoots,
       },
     });
@@ -687,8 +693,9 @@ export interface GenerateFilesOptions {
   /** The type of router introspection to perform. */
   routerType?: "vue-router" | "nuxt";
 
-  viewsDir?: string;
-  scanDirs?: string[];
+  pageDirs?: string[];
+  componentDirs?: string[];
+  layoutDirs?: string[];
 
   routeMetaByComponent?: Record<string, RouteMeta>;
 }
@@ -749,8 +756,9 @@ export async function generateFiles(
     vueRouterFluentChaining,
     routerEntry,
     routerType,
-    viewsDir,
-    scanDirs,
+    pageDirs,
+    componentDirs,
+    layoutDirs,
     routeMetaByComponent: routeMetaByComponentOverride,
   } = options;
 
@@ -763,8 +771,9 @@ export async function generateFiles(
   const routeMetaByComponent = routeMetaByComponentOverride
     ?? (vueRouterFluentChaining
       ? await getRouteMetaByComponent(projectRoot, routerEntry, routerType, {
-        viewsDir,
-        scanDirs,
+        pageDirs,
+        componentDirs,
+        layoutDirs,
       })
       : undefined);
   const generatedFilePaths: string[] = [];

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

@@ -91,8 +91,9 @@ export interface GenerateFilesOptions {
     routerEntry?: string;
     /** The type of router introspection to perform. */
     routerType?: "vue-router" | "nuxt";
-    viewsDir?: string;
-    scanDirs?: string[];
+    pageDirs?: string[];
+    componentDirs?: string[];
+    layoutDirs?: string[];
     routeMetaByComponent?: Record<string, RouteMeta>;
 }
 export declare function generateFiles(componentHierarchyMap: Map<string, IComponentDependencies>, vueFilesPathMap: Map<string, string>, basePageClassPath: string, options?: GenerateFilesOptions): Promise<void>;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../class-generation/index.ts"],"names":[],"mappings":"AAUA,OAAO,EAAkC,oCAAoC,EAAE,MAAM,sBAAsB,CAAC;AAsB5G,OAAO,EACL,sBAAsB,EAMvB,MAAM,UAAU,CAAC;AAQlB,OAAO,EAAE,oCAAoC,EAAE,CAAC;AAqKhD,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;AASD,MAAM,MAAM,yBAAyB,GAAG,YAAY,GAAG,OAAO,CAAC;AAwW/D,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;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,yBAAyB,CAAC;IAEtD,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;AAqCD,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,iBA+FnC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../class-generation/index.ts"],"names":[],"mappings":"AAUA,OAAO,EAAkC,oCAAoC,EAAE,MAAM,sBAAsB,CAAC;AAsB5G,OAAO,EACL,sBAAsB,EAMvB,MAAM,UAAU,CAAC;AAQlB,OAAO,EAAE,oCAAoC,EAAE,CAAC;AAqKhD,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;AASD,MAAM,MAAM,yBAAyB,GAAG,YAAY,GAAG,OAAO,CAAC;AA8W/D,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;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,yBAAyB,CAAC;IAEtD,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,EAAE,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtB,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CAClD;AAqCD,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,iBAiGnC"}