# @ckeditor/ckeditor5-dev-build-tools 中文文档

规范地址：https://npmcn.com/package/%40ckeditor/ckeditor5-dev-build-tools/

版本：63\.1\.3
npm 元数据更新时间：2026-11-09T07:49:44.264Z
中文译文更新时间：2026-11-09T23:19:53.987Z
软件包许可：GPL-2\.0-or-later

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

原始 npm 页面：https://www.npmjs.com/package/%40ckeditor/ckeditor5-dev-build-tools
原文对照：https://npmcn.com/package/%40ckeditor/ckeditor5-dev-build-tools/?lang=original
项目主页：https://github.com/ckeditor/ckeditor5-dev/tree/master/packages/ckeditor5-dev-build-tools
源码仓库：https://github.com/ckeditor/ckeditor5-dev

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

- 包体积（解压后）：43.4 kB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=26\.10\.0
- 运行依赖：7 个
- 首次发布：2024-02-29T10:52:33.049Z
- 最新版本发布：2026-11-09T07:49:44.104Z
- 近 30 天下载量：12540（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：166（近 12 个月 80 个）

## 中文简介

用于构建CKEditor 5包的滚动工具.

## 安装

```sh
npm install @ckeditor/ckeditor5-dev-build-tools
```

也可以使用：`pnpm add @ckeditor/ckeditor5-dev-build-tools`、`yarn add @ckeditor/ckeditor5-dev-build-tools`、`bun add @ckeditor/ckeditor5-dev-build-tools`

## README

# CKEditor 5 构建工具

