# @carbonorm/barrelsby 中文文档

规范地址：https://npmcn.com/package/%40carbonorm/barrelsby/

版本：1\.0\.0
npm 元数据更新时间：2024-03-05T19:08:28.227Z
中文译文更新时间：2026-11-09T08:40:53.427Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：168 kB，118 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=6\.0\.0
- 运行依赖：3 个
- 首次发布：2024-03-05T18:54:48.462Z
- 最新版本发布：2024-03-05T19:08:27.705Z
- 近 30 天下载量：3426（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

自动为您的整个代码基础打入脚本桶

## 安装

```sh
npm install @carbonorm/barrelsby
```

也可以使用：`pnpm add @carbonorm/barrelsby`、`yarn add @carbonorm/barrelsby`、`bun add @carbonorm/barrelsby`

## README

# ![Barrelsby Logo](https://github.com/bencoveney/barrelsby/blob/master/img/logo.png?raw=true)

自动为您的整个代码基础创建类型脚本桶 .

[![npm version](https://badge.fury.io/js/barrelsby.svg)](https://badge.fury.io/js/barrelsby) [![Node.js CI](https://github.com/bencoveney/barrelsby/actions/workflows/node.js.yml/badge.svg?branch=master)](https://github.com/bencoveney/barrelsby/actions/workflows/node.js.yml) [![CodeQL](https://github.com/bencoveney/barrelsby/actions/workflows/codeql-analysis.yml/badge.svg?branch=master)](https://github.com/bencoveney/barrelsby/actions/workflows/codeql-analysis.yml)

## 关于弹匣

桶是将多个模块导出到单个方便模块的文件 通常名称 `index.ts`。它们往往有助于简化顶端的大块进口报表 ,帮助组合相关功能.

一个桶文件看起来像这样:

```TypeScript
export * from "./DropDown";
export * from "./TextBox";
export * from "./CheckBox";
export * from "./DateTimePicker";
export * from "./Slider";
```

它可以帮助你从混乱的进口 像这样:

```TypeScript
import {DropDown} from "./src/controls/DropDown";
import {TextBox} from "./src/controls/TextBox";
import {CheckBox} from "./src/controls/CheckBox";
import {DateTimePicker} from "./src/controls/DateTimePicker";
import {Slider} from "./src/controls/Slider";
```

...像这样的东西:

```TypeScript
import {DropDown, TextBox, CheckBox, DateTimePicker, Slider} from "./src/controls";
```

...甚至这个:

```TypeScript
import * as Controls from "./src/controls/index";
```

### 更多阅读

-   [纹身编码博客](http://tattoocoder.com/angular2-barrels/)

### 巴列斯比文章

-   [卢佩什·蒂瓦里博客](http://rupeshtiwari.com/create-barrel/)
-   [中型条款](https://medium.com/@klauskpm/do-a-barrel-export-aa5b79b76b05)

### 替代品

-   [弹匣](https://github.com/sw-yx/barrelbot)
-   [creeate-index (中文(简体) )](https://github.com/gajus/create-index)

## 使用量

要安装 Barrelsby :

```
npm install --save-dev barrelsby
```

运行桶比先在 `package.json` 文件 :

```json
{
  "scripts": {
    "generate-barrels": "barrelsby --delete"
  }
}
```

您现在可以生成桶 :

```
npm run generate-barrels
```

## 配置选项

Barrelsby 接受一些选项来帮助完善您的桶是如何创建的. 这些选项 可以从命令行中配置,也可以使用配置文件.

### `-c [path]` 或者说 `--config [path]`

指定桶比配置文件的位置。 此文件必须是 `.json` 文档。 你个 可使用其长名包含任何配置选项.

### `-d [path...]` 或者说 `--directory [path...]`

指定创建桶的根目录。 使用当前目录 默认.

**说明**:这是与以前版本相容的倒行本. 现有配置文件将 解析正确。 接下来的两个json文件将行为一致.

```json
{
  "directory": "./src"
}

{
  "directory": ["./src"]
}
```

### `-D` 或者说 `--delete`

删除桶体遇到的任何现有桶。 默认禁用 .

### `-e [regex...]` 或者说 `--exclude [regex...]`

不包括路径与指定正则表达式相匹配的任何文件.

### `-E` 或者说 `--exportDefault`

同时导出文件的默认导出 。 目前只与 `flat` 模式.

```TypeScript
export * from "./barrel";
export * from "./barrel";
export { default as barrel } from "./barrel";
```

### `-h` 或者说 `--help`

显示有助于提供桶比接受的命令行参数的信息.

### `-i [regex...]` 或者说 `--include [regex...]`

只包含路径与指定正则表达式相匹配的文件 .

### `-l [mode]` 或者说 `--location [mode]`

Bulby 用于确定创建桶的目录位置的模式 . 默认 _顶端_。 。 。 .

-   `top` 只在目标目录中创建一桶.
-   `below` 在目标目录以下的每个目录中创建一桶.
-   `all` 在下面的每个目录(并包括)中创建一桶.
-   `replace` 只创建目录中已有的桶 .
-   `branch` 在每个目录中创建一个包含其他目录的桶.

### `-L` 或者说 `--local`

启用此选项可防止包含同一目录中存在的模块的桶, 相反 而不是连续搜索子目录.

### `-n [name]` 或者说 `--name [name]`

指定用于创建新桶(并识别旧桶)的名称. `.ts` 永远 如未列入,则附上。 桶名将默认为 `index.ts`。 。 。 .

### `-s [mode]` 或者说 `--structure [mode]`

桶体内部应形成的结构。 默认 _平顶_。 。 。 .

#### `flat`

没有任何巢穴的出口模块.

```TypeScript
export * from "./barrel";
export * from "./index";
export * from "./directory2/script";
export * from "./directory2/directory4/deeplyNested";
export * from "./directory3/program";
```

#### `filesystem`

导出模块作为匹配文件系统目录的嵌入式结构.

```TypeScript
import * as barrelts from "./barrel";
import * as directory2directory4deeplyNestedts from "./directory2/directory4/deeplyNested";
import * as directory2scriptts from "./directory2/script";
import * as directory3programts from "./directory3/program";
import * as indexts from "./index";
export {barrelts as barrel};
export const directory2 = {
  directory4: {
    deeplyNested: directory2directory4deeplyNestedts,
  },
  script: directory2scriptts,
};
export const directory3 = {
  program: directory3programts,
};
export {indexts as index};
```

### `-q` 或者说 `--singleQuotes`

在生成的枪管文件中使用"单引号"来代替默认的"双引号".

### `-S` 或者说 `--noSemicolon`

在生成的枪管文件中从行尾的 Omit 分号.

### `-H` 或者说 `--noHeader`

Omit在枪管文件上方添加了页眉注释.

### `-v` 或者说 `--version`

显示桶的版本号 .

### `-V` 或者说 `--verbose`

显示额外的调试信息 .

## 所需资源

对ES6语法要求节点v6.0.0或更高.

## 捐款

见捐款(md)

## 常见问题

### @carbonorm/barrelsby 是什么？

自动为您的整个代码基础打入脚本桶

### 如何安装 @carbonorm/barrelsby？

在项目目录运行 npm install @carbonorm/barrelsby，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 barrelsby，可以用 npx barrelsby 直接运行。

### @carbonorm/barrelsby 支持 TypeScript 吗？

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

### @carbonorm/barrelsby 支持 ESM 还是 CommonJS？

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

### @carbonorm/barrelsby 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=6\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @carbonorm/barrelsby 可以商用吗？

@carbonorm/barrelsby 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @carbonorm/barrelsby 的下载量有多少？

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

### @carbonorm/barrelsby 还在维护吗？

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