使用 Webpack 安装

使用 Webpack 安装

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

npm install -D @tanstack/router-plugin

npm install -D @tanstack/router-plugin

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

tsx

// webpack.config.ts
import { TanStackRouterWebpack } from '@tanstack/router-plugin/webpack'

export default {
  plugins: [
    TanStackRouterWebpack({ target: 'react', autoCodeSplitting: true }),
  ],
}

// webpack.config.ts
import { TanStackRouterWebpack } from '@tanstack/router-plugin/webpack'

export default {
  plugins: [
    TanStackRouterWebpack({ target: 'react', autoCodeSplitting: true }),
  ],
}

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

现在您已将插件添加到您的 Webpack 配置中，您就可以开始使用 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 插件与 Webpack 用于基于文件的路由时，它带有一些合理的默认设置，这些设置应适用于大多数项目

json

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

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

如果这些默认设置适用于您的项目，则您无需进行任何配置！但是，如果您需要自定义配置，可以通过编辑传递到 TanStackRouterWebpack 函数的配置对象来完成。

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

忽略生成的路由树文件

配置

订阅 Bytes

订阅 Bytes