@immense/vue-pom-generator 1.0.21 → 1.0.22

package/README.md

@@ -21,7 +21,11 @@ npm install @immense/vue-pom-generator
 
 ## Usage
 
-Exported entrypoint: `createVuePomGeneratorPlugins()`.
+Exported entrypoints:
+
+- `createVuePomGeneratorPlugins()`
+- `vuePomGenerator()` (alias)
+- `defineVuePomGeneratorConfig()` (typed config helper)
 
 ## Configuration
 
@@ -43,102 +47,103 @@ If `generation.playwright.fixtures` is enabled, it also emits:
 
 ```ts
 import { defineConfig } from "vite";
-import vue from "@vitejs/plugin-vue";
-import { createVuePomGeneratorPlugins } from "@immense/vue-pom-generator";
+import { defineVuePomGeneratorConfig, vuePomGenerator } from "@immense/vue-pom-generator";
 
 export default defineConfig(() => {
   const vueOptions = {
     script: { defineModel: true, propsDestructure: true },
   };
 
-  return {
-    plugins: [
-      ...createVuePomGeneratorPlugins({
-        vueOptions,
-        logging: { verbosity: "info" },
-
-        injection: {
-          // Attribute to inject/read as the test id (default: data-testid)
-          attribute: "data-testid",
-
-          // Used to classify Vue files as "views" vs components (default: src/views)
-          viewsDir: "src/views",
-
-          // Directories to scan for .vue files when building the POM library (default: ["src"])
-          // For Nuxt, you might want ["app", "components", "pages", "layouts"]
-          scanDirs: ["src"],
-
-          // Optional: wrapper semantics for design-system components
-          nativeWrappers: {
-            MyButton: { role: "button" },
-            MyInput: { role: "input" },
+  const pomConfig = defineVuePomGeneratorConfig({
+    vueOptions,
+    logging: { verbosity: "info" },
+
+    injection: {
+      // Attribute to inject/read as the test id (default: data-testid)
+      attribute: "data-testid",
+
+      // Used to classify Vue files as "views" vs components (default: src/views)
+      viewsDir: "src/views",
+
+      // Directories to scan for .vue files when building the POM library (default: ["src"])
+      // For Nuxt, you might want ["app", "components", "pages", "layouts"]
+      scanDirs: ["src"],
+
+      // Optional: wrapper semantics for design-system components
+      nativeWrappers: {
+        MyButton: { role: "button" },
+        MyInput: { role: "input" },
+      },
+
+      // Optional: opt specific components out of injection
+      excludeComponents: ["MyButton"],
+
+      // Optional: preserve/overwrite/error when an author already set the attribute
+      existingIdBehavior: "preserve",
+    },
+
+    generation: {
+      // Default: ["ts"]
+      emit: ["ts", "csharp"],
+
+      // C# specific configuration
+      csharp: {
+        // The namespace for generated C# classes (default: Playwright.Generated)
+        namespace: "MyProject.Tests.Generated",
+      },
+
+      // Default: tests/playwright/generated
+      outDir: "tests/playwright/generated",
+
+      // Controls how to handle duplicate generated member names within a single POM class.
+      // - "error": fail compilation
+      // - "warn": warn and suffix
+      // - "suffix": suffix silently (default)
+      nameCollisionBehavior: "suffix",
+
+      // Enable router introspection. When provided, router-aware POM helpers are generated.
+      router: {
+        // For standard Vue apps:
+        entry: "src/router.ts",
+        moduleShims: {
+          "@/config/app-insights": {
+            getAppInsights: () => null,
           },
-
-          // Optional: opt specific components out of injection
-          excludeComponents: ["MyButton"],
-
-          // Optional: preserve/overwrite/error when an author already set the attribute
-          existingIdBehavior: "preserve",
+          "@/store/pinia/app-alert-store": ["useAppAlertsStore"],
         },
-
-        generation: {
-          // Default: ["ts"]
-          emit: ["ts", "csharp"],
-
-          // C# specific configuration
-          csharp: {
-            // The namespace for generated C# classes (default: Playwright.Generated)
-            namespace: "MyProject.Tests.Generated",
-          },
-
-          // Default: tests/playwright/generated
-          outDir: "tests/playwright/generated",
-
-          // Controls how to handle duplicate generated member names within a single POM class.
-          // - "error": fail compilation
-          // - "warn": warn and suffix
-          // - "suffix": suffix silently (default)
-          nameCollisionBehavior: "suffix",
-
-          // Enable router introspection. When provided, router-aware POM helpers are generated.
-          router: {
-            // For standard Vue apps:
-            entry: "src/router.ts",
-            moduleShims: {
-              "@/config/app-insights": {
-                getAppInsights: () => null,
-              },
-              "@/store/pinia/app-alert-store": ["useAppAlertsStore"],
+        // For Nuxt apps (file-based routing):
+        // type: "nuxt"
+      },
+
+      playwright: {
+        fixtures: true,
+        customPoms: {
+          // Default: tests/playwright/pom/custom
+          dir: "tests/playwright/pom/custom",
+          importAliases: { MyCheckBox: "CheckboxWidget" },
+          attachments: [
+            {
+              className: "ConfirmationModal",
+              propertyName: "confirmationModal",
+              attachWhenUsesComponents: ["Page"],
             },
-            // For Nuxt apps (file-based routing):
-            // type: "nuxt"
-          },
-
-          playwright: {
-            fixtures: true,
-            customPoms: {
-              // Default: tests/playwright/pom/custom
-              dir: "tests/playwright/pom/custom",
-              importAliases: { MyCheckBox: "CheckboxWidget" },
-              attachments: [
-                {
-                  className: "ConfirmationModal",
-                  propertyName: "confirmationModal",
-                  attachWhenUsesComponents: ["Page"],
-                },
-              ],
-            },
-          },
+          ],
         },
-      }),
-      vue(vueOptions),
-    ],
+      },
+    },
+  });
+
+  return {
+    plugins: [...vuePomGenerator(pomConfig)],
   };
 });
 ```
 
 Notes:
 
