@zphhpzzph/vue-route-gen 1.0.0 → 2.0.0

package/dist/vite.js

@@ -0,0 +1,242 @@
+import path from 'node:path';
+import { generateRoutes } from './index.js';
+import { extractRouteMeta, extractRouteConfig } from './extract-meta.js';
+import fs from 'node:fs';
+/**
+ * Vite plugin to handle <route> custom blocks and defineRoute() macro in Vue SFC files
+ *
+ * This plugin removes:
+ * 1. <route> custom blocks from Vue files during development/build
+ * 2. defineRoute() macro calls from <script setup>
+ *
+ * These are extracted at build time by vue-route-gen and merged into route config,
+ * so they should be ignored at runtime to avoid parse errors.
+ *
+ * @example
+ * ```typescript
+ * // vite.config.ts
+ * import { defineConfig } from 'vite';
+ * import vue from '@vitejs/plugin-vue';
+ * import { routeBlockPlugin } from '@zphhpzzph/vue-route-gen/vite';
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     routeBlockPlugin(),
+ *     vue(),
+ *   ],
+ * });
+ * ```
+ */
+export function routeBlockPlugin() {
+    return {
+        name: 'vue-route-blocks',
+        enforce: 'pre',
+        transform(code, id) {
+            if (!id.endsWith('.vue')) {
+                return undefined;
+            }
+            let transformed = code;
+            let hasChanges = false;
+            // Remove <route> custom blocks from the code
+            // They've already been extracted by vue-route-gen
+            const routeBlockRemoved = transformed.replace(/<route[^>]*>[\s\S]*?<\/route>/gi, '');
+            if (routeBlockRemoved !== transformed) {
+                transformed = routeBlockRemoved;
+                hasChanges = true;
+            }
+            // Remove defineRoute() calls from <script setup>
+            // Keep the import statement, remove the call
+            const defineRouteRemoved = removeDefineRouteCalls(transformed);
+            if (defineRouteRemoved !== transformed) {
+                transformed = defineRouteRemoved;
+                hasChanges = true;
+            }
+            // Only return transformed code if something changed
+            if (hasChanges) {
+                return {
+                    code: transformed,
+                    map: null, // No source map needed for this simple transformation
+                };
+            }
+            return undefined;
+        },
+    };
+}
+/**
+ * Vite plugin for auto-generating routes with intelligent incremental updates
+ *
+ * This plugin:
+ * 1. Generates routes on server start
+ * 2. Watches for file changes in pages directory
+ * 3. Performs incremental updates when only route config changes
+ * 4. Only regenerates when route structure changes (add/remove files)
+ *
+ * @example
+ * ```typescript
+ * // vite.config.ts
+ * import { defineConfig } from 'vite';
+ * import { routeGenPlugin } from '@zphhpzzph/vue-route-gen/vite';
+ *
+ * export default defineConfig({
+ *   plugins: [routeGenPlugin()],
+ * });
+ * ```
+ */
+export function routeGenPlugin(options) {
+    let server;
+    const pagesDir = path.resolve(process.cwd(), options?.pagesDir || 'src/pages');
+    const outFile = path.resolve(process.cwd(), options?.outFile || 'src/router/route.gen.ts');
+    // Cache file metadata for incremental updates
+    const fileCache = new Map();
+    const shouldHandle = (file) => {
+        const normalized = path.resolve(file);
+        return normalized.startsWith(`${pagesDir}${path.sep}`) && normalized.endsWith('.vue');
+    };
+    const getFileHash = (filePath) => {
+        try {
+            const stats = fs.statSync(filePath);
+            return `${stats.mtimeMs}-${stats.size}`;
+        }
+        catch {
+            return '0';
+        }
+    };
+    /**
+     * Check if file changes require full regeneration
+     * Returns true if route structure changed (add/remove/rename files)
+     * Returns false if only route config/meta changed (can be incremental)
+     */
+    const needsFullRegeneration = (file, event) => {
+        // Add/unlink always require full regeneration (route structure changes)
+        if (event === 'add' || event === 'unlink') {
+            return true;
+        }
+        // For changes, check if it's just route config/meta or actual content
+        const filePath = path.resolve(file);
+        const currentHash = getFileHash(filePath);
+        const cached = fileCache.get(filePath);
+        if (!cached) {
+            return true; // No cache, need full regeneration
+        }
+        // If file hash changed, extract new config and compare
+        if (cached.hash !== currentHash) {
+            try {
+                const newMeta = extractRouteMeta(filePath);
+                const newConfig = extractRouteConfig(filePath);
+                // Compare with cached config
+                const metaChanged = JSON.stringify(cached.meta) !== JSON.stringify(newMeta);
+                const configChanged = JSON.stringify(cached.config) !== JSON.stringify(newConfig);
+                // Update cache
+                fileCache.set(filePath, { meta: newMeta, config: newConfig, hash: currentHash });
+                // Config/meta changes can be handled incrementally
+                // But for simplicity and correctness, we'll regenerate for now
+                // TODO: Implement true incremental updates
+                return metaChanged || configChanged;
+            }
+            catch {
+                return true; // Error reading file, regenerate
+            }
+        }
+        return false;
+    };
+    /**
+     * Handle file changes with intelligent update strategy
+     */
+    const onChange = async (file, event) => {
+        if (!shouldHandle(file)) {
+            return;
+        }
+        const filePath = path.resolve(file);
+        const needsFull = needsFullRegeneration(file, event);
+        if (needsFull) {
+            // Full regeneration for route structure changes
+            const updated = generateRoutes({ pagesDir, outFile, ...options });
+            if (updated && server) {
+                // Invalidate route gen module cache
+                const module = server.moduleGraph.getModuleById(outFile);
+                if (module) {
+                    server.moduleGraph.invalidateModule(module);
+                }
+                // Trigger full reload to ensure route changes take effect
+                server.ws.send({ type: 'full-reload', path: '*' });
+            }
+        }
+        else {
+            // Incremental update: only update the changed file's config
+            // This is a placeholder for future incremental update logic
+            // For now, we still regenerate to ensure correctness
+            const updated = generateRoutes({ pagesDir, outFile, ...options });
+            if (updated && server) {
+                const module = server.moduleGraph.getModuleById(outFile);
+                if (module) {
+                    server.moduleGraph.invalidateModule(module);
+                }
+            }
+        }
+    };
+    return {
+        name: 'vue-route-gen',
+        enforce: 'pre',
+        buildStart() {
+            // Generate routes on build
+            generateRoutes({ pagesDir, outFile, ...options });
+        },
+        configureServer(_server) {
+            server = _server;
+            // Initial generation
+            generateRoutes({ pagesDir, outFile, ...options });
+            // Watch for file changes
+            const watcher = server.watcher;
+            watcher.on('add', (file) => onChange(file, 'add'));
+            watcher.on('unlink', (file) => onChange(file, 'unlink'));
+            watcher.on('change', (file) => onChange(file, 'change'));
+        },
+        // Handle virtual module for route gen file
+        resolveId(id) {
+            if (id === outFile) {
+                return outFile;
+            }
+        },
+        async load(id) {
+            if (id === outFile) {
+                // Read the generated file
+                try {
+                    return fs.readFileSync(outFile, 'utf-8');
+                }
+                catch {
+                    // File doesn't exist yet, generate it
+                    generateRoutes({ pagesDir, outFile, ...options });
+                    return fs.readFileSync(outFile, 'utf-8');
+                }
+            }
+        },
+        // Hot Module Replacement for route gen file
+        handleHotUpdate({ file, modules }) {
+            if (file === outFile) {
+                server.ws.send({
+                    type: 'full-reload',
+                    path: '*',
+                });
+                return []; // Prevent default HMR handling
+            }
+            return modules;
+        },
+    };
+}
+/**
+ * Remove defineRoute() calls from Vue SFC code
+ * Preserves import statements while removing the macro calls
+ */
+function removeDefineRouteCalls(code) {
+    // Pattern to match defineRoute() calls
+    // Supports:
+    // - const xxx = defineRoute(...)
+    // - defineRoute(...)
+    // - With or without variable assignment
+    // - With or without trailing semicolon
+    const defineRoutePattern = /(?:const|let|var)?\s*\w+\s*=\s*defineRoute\s*\([^)]*\)\s*(?:;|$)?\s*\n?/g;
+    // Replace with a comment
+    return code.replace(defineRoutePattern, '// defineRoute() extracted by vue-route-gen\n');
+}
+export default routeBlockPlugin;
+//# sourceMappingURL=vite.js.map

