Skip to content

Latest commit

 

History

History
144 lines (85 loc) · 12.5 KB

CHANGELOG.md

File metadata and controls

144 lines (85 loc) · 12.5 KB
Raw

Changelog

3.0.0 (2024-11-04)

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:

2.1.1 (2024-09-30)

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:

3.0.0-alpha.0 (2024-09-19)

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:

2.1.0 (2024-08-07)

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

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

2.0.0 (2024-06-26)

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

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

To see all releases, visit the release page.