+- `vuePomGenerator(...)` already wires `@vitejs/plugin-vue` internally for non-Nuxt apps.
+- Do not pass `vue()` into `createVuePomGeneratorPlugins(...)`; pass Vue options via `vueOptions`.
+
 - **Injection is enabled by plugin inclusion** (there is no longer an `injection.enabled` flag).
 - **Generation is enabled by default** and can be disabled via `generation: false`.
 - **Router-aware POM helpers are enabled** when `generation.router.entry` is provided (the generator will introspect your router).

package/RELEASE_NOTES.md

@@ -1,31 +1,28 @@
-● ```markdown
+● # Release Notes: v1.0.22
+
   ## Highlights
 
-  - Added support for typed router module shims, enabling better TypeScript integration with Vue
-  Router
-  - Enhanced router introspection capabilities with 150+ lines of new functionality
-  - Expanded test coverage for router introspection and options handling
-  - Improved plugin system with updated type definitions
+  - 🎨 Improved plugin API ergonomics for better developer experience
+  - 📚 Major README documentation updates and reorganization
+  - 🧹 Refactored ASCII character-code helpers to reduce code duplication
+  - 🗑️ Removed unused Playwright fixture file (175 lines cleaned up)
 
   ## Changes
 
-  **Router & TypeScript**
-  - Implemented typed router module shim support
-  - Enhanced router introspection logic with improved type inference
-  - Updated plugin types to accommodate router module shims
-
-  **Plugin System**
-  - Updated `create-vue-pom-generator-plugins.ts` with new plugin configuration
-  - Modified support plugins (build, dev) for typed router compatibility
-  - Enhanced plugin type definitions
+  **Plugin API & Core**
+  - Enhanced plugin creation API in `create-vue-pom-generator-plugins.ts`
+  - Improved `index.ts` exports and main entry point
+  - Updated `transform.ts` with better handling logic
 
-  **Testing & Documentation**
-  - Added new test cases for router introspection (50+ lines)
-  - Expanded options test coverage
-  - Updated README with latest usage information
+  **Code Quality**
+  - DRY refactor of ASCII char-code helper functions across `utils.ts`, `router-introspection.ts`,
+   and `routing/to-directive.ts`
+  - Removed unused `playwright/pomFixture.ts` (175 lines)
+  - Updated ESLint configuration
 
-  **Dependencies**
-  - Version bump to 1.0.21
+  **Documentation & Tests**
+  - Significant README improvements (167 line changes)
+  - Expanded test coverage in `options.test.ts` (24 additions)
 
   ## Breaking Changes
 
@@ -38,7 +35,9 @@
 
   ## Testing
 
-  Comprehensive test coverage added for router introspection functionality and options handling.
-  All tests passing.
-  ```
+  Test suite updated with additional coverage in `options.test.ts`.
+
+  ---
+
+  **Full Changelog**: v1.0.21...v1.0.22
 

