{"id":22674,"library":"vite-plugin-generate-route","title":"vite-plugin-generate-route","description":"Vite plugin for automatic Vue Router route generation based on file system structure. Version 1.0.16, actively maintained. Scans a specified directory for Vue components and metadata files to produce a routes file with lazy-loading imports. Supports nested routes, auto-redirects, and optional per-route metadata. Requires Vite >=3.0.0 and Node >=14. Differentiated by tight Vue Router integration and zero-config file-based routing.","status":"active","version":"1.0.16","language":"javascript","source_language":"en","source_url":null,"tags":["javascript","vite","plugin","generate","routes","vue-router"],"install":[{"cmd":"npm install vite-plugin-generate-route","lang":"bash","label":"npm"},{"cmd":"yarn add vite-plugin-generate-route","lang":"bash","label":"yarn"},{"cmd":"pnpm add vite-plugin-generate-route","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Peer dependency: requires Vite >=3.0.0 as build tool","package":"vite","optional":false}],"imports":[{"note":"ESM-only package. CommonJS require will fail with ERR_REQUIRE_ESM.","wrong":"const VitePluginGenerateRoute = require('vite-plugin-generate-route')","symbol":"default","correct":"import VitePluginGenerateRoute from 'vite-plugin-generate-route'"},{"note":"Default export, not named. Named import yields undefined.","wrong":"import { VitePluginGenerateRoute } from 'vite-plugin-generate-route'","symbol":"VitePluginGenerateRoute","correct":"import VitePluginGenerateRoute from 'vite-plugin-generate-route'"},{"note":"TypeScript users can import Options type. Versions <1.0.10 did not export types.","wrong":null,"symbol":"VitePluginGenerateRoute (type)","correct":"import type { Options } from 'vite-plugin-generate-route'"}],"quickstart":{"code":"// vite.config.js\nimport { defineConfig } from 'vite'\nimport VitePluginGenerateRoute from 'vite-plugin-generate-route'\n\nexport default defineConfig({\n  plugins: [\n    VitePluginGenerateRoute({\n      pageDir: 'src/views',\n      routesFile: 'src/routes/generateRoutes.js'\n    })\n  ]\n})\n\n// src/router/index.js\nimport { createRouter, createWebHistory } from 'vue-router'\nimport routes from './routes/generateRoutes'\n\nexport default createRouter({\n  history: createWebHistory(),\n  routes\n})","lang":"javascript","description":"Configures the plugin and uses generated routes in Vue Router setup."},"warnings":[{"fix":"Use import statement. Change commonjs to ES module in vite.config.","message":"vite-plugin-generate-route is ESM-only. Do not use require().","severity":"breaking","affected_versions":">=1.0.0"},{"fix":"Do not edit the output routes file directly. Adjust pageDir or configuration instead.","message":"Routes file is overwritten on each dev server start or build. Manual edits will be lost.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Use unique file names or customize page.js to set explicit name via metadata.","message":"Route naming collisions: two files with same name in different directories will cause duplicate route names.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Upgrade to Vite >=3.0.0.","message":"Support for Vite 2.x was dropped in version 1.0.0. Using Vite 2.x will cause errors.","severity":"deprecated","affected_versions":">=1.0.0"}],"env_vars":null,"last_verified":"2026-04-27T00:00:00.000Z","next_check":"2026-07-26T00:00:00.000Z","problems":[{"fix":"Change to 'import VitePluginGenerateRoute from 'vite-plugin-generate-route'' and ensure package.json has 'type': 'module'.","cause":"Using require() instead of import for the plugin.","error":"ERR_REQUIRE_ESM: require() of ES Module not supported"},{"fix":"Ensure the routesFile option is set to an absolute or correct relative path (e.g., 'src/routes/generateRoutes.js' and imported from a file at 'src/router/index.js' as './routes/generateRoutes').","cause":"Routes file path is relative to project root but import path uses incorrect relative reference.","error":"Error: Cannot find module 'src/routes/generateRoutes.js'"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}