基于文件的路由 API 参考

TanStack Router 的基于文件的路由非常灵活，可以配置以适应您项目的需求。

以下选项可用于配置基于文件的路由

• routesDirectory（必需）
• generatedRouteTree（必需）
• virtualRouteConfig
• routeFilePrefix
• routeFileIgnorePrefix
• indexToken
• routeToken
• quoteStyle
• semicolons
• apiBase
• autoCodeSplitting
• disableTypes
• addExtensions
• disableLogging
• routeTreeFileHeader
• routeTreeFileFooter
• disableManifestGeneration
• enableRouteTreeFormatting

这是路由文件所在目录的路径，相对于 cwd（当前工作目录）。

默认情况下，该值设置为以下值，并且不能设置为空 string 或 undefined。

./src/routes

./src/routes

这是将保存生成的路由树的文件的路径，相对于 cwd（当前工作目录）。

默认情况下，该值设置为以下值，并且不能设置为空 string 或 undefined。

./src/routeTree.gen.ts

./src/routeTree.gen.ts

如果 disableTypes 设置为 true，则生成的路由树将以 .js 扩展名而不是 .ts 保存。

此选项用于配置虚拟文件路由功能。有关更多信息，请参阅“虚拟文件路由”指南。

默认情况下，此值设置为 undefined。

此选项用于忽略路由目录中的特定文件和目录。如果您想“选择加入”您不希望被视为路由的某些文件或目录，这将非常有用。

默认情况下，此值设置为 -。

使用此选项时，它允许您拥有这样的结构，让您可以将不属于路由文件的相关文件放在一起

src/routes
├── posts
│   ├── -components  // Ignored
│   │   ├── Post.tsx
│   ├── index.tsx
│   ├── route.tsx

src/routes
├── posts
│   ├── -components  // Ignored
│   │   ├── Post.tsx
│   ├── index.tsx
│   ├── route.tsx

此选项用于忽略路由目录中的特定文件和目录。它可以以正则表达式格式使用。例如，.((css|const).ts)|test-page 将忽略名称包含 .css.ts、.const.ts 或 test-page 的文件/目录。

默认情况下，此值设置为 undefined。

此选项用于标识路由目录中的路由文件。这意味着只有以此前缀开头的文件才会被视为路由。

默认情况下，此值设置为 ``，因此路由目录中的所有文件都将被视为路由。

正如路由概念指南中提到的，布局路由在指定的路径呈现，子路由在布局路由中呈现。routeToken 用于标识路由目录中的布局路由文件。

默认情况下，此值设置为 route。

🧠 以下文件名将等同于相同的运行时 URL

src/routes/posts.tsx -> /posts
src/routes/posts.route.tsx -> /posts
src/routes/posts/route.tsx -> /posts

src/routes/posts.tsx -> /posts
src/routes/posts.route.tsx -> /posts
src/routes/posts/route.tsx -> /posts

正如路由概念指南中提到的，索引路由是在 URL 路径与父路由完全相同时匹配的路由。indexToken 用于标识路由目录中的索引路由文件。

默认情况下，此值设置为 index。

🧠 以下文件名将等同于相同的运行时 URL

src/routes/posts.index.tsx -> /posts/
src/routes/posts/index.tsx -> /posts/

src/routes/posts.index.tsx -> /posts/
src/routes/posts/index.tsx -> /posts/

当生成生成的路由树以及首次创建新路由时，这些文件将使用您在此处指定的引号样式进行格式化。

默认情况下，此值设置为 single。

当生成生成的路由树以及首次创建新路由时，如果此选项设置为 true，这些文件将使用分号进行格式化。

默认情况下，此值设置为 false。

作为一个框架，TanStack Start 支持 API 路由的概念。此选项配置 API 路由的基本路径。

默认情况下，此值设置为 /api。

这意味着所有 API 路由都将以 /api 为前缀。

此配置值仅在您使用 TanStack Start 时才有用。

此功能仅在您使用 TanStack Router Bundler 插件时可用。

此选项用于为非关键路由配置项启用自动代码分割。有关更多信息，请参阅“自动代码分割”指南。

默认情况下，此值设置为 false。

此选项用于禁用为路由树生成类型。

如果设置为 true，则生成的路由树将不包含任何类型，并将以 .js 文件而不是 .ts 文件写入。

默认情况下，此值设置为 false。

此选项将文件扩展名添加到生成的路由树中的路由名称。

默认情况下，此值设置为 false。

此选项关闭路由生成过程的控制台日志记录。

默认情况下，此值设置为 false。

此选项允许您将内容前置到生成的路由树文件的开头。

默认情况下，此值设置为

[
  "/* eslint-disable */",
  "// @ts-nocheck",
  "// noinspection JSUnusedGlobalSymbols"
]

[
  "/* eslint-disable */",
  "// @ts-nocheck",
  "// noinspection JSUnusedGlobalSymbols"
]

此选项允许您将内容附加到生成的路由树文件的末尾。

默认情况下，此值设置为

[]

[]

TanStack Start 利用 generatedRouteTree 文件来存储 JSON 树，这使得 Start 可以轻松遍历可用的路由树，以了解应用程序的路由结构。此 JSON 树保存在生成的路由树文件的末尾。

此选项允许您禁用 manifest 的生成。

默认情况下，此值设置为 false。

此选项打开生成的路由树文件上的格式化功能，对于大型项目来说，这可能很耗时。

默认情况下，此值设置为 true。