使用 Vite 安装

要将基于文件的路由与 Vite 结合使用，您需要安装 @tanstack/router-plugin 包。

npm install -D @tanstack/router-plugin

npm install -D @tanstack/router-plugin

安装完成后，您需要将插件添加到您的 Vite 配置中。

// vite.config.ts
import { defineConfig } from 'vite'
import solid from 'vite-plugin-solid'
import { TanStackRouterVite } from '@tanstack/router-plugin/vite'

// https://vite.ac.cn/config/
export default defineConfig({
  plugins: [
    TanStackRouterVite({ target: 'solid', autoCodeSplitting: true }),
    solid(),
    // ...
  ],
})

// vite.config.ts
import { defineConfig } from 'vite'
import solid from 'vite-plugin-solid'
import { TanStackRouterVite } from '@tanstack/router-plugin/vite'

// https://vite.ac.cn/config/
export default defineConfig({
  plugins: [
    TanStackRouterVite({ target: 'solid', autoCodeSplitting: true }),
    solid(),
    // ...
  ],
})

如果您正在使用 TypeScript，您还应该将以下选项添加到您的 tsconfig.json

json

{
  "compilerOptions": {
    "jsx": "preserve",
    "jsxImportSource": "solid-js"
  }
}

{
  "compilerOptions": {
    "jsx": "preserve",
    "jsxImportSource": "solid-js"
  }
}

或者，您可以克隆我们的 Quickstart Vite 示例并开始使用。

现在您已将插件添加到您的 Vite 配置中，您已准备好开始使用 TanStack Router 的基于文件的路由。

忽略生成的路由树文件

如果您的项目配置为使用 linter 和/或 formatter，您可能需要忽略生成的路由树文件。此文件由 TanStack Router 管理，因此不应被您的 linter 或 formatter 更改。

以下是一些资源可以帮助您忽略生成的路由树文件

警告

如果您正在使用 VSCode，您可能会在重命名路由后意外地打开路由树文件（并出现错误）。

您可以通过在 VSCode 设置中将文件标记为只读来防止这种情况。我们的建议是将它也从搜索结果和文件监视器中排除，使用以下设置

json

{
  "files.readonlyInclude": {
    "**/routeTree.gen.ts": true
  },
  "files.watcherExclude": {
    "**/routeTree.gen.ts": true
  },
  "search.exclude": {
    "**/routeTree.gen.ts": true
  }
}

{
  "files.readonlyInclude": {
    "**/routeTree.gen.ts": true
  },
  "files.watcherExclude": {
    "**/routeTree.gen.ts": true
  },
  "search.exclude": {
    "**/routeTree.gen.ts": true
  }
}

您可以在用户级别使用这些设置，也可以通过在项目根目录创建 .vscode/settings.json 文件，仅用于单个工作区。

配置

当将 TanStack Router 插件与 Vite 用于基于文件的路由时，它带有一些合理的默认值，应该适用于大多数项目

json

{
  "routesDirectory": "./src/routes",
  "generatedRouteTree": "./src/routeTree.gen.ts",
  "routeFileIgnorePrefix": "-",
  "quoteStyle": "single"
}

{
  "routesDirectory": "./src/routes",
  "generatedRouteTree": "./src/routeTree.gen.ts",
  "routeFileIgnorePrefix": "-",
  "quoteStyle": "single"
}

如果这些默认值适用于您的项目，您根本不需要配置任何内容！但是，如果您需要自定义配置，您可以通过编辑传递到 TanStackRouterVite 函数的配置对象来完成。

您可以在基于文件的路由 API 参考中找到所有可用的配置选项。

忽略生成的路由树文件

配置

订阅 Bytes

订阅 Bytes