アンプラグイン-vue-ルーター

TS サポートを備えた Vue での自動ファイルベースのルーティング

StackBlitz デモ

このビルド時プラグインはルーティング設定を簡素化し、 TypeScript のおかげで安全かつ使いやすくします。 Vue Router 4.4.0 以上が必要です。

警告

unplugin-vue-router 型指定ルーティングとファイルベースのルーティングは基本的に安定していますが、変更される可能性のある他の実験的な API (データローダーなど) が含まれています。最新情報については、関連するドキュメントを必ずご確認ください。問題や設計上の欠陥を見つけた場合、またはそれを改善するアイデアがある場合は、問題を開くかディスカッションを開いてください。

インストール

npm i -D unplugin-vue-router

Vue プラグインの前にVueRouter プラグインを追加します。

ヴィーテ

 // 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 */
    } ) ,
  ] ,
}

Vue 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 ) を実行して、 type の最初のバージョンを生成する必要があります。次に、タイプをtsconfig.jsonに追加する必要があります。

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

次に、 npm vue create によって作成されたようなenv.d.tsファイルがある場合は、それにunplugin-vue-router/clientタイプを追加します。

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

env.d.tsファイルがない場合は、ファイルを作成して unplugin-vue-router タイプを追加するか、 tsconfig.jsonのtypesプロパティに追加できます。

{
  "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))
   },
 )