-
Notifications
You must be signed in to change notification settings - Fork 25
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
base: master
Are you sure you want to change the base?
Conversation
Removed unneeded `type` property from config.
Internal: Removed the jsdoc-plugins package.
.eslintrc.js
Outdated
// ESLint does not understand `import ... with { ... }`. | ||
// See: https://github.com/eslint/eslint/discussions/15305. |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO: To resolve.
There was a problem hiding this 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`.
Aligned to `ckeditor5-dev` ESM changes
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" |
There was a problem hiding this comment.
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.
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 ofjs
.MAJOR BREAKING CHANGE (docs): The package uses only TypeDoc to build the documentation. The
build()
function no longer supportstype
property in the configuration.MAJOR BREAKING CHANGE: The following packages have been converted to ESM. To load them, use an
import
statement instead ofrequire()
.@ckeditor/ckeditor5-dev-build-tools
@ckeditor/ckeditor5-dev-bump-year
@ckeditor/ckeditor5-dev-ci
@ckeditor/ckeditor5-dev-dependency-checker
@ckeditor/ckeditor5-dev-docs
@ckeditor/ckeditor5-dev-release-tools
@ckeditor/ckeditor5-dev-stale-bot
@ckeditor/ckeditor5-dev-tests
@ckeditor/ckeditor5-dev-transifex
@ckeditor/ckeditor5-dev-translations
@ckeditor/ckeditor5-dev-utils
@ckeditor/ckeditor5-dev-web-crawler
Additional information
For example – encountered issues, assumptions you had to make, other affected tickets, etc.