# @bunchtogether/vite-plugin-flow 中文文档

规范地址：https://npmcn.com/package/%40bunchtogether/vite-plugin-flow/

版本：1\.0\.2
npm 元数据更新时间：2022-04-04T21:05:42.718Z
中文译文更新时间：2026-11-08T19:43:44.399Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40bunchtogether/vite-plugin-flow
原文对照：https://npmcn.com/package/%40bunchtogether/vite-plugin-flow/?lang=original
项目主页：https://github.com/bunchtogether/vite-plugin-flow#readme
源码仓库：https://github.com/bunchtogether/vite-plugin-flow

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：32.1 kB，10 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：2 个
- 首次发布：2021-06-17T17:26:17.435Z
- 最新版本发布：2022-02-16T20:09:34.268Z
- 近 30 天下载量：464881（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

支助 [流动静态类型检查](https://flow.org/) 内 [维特](https://vitejs.dev/)

## 安装

```sh
npm install @bunchtogether/vite-plugin-flow
```

也可以使用：`pnpm add @bunchtogether/vite-plugin-flow`、`yarn add @bunchtogether/vite-plugin-flow`、`bun add @bunchtogether/vite-plugin-flow`

## README

# 静脉插流

支助 [流动静态类型检查](https://flow.org/) 内 [维特](https://vitejs.dev/)

## 安装

```shell
npm install @bunchtogether/vite-plugin-flow --save-dev
```

或者说

```shell
yarn add @bunchtogether/vite-plugin-flow --dev
```

## 使用量

```js
import { flowPlugin, esbuildFlowPlugin } from '@bunchtogether/vite-plugin-flow';

export default {
  optimizeDeps: {
    esbuildOptions: {
      plugins: [esbuildFlowPlugin()]
    }
  },
  plugins: [
    flowPlugin()
  ]
}
```

## API 密码

#### 目录

-   [流线](https://npmcn.com/package/%40bunchtogether/vite-plugin-flow/#readme-flowplugin)
    -   [参数](https://npmcn.com/package/%40bunchtogether/vite-plugin-flow/#readme-parameters)
-   [建立花纹笔](https://npmcn.com/package/%40bunchtogether/vite-plugin-flow/#readme-esbuildflowplugin)
    -   [参数](https://npmcn.com/package/%40bunchtogether/vite-plugin-flow/#readme-parameters-1)

### 流线

创建 Vite 插件对象

#### 参数

-   `options` **[对象](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)? 吗?** 过滤选项( 可选, 默认) `{include:/\.(flow|jsx?)$/,exclude:/node_modules/,flow:{all:false,pretty:false,ignoreUninitializedFields:false}}`(中文(简体) )
    
    -   `options.include` **(单位:千美元)[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [正则表达式](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp) | [阵列](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)< (\[[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [正则表达式](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp)( > )** 字符串和/或正则表达式匹配文件路径以包含(可选,默认) `/\.(flow|jsx?)$/`(中文(简体) )
    -   `options.exclude` **(单位:千美元)[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [正则表达式](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp) | [阵列](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)< (\[[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [正则表达式](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp)( > )** 匹配文件路径的字符串和/或正则表达式以排除(可选,默认) `/node_modules/`(中文(简体) )

回返 **维特普卢金** 返回 esbuilding 插件对象

### 建立花纹笔

-   **见**数字 : [新建插件文档](https://esbuild.github.io/plugins/#resolve-callbacks)

创建 esbuilding 插件对象

#### 参数

-   `filter` **[正则Exp](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp)** 匹配待处理文件路径的正则表达式( 可选, 默认) `/\.(flow|jsx?)$/`(中文(简体) )
    
-   `loaderFunction` **[函数](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 接受文件路径并返回 esbuilt 加载器类型的函数(可选,默认) `(path)=>(/\.jsx$/.test(path)?'jsx':'js')`(中文(简体) )
    
-   `flowOptions` **[对象](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 要传递到流移类型的选项( 可选, 默认) `{all:false,pretty:false,ignoreUninitializedFields:false}`(中文(简体) )
    
    -   `flowOptions.all` **[布尔](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 如果为真, 请在解析前绕过@ flow pragma 注释 。 (可选,默认) `false`(中文(简体) )
    -   `flowOptions.pretty` **[布尔](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 如果为真,则完全删除类型,而不是取而代之。 (可选,默认) `false`(中文(简体) )
    -   `flowOptions.ignoreUninitializedFields` **[布尔](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 如果为真,则删除未初始化的类字段(`foo;`, (中文(简体) ), `foo: string;`(中文(简体) ) 而不是仅仅删除类型。 这不是Spec 满意! 相反,使用 `declare foo: string;` 只用于类型字段。 (可选,默认) `false`(中文(简体) )

回返 **积木** 返回 esbuilding 插件对象

## 常见问题

### @bunchtogether/vite-plugin-flow 是什么？

支助 流动静态类型检查 内 维特

### 如何安装 @bunchtogether/vite-plugin-flow？

在项目目录运行 npm install @bunchtogether/vite-plugin-flow，或使用 pnpm add / yarn add / bun add。

### @bunchtogether/vite-plugin-flow 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/bunchtogether\_\_vite-plugin-flow 是否存在。

### @bunchtogether/vite-plugin-flow 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @bunchtogether/vite-plugin-flow 可以商用吗？

@bunchtogether/vite-plugin-flow 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @bunchtogether/vite-plugin-flow 的下载量有多少？

根据 npm 官方下载统计，@bunchtogether/vite-plugin-flow 在 2026/10/09 – 2026/11/07 这 30 天内被下载 464,881 次，日均约 15,496 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @bunchtogether/vite-plugin-flow 还在维护吗？

最新版本 1\.0\.2 发布于 2022/02/17（4 年前）；至今共发布 3 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/06/18。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。