отключить-vue-маршрутизатор

Автоматическая маршрутизация на основе файлов в Vue с поддержкой TS

StackBlitz Демо

Этот плагин времени сборки упрощает настройку маршрутизации и делает ее более безопасной и простой в использовании благодаря TypeScript. Требуется Vue Router >= 4.4.0.

Предупреждение

Хотя типизированная маршрутизация unplugin-vue-router и маршрутизация на основе файлов в принципе стабильны, она содержит другие экспериментальные API, которые могут быть изменены (например, загрузчики данных). Обязательно проверьте соответствующую документацию для получения последней информации. Если вы обнаружили какую-либо проблему, недостаток дизайна или у вас есть идеи по его улучшению, откройте проблему или обсудите.

Установить

npm i -D unplugin-vue-router

Добавьте плагин VueRouter перед плагином Vue:

Вите

 // vite.config.ts
import VueRouter from 'unplugin-vue-router/vite'

export default defineConfig ( {
  plugins : [
    VueRouter ( {
      /* options */
    } ) ,
    // ️ Vue must be placed after VueRouter()
    Vue ( ) ,
  ] ,
} )

Пример: playground/

Свернуть

 // rollup.config.js
import VueRouter from 'unplugin-vue-router/rollup'

export default {
  plugins : [
    VueRouter ( {
      /* options */
    } ) ,
    // ️ Vue must be placed after VueRouter()
    Vue ( ) ,
  ] ,
}

Веб-пакет

 // webpack.config.js
module . exports = {
  /* ... */
  plugins : [
    require ( 'unplugin-vue-router/webpack' ) ( {
      /* options */
    } ) ,
  ] ,
}

Вью CLI

 // vue.config.js
module . exports = {
  configureWebpack : {
    plugins : [
      require ( 'unplugin-vue-router/webpack' ) ( {
        /* options */
      } ) ,
    ] ,
  } ,
}

эсбилд

 // esbuild.config.js
import { build } from 'esbuild'
import VueRouter from 'unplugin-vue-router/esbuild'

build ( {
  plugins : [ VueRouter ( ) ] ,
} )

Настраивать

После установки вам следует запустить свой сервер разработки (обычно npm run dev ), чтобы сгенерировать первую версию типов . Затем вам нужно добавить типы в ваш tsconfig.json .

{
  "include" : [
    // ...
    " ./typed-router.d.ts "
  ],
  // ...
  "compilerOptions" : {
    // ...
    "moduleResolution" : " Bundler "
    // ...
  }
}

Затем, если у вас есть файл env.d.ts , подобный тому, который создан npm vue create , добавьте в него типы unplugin-vue-router/client :

 // env.d.ts
/// 
///

Если у вас нет файла env.d.ts , вы можете создать его и добавить в него типы unplugin-vue-router или добавить их в свойство types в вашем tsconfig.json :

{
  "compilerOptions" : {
    // ...
    "types" : [ " unplugin-vue-router/client " ]
  }
}

Наконец, импортируйте сгенерированные маршруты из vue-router/auto-routes и передайте их маршрутизатору:

import { createRouter, createWebHistory } from 'vue-router'
+ import { routes } from 'vue-router/auto-routes'

createRouter({
  history: createWebHistory(),
  // pass the generated routes written by the plugin ?
+  routes,
})

Кроме того, вы также можете импортировать массив routes и создать маршрутизатор вручную или передать его в какой-либо плагин. Вот пример со стартером Vitesse:

 import { ViteSSG } from 'vite-ssg'
 import { setupLayouts } from 'virtual:generated-layouts'
 import App from './App.vue'
 import type { UserModule } from './types'
- import generatedRoutes from '~pages'
+ import { routes } from 'vue-router/auto-routes'

 import '@unocss/reset/tailwind.css'
 import './styles/main.css'
 import 'uno.css'

- const routes = setupLayouts(generatedRoutes)

 // https://github.com/antfu/vite-ssg
 export const createApp = ViteSSG(
   App,
   {
-   routes,
+   routes: setupLayouts(routes),
    base: import.meta.env.BASE_URL
  },
   (ctx) => {
     // install all modules under `modules/`
     Object.values(import.meta.glob<{ install: UserModule }>('./modules/*.ts', { eager: true }))
       .forEach(i => i.install?.(ctx))
   },
 )