Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Converted ckeditor5-dev-* packages to ESM #1011

Draft
wants to merge 150 commits into
base: master
Choose a base branch
from
Draft

Converted ckeditor5-dev-* packages to ESM #1011

wants to merge 150 commits into from

Conversation

pomek
Copy link
Member

@pomek pomek commented Sep 19, 2024

Suggested merge commit message (convention)

Other: The CKEditor 5 Dev packages are now ESM.

Other: The @ckeditor/jsdoc-plugins package is no longer available as CKEditor 5 documentation uses TypeScript sources to prepare API docs. The package is no longer use by us anywhere. Hence, we decided to remove a dead code.

MAJOR BREAKING CHANGE (utils): The builds.getDllPluginWebpackConfig() function is now asynchronous now.

MAJOR BREAKING CHANGE (utils): The following functions from the bundler object are no longer available: createEntryFile(), getEditorConfig(), getPlugins().

MAJOR BREAKING CHANGE (utils): The following functions from the stream object are no longer available: isTestFile(), isSourceFile(), isJSFile().

MAJOR BREAKING CHANGE (utils): The styles.themeLogger() function is no longer exposed publicly.

MAJOR BREAKING CHANGE (tests): The IntelliJ Karma configuration path needs to be updated. Now, it ends with the cjs suffix instead of js.

MAJOR BREAKING CHANGE (docs): The package uses only TypeDoc to build the documentation. The build() function no longer supports type property in the configuration.

MAJOR BREAKING CHANGE: The following packages have been converted to ESM. To load them, use an import statement instead of require().


Additional information

For example – encountered issues, assumptions you had to make, other affected tickets, etc.

.eslintrc.js Outdated
Comment on lines 18 to 19
// ESLint does not understand `import ... with { ... }`.
// See: https://github.com/eslint/eslint/discussions/15305.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: To resolve.

.eslintrc.js Outdated
],
rules: {
'no-console': 'off',
'ckeditor5-rules/require-file-extensions-in-imports': 'off',
'mocha/no-global-tests': 'off', // TODO: remove when all mocha tests are removed.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: To remove.

.eslintrc.js Outdated
@@ -29,9 +35,27 @@ module.exports = {
},
overrides: [
{
files: [ './packages/ckeditor5-dev-build-tools/tests/**/*' ],
files: [
// TODO: add packages as they are migrated to ESM.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: To resolve.

Copy link
Member Author

@pomek pomek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: Review JSDoc types.

Internal (tests): Converted the `ckeditor5-dev-tests` package to ESM.

Internal: The `ckeditor5-dev` repository is now marked as a module.

Internal: Redesigned the CI flow. Now, each package test runner is defined in a dedicated step instead of as a whole.

MAJOR BREAKING CHANGE (tests): The IntelliJ Karma configuration path needs to be updated. Now it ends with the `cjs` suffix instead of `js`.
psmyrek and others added 2 commits September 20, 2024 11:53
Internal: Temporary changes to enable alpha release from the `epic/3757-esm` branch.
CKE5_GITHUB_REPOSITORY="ckeditor5-dev"
CKE5_CIRCLE_APPROVAL_JOB_NAME="release_approval"
# CKE5_GITHUB_RELEASE_BRANCH="master"
CKE5_GITHUB_RELEASE_BRANCH="epic/3757-esm"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change must be updated to #master before merging. The entire commit 1cc2de5 should be reverted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants