Registry / web-framework / vite-plugin-generate-route

vite-plugin-generate-route

library1.0.16jsnpmunverified

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.

web-framework

npm install vite-plugin-generate-route

package ↗

INSTALL

IMPORT

SIG · VITE-PLUGIN-GENERA

vite-plugin-generate-route

web-frameworkjavascriptv1.0.16

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–223 runs

build_error

glibc

node 18–223 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import VitePluginGenerateRoute from 'vite-plugin-generate-route'

✗ const VitePluginGenerateRoute = require('vite-plugin-generate-route')

ESM-only package. CommonJS require will fail with ERR_REQUIRE_ESM.

VitePluginGenerateRoute

✓ import VitePluginGenerateRoute from 'vite-plugin-generate-route'

✗ import { VitePluginGenerateRoute } from 'vite-plugin-generate-route'

Default export, not named. Named import yields undefined.

VitePluginGenerateRoute (type)

✓ import type { Options } from 'vite-plugin-generate-route'

TypeScript users can import Options type. Versions <1.0.10 did not export types.

Configures the plugin and uses generated routes in Vue Router setup.

// vite.config.js import { defineConfig } from 'vite' import VitePluginGenerateRoute from 'vite-plugin-generate-route' export default defineConfig({ plugins: [ VitePluginGenerateRoute({ pageDir: 'src/views', routesFile: 'src/routes/generateRoutes.js' }) ] }) // src/router/index.js import { createRouter, createWebHistory } from 'vue-router' import routes from './routes/generateRoutes' export default createRouter({ history: createWebHistory(), routes })

Debug

Known issues

breakingvite-plugin-generate-route is ESM-only. Do not use require().

fix

Use import statement. Change commonjs to ES module in vite.config.

affects: >=1.0.0

gotchaRoutes file is overwritten on each dev server start or build. Manual edits will be lost.

fix

Do not edit the output routes file directly. Adjust pageDir or configuration instead.

affects: >=1.0.0

gotchaRoute naming collisions: two files with same name in different directories will cause duplicate route names.

fix

Use unique file names or customize page.js to set explicit name via metadata.

affects: >=1.0.0

deprecatedSupport for Vite 2.x was dropped in version 1.0.0. Using Vite 2.x will cause errors.

fix

Upgrade to Vite >=3.0.0.

affects: >=1.0.0

Errors

Common errors & fixes

ERR_REQUIRE_ESM: require() of ES Module not supported

Using require() instead of import for the plugin.

fix

Change to 'import VitePluginGenerateRoute from 'vite-plugin-generate-route'' and ensure package.json has 'type': 'module'.

Error: Cannot find module 'src/routes/generateRoutes.js'

Routes file path is relative to project root but import path uses incorrect relative reference.

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').

Upgrade

Version history

1.0.16latest on npm

Audit

Dependencies

viterequiredPeer dependency: requires Vite >=3.0.0 as build tool

Agent activity

5 hits · last 30 days

node

OpenAI (training)

Resources

packagehttps://www.npmjs.com/package/vite-plugin-generate-route ↗