使用包生成器

The ckeditor5-package-generator is a tool for developers. It creates a working package with the development environment that allows writing new custom plugins for CKEditor 5.

# 快速入门

要创建新的包而不安装工具，只需执行以下命令

npx ckeditor5-package-generator <packageName> [--use-npm] [--use-yarn] [--installation-methods <current|current-and-legacy>] [--plugin-name <...>] [--lang <js|ts>] [--global-name <...>] [--verbose]

The <packageName> argument is required and must obey these rules

• 提供的名称必须符合模式：@scope/ckeditor5-*，其中 @scope 是包的拥有者。
• 包名必须以 ckeditor5- 前缀开头。
• 允许的字符是数字（0-9）、小写字母（a-z）和符号：- . _。

执行命令后，将创建一个包含包的新目录。目录的名称将等于指定的包名，不包含 @scope 部分，并且将包含示例插件和开发环境。

命令的可用修饰符为

• --use-npm – 在新创建的包中使用 npm 安装依赖项。
• --use-yarn – 在新创建的包中使用 yarn 安装依赖项。
• --global-name – 定义要在 UMD 构建中使用的包的全局名称。
• --plugin-name – 定义插件名称，使其不同于包名。
• --lang –（值：js | ts）选择创建的包应该使用 JavaScript 还是 TypeScript。如果省略，脚本将要求用户手动选择。
• --verbose –（别名：-v）打印有关当前执行任务的附加日志。
• --installation-methods –（值：current | current-and-legacy）选择要支持哪些 CKEditor 5 安装方法？如果省略，脚本将要求用户手动选择。

# 选择方法

目前，包可以以 CKEditor 5 支持的两种安装方法模式之一生成

• 如果 --installation-methods 标记的值设置为 current，则该包将仅支持当前安装方法。这种方法使创建 CKEditor 5 插件变得更容易，但代价是不支持旧的安装方法。
• 如果 --installation-methods 标记的值设置为 current-and-legacy，则包生成器会为当前安装方法和 旧安装方法 创建捆绑包。

# 使用包

成功创建包含新包的目录后，通过执行以下命令进入该目录

# Assuming that your package was created with `ckeditor5-foo` as its name.
cd ckeditor5-foo

然后，通过执行以下命令运行插件的测试环境

npm run start

现在，可以在示例编辑器中看到该插件。

您可以根据使用的语言查看包中包含的内容

• JavaScript
• TypeScript

# 迁移

如果您已经使用过 ckeditor5-package-generator（版本 1.1.0 或更低版本）生成和开发自己的 CKEditor 5 插件，现在您想迁移到 CKEditor 5 使用的最新安装方法，请访问 将 CKEditor 5 迁移到新的安装方法 指南。您将在其中找到逐步指导您完成所有需要更改内容的说明。