使用包生成器

该 ckeditor5-package-generator 是一个面向开发者的工具。它创建一个具有开发环境的工作包，允许编写 CKEditor 5 的新自定义插件。

# 快速入门

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

npx ckeditor5-package-generator <packageName> [--use-npm] [--use-yarn] [--plugin-name <...>] [--verbose] [--lang <js|ts>]

<packageName> 参数是必需的，并且必须遵守以下规则

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

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

该命令可用的修饰符是

• --use-npm – 使用 npm 在新创建的包中安装依赖项。
• --use-yarn – 使用 yarn 在新创建的包中安装依赖项。
• --plugin-name – 定义与包名不同的插件名。
• --lang –（值：js | ts）选择创建的包应该使用 JavaScript 还是 TypeScript。如果省略，脚本将提示用户手动选择。
• --verbose –（别名：-v）打印有关当前执行任务的额外日志。

# 使用包

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

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

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

npm run start

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

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

• JavaScript
• TypeScript