v3.0.0

We are excited to announce an update to the package generator for CKEditor 5 plugins. Starting this release, the created packages use Vitest as a testing environment for automated tests.

Taking the occasion, we decided to drop the Transifex integration. Right now, translation entries (if needed) can be modified via pull requests instead of an external service. This change reflects the translation updates in CKEditor 5.

Last but not least, the generator follows the ESM standard. However, this change should not affect the integrators, as the @ckeditor/ckeditor5-package-tools package exposes a binary script that is aligned to the new API.

MAJOR BREAKING CHANGES ℹ️

• generator: Removed the translations:collect, translations:download and translations:upload scripts from the generated package. Instead, the translations:synchronize and translations:validate scripts are introduced. These two new scripts do not provide an integration with Transifex service anymore, but they help preparing translation files (*.po files) which must be handled by the integrator himself.
• tools: Removed the translations:collect, translations:download and translations:upload tasks. Instead, the translations:synchronize task is introduced. It helps preparing translation files (*.po files) in the generated package.

MINOR BREAKING CHANGES ℹ️

• generator: The generated package no longer uses Karma as the test runner. Instead, Vitest is used.
• tools: The test script is removed, because unit tests in the generated package are executed directly by Vitest. Hence, the previous custom support for the --coverage (-c) and --source-map (-s) flags is no longer needed and has been also removed. The yarn run test (or npm run test) script is still available in the generated package, but it executes Vitest. See CLI flags supported in Vitest.

Other changes

• generator: Lock to the last compatible version of the @ckeditor/ckeditor5-dev-build-tools package due to the upcoming release of breaking changes in the @ckeditor/ckeditor5-dev-* packages. Closes #191. (commit)
• generator: Replaced Karma with Vitest as the testing framework in the generated package. (commit)
• tools: Removed support for the --coverage (-c) and --source-map (-s) flags. (commit)
• tools: Removed test script from the tools, because unit tests in the generated package are executed now directly by Vitest. (commit)
• The generated package no longer integrates with the Transifex service. Thanks to that, a community can provide translation entries directly via pull requests. (commit)
• Converted the project repository to ESM. Closes #192. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

• @ckeditor/ckeditor5-package-tools: v2.1.1 => v3.0.0
• ckeditor5-package-generator: v2.1.1 => v3.0.0

v2.1.1

Other changes

• generator: Lock to the last compatible version of the @ckeditor/ckeditor5-dev-build-tools package due to the upcoming release of breaking changes in the @ckeditor/ckeditor5-dev-* packages. Closes #191. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

• @ckeditor/ckeditor5-package-tools: v2.1.0 => v2.1.1
• ckeditor5-package-generator: v2.1.0 => v2.1.1

v3.0.0-alpha.0

MINOR BREAKING CHANGES ℹ️

• generator: The generated package no longer uses Karma as the test runner. Instead, Vitest is used.
• tools: The test script is removed, because unit tests in the generated package are executed directly by Vitest. Hence, the previous custom support for the --coverage (-c) and --source-map (-s) flags is no longer needed and has been also removed. The yarn run test (or npm run test) script is still available in the generated package, but it executes Vitest. See CLI flags supported in Vitest.

Other changes

• generator: Replaced Karma with Vitest as the testing framework in the generated package. (commit)
• tools: Removed support for the --coverage (-c) and --source-map (-s) flags. (commit)
• tools: Removed test script from the tools, because unit tests in the generated package are executed now directly by Vitest. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

• @ckeditor/ckeditor5-package-tools: v2.1.0 => v3.0.0-alpha.0
• ckeditor5-package-generator: v2.1.0 => v3.0.0-alpha.0

v2.1.0

MINOR BREAKING CHANGES ℹ️

• generator: The global names for the ckeditor5 and ckeditor5-premium-features packages in the UMD builds have been changed to CKEDITOR and CKEDITOR_PREMIUM_FEATURES respectively.

Bug fixes

• generator: New flag --global-name to define a global name of the package to be used in the UMD build. See ckeditor/ckeditor5#16798. (commit)
• generator: Each package template should have own README.md based on what commands can be executed in it. Closes #174. (commit)
• generator: Updated the exports field in package.json templates to fix issues with loading CSS and translations in older bundlers. See ckeditor/ckeditor5#16638. (commit)
• generator: Changed the path to the types in the package.json in ts templates. See ckeditor/ckeditor5#16684. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

• @ckeditor/ckeditor5-package-tools: v2.0.0 => v2.1.0
• ckeditor5-package-generator: v2.0.0 => v2.1.0

v2.0.0

We are excited to announce an update to the package generator for CKEditor 5 plugins. Now the new package generator fully supports the latest installation methods in CKEditor 5.

With this update, you will be prompted to choose whether you want to generate a plugin that supports only the current methods or both current and legacy methods. For more details on migrating custom plugins, please refer to the documentation.

Features

• generator: New flag --installation-methods that should allow to generate package with current installation methods of CKEditor 5 or with current and legacy methods with DLLs. See ckeditor/ckeditor5#15502, ckeditor/ckeditor5#15739. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

• @ckeditor/ckeditor5-package-tools: v2.0.0-alpha.0 => v2.0.0
• ckeditor5-package-generator: v2.0.0-alpha.0 => v2.0.0

v2.0.0-alpha.0

MAJOR BREAKING CHANGES ℹ️

• Upgraded the minimal versions of Node.js to 18.0.0 due to the end of LTS.

MINOR BREAKING CHANGES ℹ️

• tools: The typescript() function exported from the webpack-utils module requires passing the cwd as the first argument. Optionally, you can pass the TypeScript configuration file name that should be used when processing TS files by ts-loader.

Features

• generator: Added the --use-only-new-installation-methods CLI flag that should allow the generation of a package without support for the DLL builds. See #15502, #15739.
• tools: Karma will use the tsconfig.test.json file as a TypeScript configuration if it exists when executing automated tests. By default, it fallbacks to tsconfig.json file. (commit)

Bug fixes

• generator: Allow to build plugin with potentially used external ckeditor5-premium-features. (commit)

Other changes

• generator: Aligned the produced configuration to changes in CKEditor 5. See ckeditor/ckeditor5#14173. Closes #160. (commit)
• Updated the required version of Node.js to 18. See ckeditor/ckeditor5#14924. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

• @ckeditor/ckeditor5-package-tools: v1.1.0 => v2.0.0-alpha.0
• ckeditor5-package-generator: v1.1.0 => v2.0.0-alpha.0

v1.1.0

Features

• generator: The tool will now display its version when used with -V/--version option. The version will also be displayed on the -h/--help message. Closes #150. (commit)

Bug fixes

• generator: Removed the current working directory from a package manager command when installing dependencies. A new process is already spawned in the directory. Hence, there is no need to duplicate the path. Thanks to that, a space in the path will not crash the generator while installing dependencies. Closes #156. (commit)

Other changes

• generator: When generating a new package, the generator uses the latest stable CKEditor 5 release. Closes #155. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

• ckeditor5-package-generator: v1.0.0 => v1.1.0

Other releases:

• @ckeditor/ckeditor5-package-tools: v1.0.0 => v1.1.0

v1.0.0

We are happy to announce the first stable release of ckeditor5-package-generator.

This tool allows creating a working package with the development environment to write new plugins for CKEditor 5.

For more details on using the tool, please, take a look at the README.md file of the ckeditor5-package-generator package.

MAJOR BREAKING CHANGES ℹ️

• Upgraded the minimal versions of Node.js to 16.0.0 due to the end of LTS.

Features

• Add augmentation.ts to the TypeScript package generator. Closes ckeditor/ckeditor5-package-generator#144. (commit)

Bug fixes

• tools: Added the missing ts-loader. Webpack missed it when creating a new package using npm as the package manager. Closes #143. (commit)
• tools: Added support for a package name without an organization prefix. Preparing the DLL build will not throw an error for such a package. Closes #139. (commit)

Other changes

• generator: Removed the "experimental" label from TS and made it the default choice. Related #111. (commit)
• tools: Update terser-webpack-plugin to enable optional chaining syntax. Closes #136. (commit)
• Updated the required version of Node.js to 16. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

• ckeditor5-package-generator: v1.0.0-beta.10 => v1.0.0

Other releases:

• @ckeditor/ckeditor5-package-tools: v1.0.0-beta.10 => v1.0.0

v1.0.0-beta.10

Bug fixes

• generator: Updated the generated packages to use a package entry point when importing plugins. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

• @ckeditor/ckeditor5-package-tools: v1.0.0-beta.9 => v1.0.0-beta.10
• ckeditor5-package-generator: v1.0.0-beta.9 => v1.0.0-beta.10

v1.0.0-beta.9

Features

• Replaced the community typings with the official CKEditor 5. Closes #110. (commit)

Other changes

• The ckeditor5 package is no longer a dependency of a created package. Instead, it is marked as a peer dependency to enable using the newly created package with the latest CKEditor 5 versions. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

• ckeditor5-package-generator: v1.0.0-beta.8 => v1.0.0-beta.9

Other releases:

• @ckeditor/ckeditor5-package-tools: v1.0.0-beta.8 => v1.0.0-beta.9