unplugin-vue-router 使用教程

1. 项目的目录结构及介绍

unplugin-vue-router 是一个用于 Vue Router 的插件，它通过自动生成路由配置来简化路由设置。以下是该项目的典型目录结构：

unplugin-vue-router/
├── src/
│   ├── components/
│   ├── layouts/
│   ├── pages/
│   └── main.ts
├── public/
├── package.json
├── tsconfig.json
├── vite.config.ts
└── README.md

• src/：包含项目的源代码。
  • components/：存放可复用的 Vue 组件。
  • layouts/：存放页面布局组件。
  • pages/：存放页面组件，每个文件对应一个路由。
  • main.ts：项目的入口文件。
• public/：存放静态资源文件。
• package.json：项目的依赖和脚本配置。
• tsconfig.json：TypeScript 配置文件。
• vite.config.ts：Vite 配置文件。
• README.md：项目说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/main.ts，它负责初始化 Vue 应用并挂载到 DOM 上。以下是一个典型的 main.ts 文件内容：

import { createApp } from 'vue'
import App from './App.vue'
import { createRouter, createWebHistory } from 'vue-router'
import routes from 'vue-router/auto-routes'

const router = createRouter({
  history: createWebHistory(),
  routes,
})

const app = createApp(App)
app.use(router)
app.mount('#app')

• createApp(App)：创建 Vue 应用实例。
• createRouter：创建 Vue Router 实例。
• createWebHistory：使用 HTML5 历史模式。
• routes：自动生成的路由配置。
• app.use(router)：将路由实例挂载到应用上。
• app.mount('#app')：将应用挂载到 DOM 元素上。

3. 项目的配置文件介绍

vite.config.ts

Vite 配置文件 vite.config.ts 负责配置 Vite 构建工具。以下是一个典型的配置内容：

import { defineConfig } from 'vite'
import VueRouter from 'unplugin-vue-router/vite'
import Vue from '@vitejs/plugin-vue'

export default defineConfig({
  plugins: [
    VueRouter({ /* options */ }),
    Vue(),
  ],
})

• VueRouter：配置 unplugin-vue-router 插件。
• Vue：配置 Vue 插件。

tsconfig.json

TypeScript 配置文件 tsconfig.json 负责配置 TypeScript 编译选项。以下是一个典型的配置内容：

{
  "compilerOptions": {
    "target": "esnext",
    "module": "esnext",
    "moduleResolution": "node",
    "strict": true,
    "jsx": "preserve",
    "sourceMap": true,
    "resolveJsonModule": true,
    "esModuleInterop": true,
    "lib": ["esnext", "dom"]
  },
  "include": ["src/**/*.ts", "src/**/*.tsx", "src/**/*.vue"]
}

• compilerOptions：编译选项。
• include：指定包含的文件。

通过以上配置，可以确保项目正确地使用 TypeScript 和 Vite 进行开发和构建。