package/dist/vite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vite.js","sourceRoot":"","sources":["../src/vite.ts"],"names":[],"mappings":"AACA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,cAAc,EAA8B,MAAM,YAAY,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACzE,OAAO,EAAE,MAAM,SAAS,CAAC;AAEzB;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,gBAAgB;IAC9B,OAAO;QACL,IAAI,EAAE,kBAAkB;QACxB,OAAO,EAAE,KAAK;QACd,SAAS,CAAC,IAAI,EAAE,EAAE;YAChB,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBACzB,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,IAAI,WAAW,GAAG,IAAI,CAAC;YACvB,IAAI,UAAU,GAAG,KAAK,CAAC;YAEvB,6CAA6C;YAC7C,kDAAkD;YAClD,MAAM,iBAAiB,GAAG,WAAW,CAAC,OAAO,CAAC,iCAAiC,EAAE,EAAE,CAAC,CAAC;YACrF,IAAI,iBAAiB,KAAK,WAAW,EAAE,CAAC;gBACtC,WAAW,GAAG,iBAAiB,CAAC;gBAChC,UAAU,GAAG,IAAI,CAAC;YACpB,CAAC;YAED,iDAAiD;YACjD,6CAA6C;YAC7C,MAAM,kBAAkB,GAAG,sBAAsB,CAAC,WAAW,CAAC,CAAC;YAC/D,IAAI,kBAAkB,KAAK,WAAW,EAAE,CAAC;gBACvC,WAAW,GAAG,kBAAkB,CAAC;gBACjC,UAAU,GAAG,IAAI,CAAC;YACpB,CAAC;YAED,oDAAoD;YACpD,IAAI,UAAU,EAAE,CAAC;gBACf,OAAO;oBACL,IAAI,EAAE,WAAW;oBACjB,GAAG,EAAE,IAAI,EAAE,sDAAsD;iBAClE,CAAC;YACJ,CAAC;YAED,OAAO,SAAS,CAAC;QACnB,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,cAAc,CAAC,OAAwC;IACrE,IAAI,MAAqB,CAAC;IAC1B,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,QAAQ,IAAI,WAAW,CAAC,CAAC;IAC/E,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,OAAO,IAAI,yBAAyB,CAAC,CAAC;IAC3F,8CAA8C;IAC9C,MAAM,SAAS,GAAG,IAAI,GAAG,EAAsH,CAAC;IAEhJ,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,EAAE;QACpC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtC,OAAO,UAAU,CAAC,UAAU,CAAC,GAAG,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACxF,CAAC,CAAC;IAEF,MAAM,WAAW,GAAG,CAAC,QAAgB,EAAU,EAAE;QAC/C,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACpC,OAAO,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QAC1C,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC,CAAC;IAEF;;;;OAIG;IACH,MAAM,qBAAqB,GAAG,CAAC,IAAY,EAAE,KAAkC,EAAW,EAAE;QAC1F,wEAAwE;QACxE,IAAI,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC1C,OAAO,IAAI,CAAC;QACd,CAAC;QAED,sEAAsE;QACtE,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,WAAW,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAEvC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC,CAAC,mCAAmC;QAClD,CAAC;QAED,uDAAuD;QACvD,IAAI,MAAM,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YAChC,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;gBAC3C,MAAM,SAAS,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;gBAE/C,6BAA6B;gBAC7B,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;gBAC5E,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;gBAElF,eAAe;gBACf,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;gBAEjF,mDAAmD;gBACnD,+DAA+D;gBAC/D,2CAA2C;gBAC3C,OAAO,WAAW,IAAI,aAAa,CAAC;YACtC,CAAC;YAAC,MAAM,CAAC;gBACP,OAAO,IAAI,CAAC,CAAC,iCAAiC;YAChD,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF;;OAEG;IACH,MAAM,QAAQ,GAAG,KAAK,EAAE,IAAY,EAAE,KAAkC,EAAE,EAAE;QAC1E,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,OAAO;QACT,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,SAAS,GAAG,qBAAqB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAErD,IAAI,SAAS,EAAE,CAAC;YACd,gDAAgD;YAChD,MAAM,OAAO,GAAG,cAAc,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;YAClE,IAAI,OAAO,IAAI,MAAM,EAAE,CAAC;gBACtB,oCAAoC;gBACpC,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBACzD,IAAI,MAAM,EAAE,CAAC;oBACX,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;gBAC9C,CAAC;gBACD,0DAA0D;gBAC1D,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;YACrD,CAAC;QACH,CAAC;aAAM,CAAC;YACN,4DAA4D;YAC5D,4DAA4D;YAC5D,qDAAqD;YACrD,MAAM,OAAO,GAAG,cAAc,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;YAClE,IAAI,OAAO,IAAI,MAAM,EAAE,CAAC;gBACtB,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBACzD,IAAI,MAAM,EAAE,CAAC;oBACX,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;gBAC9C,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IAEF,OAAO;QACL,IAAI,EAAE,eAAe;QACrB,OAAO,EAAE,KAAK;QAEd,UAAU;YACR,2BAA2B;YAC3B,cAAc,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;QACpD,CAAC;QAED,eAAe,CAAC,OAAO;YACrB,MAAM,GAAG,OAAO,CAAC;YAEjB,qBAAqB;YACrB,cAAc,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;YAElD,yBAAyB;YACzB,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;YAE/B,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;YACnD,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;YACzD,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC3D,CAAC;QAED,2CAA2C;QAC3C,SAAS,CAAC,EAAE;YACV,IAAI,EAAE,KAAK,OAAO,EAAE,CAAC;gBACnB,OAAO,OAAO,CAAC;YACjB,CAAC;QACH,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,KAAK,OAAO,EAAE,CAAC;gBACnB,0BAA0B;gBAC1B,IAAI,CAAC;oBACH,OAAO,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC3C,CAAC;gBAAC,MAAM,CAAC;oBACP,sCAAsC;oBACtC,cAAc,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;oBAClD,OAAO,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC3C,CAAC;YACH,CAAC;QACH,CAAC;QAED,4CAA4C;QAC5C,eAAe,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE;YAC/B,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;gBACrB,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC;oBACb,IAAI,EAAE,aAAa;oBACnB,IAAI,EAAE,GAAG;iBACV,CAAC,CAAC;gBACH,OAAO,EAAE,CAAC,CAAC,+BAA+B;YAC5C,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,sBAAsB,CAAC,IAAY;IAC1C,uCAAuC;IACvC,YAAY;IACZ,iCAAiC;IACjC,qBAAqB;IACrB,wCAAwC;IACxC,uCAAuC;IACvC,MAAM,kBAAkB,GAAG,0EAA0E,CAAC;IAEtG,yBAAyB;IACzB,OAAO,IAAI,CAAC,OAAO,CACjB,kBAAkB,EAClB,+CAA+C,CAChD,CAAC;AACJ,CAAC;AAED,eAAe,gBAAgB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zphhpzzph/vue-route-gen",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Vue 3 route generator for file-based routing",
   "type": "module",
   "main": "./dist/index.js",
