vite-plugin-write-robots

一个用于在Vite构建时自动生成 robots.txt 文件的插件，适用于非生产环境，支持自定义内容和文件名。

安装

npm install vite-plugin-write-robots --save-dev

content 优先级说明

插件生成 robots.txt 时，内容的获取顺序如下：

1. 优先使用 options.content 配置项，如未设置：
2. 尝试读取项目根目录下 .robots.{mode}.txt 文件（如 .robots.development.txt、.robots.production.txt），如未找到：
3. 使用内置默认内容：

   User-agent: *
   Disallow: /

其中 {mode} 为当前 Vite 的构建模式（如 development/production）。

用法

在 vite.config.ts 或 vite.config.js 中引入并使用插件：

import { defineConfig } from 'vite'
import { WriteRobots } from 'vite-plugin-write-robots'

export default defineConfig({
  plugins: [
    WriteRobots({
      // 是否启用插件，默认仅非生产环境生成
      enabled: (config) => config.mode !== 'production',
      // 优先级最高，直接指定内容
      content: `User-agent: *\nDisallow: /api`,
      // 也可以不指定 content，此时会自动查找根目录 .robots.{mode}.txt 文件
      filename: 'robots.txt'
    })
  ]
})

RobotsPluginOptions 接口

插件支持如下配置项（TypeScript 类型定义）：

export interface RobotsPluginOptions {
  /**
   * 是否启用插件。可根据 Vite 配置动态判断，默认仅非生产环境启用。
   */
  enabled?: (config: ResolvedConfig) => boolean;
  /**
   * robots.txt 文件内容，优先级最高，支持多行（可用模板字符串或\n）。未设置时自动查找根目录 `.robots.{mode}.txt`，再无则用默认内容
   */
  content?: string;
  /**
   * 生成的文件名，默认为 'robots.txt'
   */
  filename?: string;
}

参数说明

| 参数 | 类型 | 说明 | | --------- | -------------------------------------- | -------------------------------------- | | enabled | (config: ResolvedConfig) => boolean | 是否启用插件，默认仅非生产环境启用 | | content | string | robots.txt 文件内容，优先级最高，支持多行（可用模板字符串或\n）。未设置时自动查找根目录 .robots.{mode}.txt，再无则用默认内容 | | filename | string | 生成的文件名，默认 robots.txt |

说明

• 插件会在构建结束后自动在输出目录生成 robots.txt 文件。
• content 获取顺序为：options.content > 根目录 .robots.{mode}.txt > 默认内容。
• 可通过 enabled 参数灵活控制生成时机。
• 支持自定义内容和文件名。

License

MIT