[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-dev-build-tools.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-dev-build-tools) [![CircleCI](https://circleci.com/gh/ckeditor/ckeditor5-dev.svg?style=shield)](https://app.circleci.com/pipelines/github/ckeditor/ckeditor5-dev?branch=master)

此软件包可用于构建兼容 CKEditor 5 插件 [新的安装方法](https://github.com/ckeditor/ckeditor5/issues/15502),而源代码仍然为旧方法所写. 它在构建过程中超过导入,以使插件与新的安装方法相容.

## API 密码

这个软件包可以用作CLI工具,也可以通过JavaScript API.

### 国 际

CLI工具可以使用如下:

```bash
npx @ckeditor/ckeditor5-dev-build-tools \
  --input=src/index.js \
    --output=dist/index.js \
    --source-map # Other options
```

### Java 脚本 API

JavaScript API可以使用如下方式:

```javascript
import { build } from '@ckeditor/ckeditor5-dev-build-tools';

await build( {
    input: 'src/index.js',
    output: 'dist/index.js',
    sourceMap: true,
    // Other options
} );
```

### 选项

#### `input` 编号 : `--input=[path]`

**类型 :** `string`

**默认值 :** `src/index.ts`

输入文件的路径 .

#### `output` 编号 : `--output=[path]`

**类型 :** `string`

**默认值 :** `dist/index.js`

输出文件的路径 。 CSS文件,翻译,源地图等所有其他资产将保存在同一目录中. 当使用时 `clean` 选项,此路径将用于确定要删除的目录.

#### `tsconfig` 编号 : `--tsconfig=[path]`

**类型 :** `string`

**默认值 :** `tsconfig.json`

TypeScript 配置文件的路径. 如果工程不使用TypeScript,此选项可以被忽略.

#### `banner` 编号 : `--banner=[path]`

**类型 :** `string`

**默认值 :** `''`

横幅文件的路径 。 此文件必须导出一个名为 `banner`,这是添加到开头的字符串 `.js`, (中文(简体) ), `.css`,以及 `.d.ts` 文档。 横幅内容不得违反JavaScript或CSS语法.

**横幅文件示例 :**

```javascript
export const banner =
`/**
 * This is a custom banner that uses comment syntax valid in both JavaScript and CSS.
 */
`;
```

#### `translations` 编号 : `--translations=[path]`

**类型 :** `string`

**默认值 :** `''`

符合 Glob 的翻译文件路径 。 如果插件不提供翻译,则可以忽略此选项.

**示例值 :** `**/lang/translations/*.ts`

#### `declarations` 编号 : `--declarations`

**类型 :** `boolean`

**默认值 :** `false`

是否生成 TypeScript 声明文件 .

#### `sourceMap` 编号 : `--source-map`

**类型 :** `boolean`

**默认值 :** `false`

是否生成源地图 .

#### `minify` 编号 : `--minify`

**类型 :** `boolean`

**默认值 :** `false`

是否将输出最小化 .

#### `clean` 编号 : `--clean`

**类型 :** `boolean`

**默认值 :** `false`

是否在构建前清理输出目录 。 清洁目录基于 `output` 选项.

#### `browser` 编号 : `--browser`

**类型 :** `boolean`

**默认值 :** `false`

是否为浏览器构建 CKEditor5 插件 。 此选项将使工具输出一个可在浏览器中使用的无害环境管理和UMD捆绑. 此外,输出文件中的一些导入与Node.js构建相比,会略有不同.

如果启用此选项,则 `name` 选项必须指定.

#### `name` 编号 : `--name=[name]`

**类型 :** `string`

**默认值 :** `''`

UMD捆绑的名称. 当捆绑被装入浏览器时,此名称将作为全局变量名称.

如果启用了“ 浏览器” 选项, 则需要此选项 .

#### `globals` 编号 : `--globals=[moduleID:Global]`

**类型 :** `{ [ name: string ]: string } | ( ( name: string ) => string )` | `string[]`

**默认值 :** `{}`

外部软件包名称和相关全局变量的对称 `umd` 建设.

列表中已经包含 `ckeditor5` 财务报告和审定财务报表 `ckeditor5-premium-features` 绘图到 `CKEDITOR` 财务报告和审定财务报表 `CKEDITOR_PREMIUM_FEATURES`。 。 。 .

在使用CLI时,此选项可以被多次使用.

**示例值 :** `--globals=external-id:variableName --globals=another-external-id:anotherVariableName`

当使用JavaScript API时,选项必须是对象.

**示例值 :**

```js
globals: {
    'external-id': 'variableName',
    'another-external-id': 'anotherVariableName'
}
```

#### `external` 编号 : `--external=[path]`

**类型 :** `string[]` | `string`

**默认值 :** `[]`

不应捆绑的外部依赖性列表 .

外部依赖性列表将自动扩展至包含所有依赖性 `ckeditor5` 财务报告和审定财务报表 `ckeditor5-premium-features` 如果它们作为外部依赖提供。 例如,如果您的插件使用 `@ckeditor/ckeditor5-core` 财务报告和审定财务报表 `@ckeditor/ckeditor5-engine`,您可以指定 `ckeditor5` 输入 `external` 选项将它们排除在捆绑之外.

在使用CLI时,此选项可以被多次使用.

**示例值 :** `--external=lodash --external=moment`

在使用JavaScript API时,选项必须是数组.

**示例值 :** `external: [ 'lodash', 'moment' ]`

## 更改日志

见 [`CHANGELOG.md`](https://github.com/ckeditor/ckeditor5-dev/blob/master/packages/ckeditor5-dev-bump-year/CHANGELOG.md) 文档.

## 许可证

根据下列规定获得许可证: [GNU 通用公共许可证版本 2 或稍后版本](http://www.gnu.org/licenses/gpl.html)请检查date=中的日期值 (帮助) `LICENSE.md` 文档.

## 常见问题

### @ckeditor/ckeditor5-dev-build-tools 是什么？

用于构建CKEditor 5包的滚动工具\.

### 如何安装 @ckeditor/ckeditor5-dev-build-tools？

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

### @ckeditor/ckeditor5-dev-build-tools 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @ckeditor/ckeditor5-dev-build-tools 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @ckeditor/ckeditor5-dev-build-tools 需要什么版本的 Node\.js？

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

### @ckeditor/ckeditor5-dev-build-tools 可以商用吗？

@ckeditor/ckeditor5-dev-build-tools 使用 GPL-2\.0-or-later 许可。强 Copyleft：分发包含该代码的软件时，整个作品需以兼容的 GPL 许可开源。仅在内部使用、不对外分发时不触发此义务。以上为概括，不构成法律意见，请以许可原文为准。

### @ckeditor/ckeditor5-dev-build-tools 的下载量有多少？

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

### @ckeditor/ckeditor5-dev-build-tools 还在维护吗？

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