package/dist/eslint.config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eslint.config.d.ts","sourceRoot":"","sources":["../eslint.config.ts"],"names":[],"mappings":";AAEA,wBAwFG"}
+{"version":3,"file":"eslint.config.d.ts","sourceRoot":"","sources":["../eslint.config.ts"],"names":[],"mappings":";AAEA,wBA0FG"}

package/dist/index.cjs

@@ -370,10 +370,8 @@ function toPascalCaseRouteKey(value) {
   for (let i = 0; i < value.length; i++) {
     const ch = value[i];
     const code = ch.charCodeAt(0);
-    const isDigit = code >= 48 && code <= 57;
-    const isUpper = code >= 65 && code <= 90;
-    const isLower = code >= 97 && code <= 122;
-    const isAlphaNum = isDigit || isUpper || isLower;
+    const isLower = isAsciiLowercaseLetterCode(code);
+    const isAlphaNum = isAsciiAlphaNumericCode(code);
     if (!isAlphaNum) {
       newWord = true;
       continue;
@@ -526,6 +524,21 @@ function upperFirst(value) {
   }
   return value.charAt(0).toUpperCase() + value.slice(1);
 }
+function isAsciiUppercaseLetterCode(code) {
+  return code >= 65 && code <= 90;
+}
+function isAsciiLowercaseLetterCode(code) {
+  return code >= 97 && code <= 122;
+}
+function isAsciiLetterCode(code) {
+  return isAsciiUppercaseLetterCode(code) || isAsciiLowercaseLetterCode(code);
+}
+function isAsciiDigitCode(code) {
+  return code >= 48 && code <= 57;
+}
+function isAsciiAlphaNumericCode(code) {
+  return isAsciiLetterCode(code) || isAsciiDigitCode(code);
+}
 function staticAttributeValue(value) {
   return { kind: "static", value };
 }
@@ -1557,8 +1570,8 @@ function isAllCapsOrDigits(value) {
   }
   for (let i = 0; i < value.length; i++) {
     const c = value.charCodeAt(i);
-    const isUpper = c >= 65 && c <= 90;
-    const isDigit = c >= 48 && c <= 57;
+    const isUpper = isAsciiUppercaseLetterCode(c);
+    const isDigit = isAsciiDigitCode(c);
     if (!isUpper && !isDigit) {
       return false;
     }
@@ -1570,17 +1583,14 @@ function startsWithDigit(value) {
     return false;
   }
   const c = value.charCodeAt(0);
-  return c >= 48 && c <= 57;
+  return isAsciiDigitCode(c);
 }
 function stripNonIdentifierChars(value) {
   let out = "";
   for (let i = 0; i < value.length; i++) {
     const c = value.charCodeAt(i);
-    const isUpper = c >= 65 && c <= 90;
-    const isLower = c >= 97 && c <= 122;
-    const isDigit = c >= 48 && c <= 57;
     const isUnderscore = c === 95;
-    if (isUpper || isLower || isDigit || isUnderscore) {
+    if (isAsciiAlphaNumericCode(c) || isUnderscore) {
       out += value[i];
     }
   }
@@ -2348,12 +2358,6 @@ function debugLog(message) {
     console.log(`[vue-pom-generator][router-introspection] ${message}`);
   }
 }
-function isAsciiLetterCode(code) {
-  return code >= 65 && code <= 90 || code >= 97 && code <= 122;
-}
-function isAsciiDigitCode(code) {
-  return code >= 48 && code <= 57;
-}
 function isIdentifierStartCode(code) {
   return code === 95 || code === 36 || isAsciiLetterCode(code);
 }
@@ -4155,15 +4159,13 @@ function tryExtractStableHintFromConditionalExpressionSource(source) {
     const v = value.trim();
     if (!v)
       return false;
-    const isAlpha = (ch) => ch >= 65 && ch <= 90 || ch >= 97 && ch <= 122;
-    const isDigit = (ch) => ch >= 48 && ch <= 57;
     const isUnderscore = (ch) => ch === 95;
     const first = v.charCodeAt(0);
-    if (!isAlpha(first))
+    if (!isAsciiLetterCode(first))
       return false;
     for (let i = 1; i < v.length; i += 1) {
       const ch = v.charCodeAt(i);
-      if (isAlpha(ch) || isDigit(ch) || isUnderscore(ch)) {
+      if (isAsciiLetterCode(ch) || isAsciiDigitCode(ch) || isUnderscore(ch)) {
         continue;
       }
       return false;
@@ -4222,7 +4224,7 @@ function tryExtractStableHintFromConditionalExpressionSource(source) {
 }
 function tryInferNativeWrapperRoleFromSfc(tag, vueFilesPathMap) {
   const first = tag.charCodeAt(0);
-  const isUpper = first >= 65 && first <= 90;
+  const isUpper = isAsciiUppercaseLetterCode(first);
   if (!isUpper)
     return null;
   const cached = inferredNativeWrapperConfigByTag.get(tag);
@@ -4541,7 +4543,7 @@ function createTestIdTransform(componentName, componentHierarchyMap, nativeWrapp
     const isComponentLikeTag = (tag) => {
       if (!tag) return false;
       const first = tag.charCodeAt(0);
-      const isUpper = first >= 65 && first <= 90;
+      const isUpper = isAsciiUppercaseLetterCode(first);
       return isUpper || tag.includes("-");
     };
     if (isComponentLikeTag(element.tag)) {
@@ -5603,7 +5605,29 @@ function assertRouterModuleShims(value, name) {
 function resolveFromProjectRoot(projectRoot, maybePath) {
   return path.isAbsolute(maybePath) ? maybePath : path.resolve(projectRoot, maybePath);
 }
+function assertNotVitePluginInstance(options) {
+  const candidate = options;
+  const pluginLikeKeys = [
+    "name",
+    "enforce",
+    "apply",
+    "transform",
+    "resolveId",
+    "load",
+    "config",
+    "configResolved",
+    "handleHotUpdate"
+  ];
+  const pluginLikeKey = pluginLikeKeys.find((key) => key in candidate);
+  if (!pluginLikeKey) {
+    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.`
+  );
+}
 function createVuePomGeneratorPlugins(options = {}) {
+  assertNotVitePluginInstance(options);
   const injection = options.injection ?? {};
   const generationSetting = options.generation;
   const generationOptions = generationSetting === false ? null : generationSetting ?? {};
@@ -5720,6 +5744,11 @@ function createVuePomGeneratorPlugins(options = {}) {
   }
   return resultPlugins;
 }
+function defineVuePomGeneratorConfig(options) {
+  return options;
+}
 exports.createVuePomGeneratorPlugins = createVuePomGeneratorPlugins;
 exports.default = createVuePomGeneratorPlugins;
+exports.defineVuePomGeneratorConfig = defineVuePomGeneratorConfig;
+exports.vuePomGenerator = createVuePomGeneratorPlugins;
 //# sourceMappingURL=index.cjs.map