CKEditor 5 Package Generator

This repository follows the mono-repository structure. It contains multiple npm packages.

Table of contents

• Packages
• Develop the ckeditor5-package-generator repository
  • Creating a package
    • Options
    • Developing the package
  • Developing tools in the repository
• Releasing packages
• License

Packages

Name	Version	Description
ckeditor5-package-generator		The tool for creating CKEditor 5 packages.

Developing the ckeditor5-package-generator repository

• Clone the repository: git clone git@github.com:ckeditor/ckeditor5-package-generator.git
• Install required dependencies: pnpm install

Creating a package

To create a new package, call the ckeditor5-package-generator executable file. It requires a single argument which is the package name. It must follow the schema: @scope/ckeditor5-package, where @scope is an owner of the package, and ckeditor5-package is the package name. It must start with the ckeditor5- prefix.

The tool will create a new directory called ckeditor5-package with an example plugin called Package and tools for its development.

node /path/to/repository/packages/ckeditor5-package-generator [packageName] [--package-manager <npm|yarn|pnpm>] [--global-name <...>] [--plugin-name <...>] [--lang <js|ts>] [--verbose]

Options

• --package-manager – (values: npm | yarn | pnpm) choose the package manager used to install dependencies in a newly created package. If omitted, the script will ask the user to choose one manually.
• --global-name – define a global name of the package to be used in UMD build.
• --plugin-name – define a class name to be different from the package name.
• --lang – (values: js | ts) choose whether the created package should use JavaScript or TypeScript. If omitted, the script will ask the user to choose manually.
• --verbose – (alias: -v) print additional logs about the current executed task.

Developing the package

Available scripts and their modifiers are described in the README.md file of the ckeditor5-package-generator package.

Package metadata

The ckeditor5-metadata.json file contains data of the package that allows for an automated detection of plugins and processing them by external scripts. Information about how this file should be maintained is available in the official guide. Keep in mind that this file has no effect on how the plugin work.

License

The ckeditor5-package-generator tool is available under MIT license.

All packages created with the tool are also available under the MIT license.