@@ -8,7 +8,13 @@
   "exports": {
     ".": {
       "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./vite": {
+      "import": "./dist/vite.js",
+      "types": "./dist/vite.d.ts",
+      "default": "./dist/vite.js"
     }
   },
   "files": [
@@ -20,8 +26,16 @@
   "scripts": {
     "build": "tsc",
     "dev": "tsc --watch",
+    "type-check": "tsc -b",
     "prepublishOnly": "pnpm run build",
-    "publish": "npm publish --access public --registry https://registry.npmjs.org/"
+    "pre-release": "pnpm run build && npm publish --access public --registry https://registry.npmjs.org/",
+    "release": "pnpm run build && npm publish --access public --registry https://registry.npmjs.org/",
+    "release:patch": "npm version patch && pnpm run release",
+    "release:minor": "npm version minor && pnpm run release",
+    "release:major": "npm version major && pnpm run release",
+    "release:pre": "npm version prepatch && pnpm run pre-release",
+    "release:preminor": "npm version preminor && pnpm run pre-release",
+    "release:premajor": "npm version premajor && pnpm run pre-release"
   },
   "keywords": [
     "vue",
@@ -36,12 +50,15 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/z-ph/signLab-front.git",
+    "url": "https://github.com/z-ph/zphhpzzph-front.git",
     "directory": "packages/vue-route-gen"
   },
-  "homepage": "https://github.com/z-ph/signLab-front/tree/main/packages/vue-route-gen#readme",
+  "homepage": "https://github.com/z-ph/zphhpzzph-front/tree/main/packages/vue-route-gen#readme",
   "bugs": {
-    "url": "https://github.com/z-ph/signLab-front/issues"
+    "url": "https://github.com/z-ph/zphhpzzph-front/issues"
+  },
+  "peerDependencies": {
+    "vue-router": "^4.0.0"
   },
   "devDependencies": {
     "@types/node": "^20.11.0",
@@ -49,5 +66,8 @@
   },
   "engines": {
     "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "@vue/compiler-sfc": "^3.5.26"
   }
-}
+}