feature(ckeditor): Upgrade CKEditor 5 to 37.0.1

.eslintrc.js

@@ -3,7 +3,18 @@ module.exports = {
   parser: "@typescript-eslint/parser",
   plugins: ["@typescript-eslint", "jsdoc", "eslint-plugin-tsdoc", "no-null", "import", "unused-imports"],
   root: true,
-  ignorePatterns: ["dist/", "docs/", "node_modules/", "*.orig"],
+  ignorePatterns: [
+    // Ignore compiled JavaScript files (old build setup, changed on 2023-05-04 to _build to src/_.
+    "dist/",
+    "docs/",
+    "node_modules/",
+    "typings/",
+    "*.orig",
+    // Ignore compiled JavaScript files, as they are generated automatically.
+    "**/src/**/*.js",
+    // Also, do not check typing declarations, too.
+    "**/src/**/*.d.ts",
+  ],
   overrides: [
     {
       files: ["**/*.js", "**/*.ts", "**/*.tsx"],

.github/workflows/pre-release.yml

@@ -23,7 +23,7 @@ jobs:
   build:
     name: Build
     runs-on: ubuntu-latest
-    timeout-minutes: 10
+    timeout-minutes: 13
     # do not run when if it is a manual trigger on the main branch as we have other CI for this. This one is only for feature branches
     if: (github.event_name != 'workflow_dispatch' || github.ref != 'refs/heads/main') && !github.event.pull_request.draft
     steps:

.github/workflows/release.yml

@@ -26,7 +26,7 @@ jobs:
   build:
     name: Build
     runs-on: ubuntu-latest
-    timeout-minutes: 10
+    timeout-minutes: 20
     if: github.actor != 'coremedia-ci' && github.actor != 'github-action[bot]'
     steps:
       - name: Checkout

.gitignore

@@ -32,6 +32,16 @@ build/
 dist/
 node_modules/
 
+# Ignore compiled TypeScript files.
+**/src/**/*.js
+**/src/**/*.js.map
+**/src/**/*.d.ts
+**/src/**/*.d.ts.map
+
+# Ignore TypeScript Buildinfo
+
+*.tsbuildinfo
+
 # Temporary Output
 
 *.log

.prettierignore

@@ -2,3 +2,7 @@
 dist
 docs
 node_modules
+# Ignore compiled JavaScript files, as they are generated automatically.
+src/**/*.js
+# Also, do not check typing declarations, too.
+src/**/*.d.ts

README.md

@@ -132,6 +132,8 @@ previously `setData()` call. A typical approach is:
 ## See Also
 
 * **[GitHub Pages][gp:ckeditor-plugins]:** These pages on GitHub Pages.
+* **[Walk-Through Examples](./examples/README.md):** Some step-by-step guides
+  for customizing CKEditor 5.
 * **[Development](./DEVELOPMENT.md):** Hints for developing within this workspace
 * **[License](./LICENSE):** Apache 2.0 License Text
 * **[Versioning](./VERSIONING.md):** Versioning Policy

app/.eslintrc.js

@@ -5,7 +5,7 @@ module.exports = {
       files: ["**/*.ts", "**/*.tsx"],
       parserOptions: {
         tsconfigRootDir: __dirname,
-        project: "./src/tsconfig.json",
+        project: "./tsconfig.json",
       },
     },
   ],

app/package.json

@@ -9,90 +9,72 @@
   "license": "Apache-2.0",
   "private": true,
   "dependencies": {
-    "@ckeditor/ckeditor5-alignment": "36.0.1",
-    "@ckeditor/ckeditor5-autoformat": "36.0.1",
-    "@ckeditor/ckeditor5-autosave": "36.0.1",
-    "@ckeditor/ckeditor5-basic-styles": "36.0.1",
-    "@ckeditor/ckeditor5-block-quote": "36.0.1",
-    "@ckeditor/ckeditor5-clipboard": "36.0.1",
-    "@ckeditor/ckeditor5-code-block": "36.0.1",
-    "@ckeditor/ckeditor5-core": "36.0.1",
-    "@ckeditor/ckeditor5-editor-classic": "36.0.1",
-    "@ckeditor/ckeditor5-engine": "36.0.1",
-    "@ckeditor/ckeditor5-essentials": "36.0.1",
-    "@ckeditor/ckeditor5-find-and-replace": "36.0.1",
-    "@ckeditor/ckeditor5-heading": "36.0.1",
-    "@ckeditor/ckeditor5-highlight": "36.0.1",
-    "@ckeditor/ckeditor5-image": "36.0.1",
-    "@ckeditor/ckeditor5-indent": "36.0.1",
-    "@ckeditor/ckeditor5-link": "36.0.1",
-    "@ckeditor/ckeditor5-list": "36.0.1",
-    "@ckeditor/ckeditor5-paragraph": "36.0.1",
-    "@ckeditor/ckeditor5-paste-from-office": "36.0.1",
-    "@ckeditor/ckeditor5-remove-format": "36.0.1",
-    "@ckeditor/ckeditor5-source-editing": "36.0.1",
-    "@ckeditor/ckeditor5-table": "36.0.1",
-    "@ckeditor/ckeditor5-theme-lark": "36.0.1",
-    "@ckeditor/ckeditor5-typing": "36.0.1",
-    "@ckeditor/ckeditor5-ui": "36.0.1",
-    "@ckeditor/ckeditor5-utils": "36.0.1",
+    "@ckeditor/ckeditor5-alignment": "37.0.1",
+    "@ckeditor/ckeditor5-autoformat": "37.0.1",
+    "@ckeditor/ckeditor5-autosave": "37.0.1",
+    "@ckeditor/ckeditor5-basic-styles": "37.0.1",
+    "@ckeditor/ckeditor5-block-quote": "37.0.1",
+    "@ckeditor/ckeditor5-clipboard": "37.0.1",
+    "@ckeditor/ckeditor5-code-block": "37.0.1",
+    "@ckeditor/ckeditor5-core": "37.0.1",
+    "@ckeditor/ckeditor5-editor-classic": "37.0.1",
+    "@ckeditor/ckeditor5-engine": "37.0.1",
+    "@ckeditor/ckeditor5-essentials": "37.0.1",
+    "@ckeditor/ckeditor5-find-and-replace": "37.0.1",
+    "@ckeditor/ckeditor5-heading": "37.0.1",
+    "@ckeditor/ckeditor5-highlight": "37.0.1",
+    "@ckeditor/ckeditor5-image": "37.0.1",
+    "@ckeditor/ckeditor5-indent": "37.0.1",
+    "@ckeditor/ckeditor5-language": "37.0.1",
+    "@ckeditor/ckeditor5-link": "37.0.1",
+    "@ckeditor/ckeditor5-list": "37.0.1",
+    "@ckeditor/ckeditor5-paragraph": "37.0.1",
+    "@ckeditor/ckeditor5-paste-from-office": "37.0.1",
+    "@ckeditor/ckeditor5-remove-format": "37.0.1",
+    "@ckeditor/ckeditor5-source-editing": "37.0.1",
+    "@ckeditor/ckeditor5-table": "37.0.1",
+    "@ckeditor/ckeditor5-typing": "37.0.1",
+    "@ckeditor/ckeditor5-ui": "37.0.1",
+    "@ckeditor/ckeditor5-utils": "37.0.1",
     "@coremedia-internal/ckeditor5-coremedia-example-data": "^1.0.0",
     "@coremedia/ckeditor5-coremedia-content-clipboard": "14.1.2-rc.0",
-    "@coremedia/ckeditor5-dom-converter": "14.1.2-rc.0",
     "@coremedia/ckeditor5-coremedia-differencing": "14.1.2-rc.0",
     "@coremedia/ckeditor5-coremedia-images": "14.1.2-rc.0",
     "@coremedia/ckeditor5-coremedia-link": "14.1.2-rc.0",
     "@coremedia/ckeditor5-coremedia-richtext": "14.1.2-rc.0",
     "@coremedia/ckeditor5-coremedia-studio-essentials": "14.1.2-rc.0",
     "@coremedia/ckeditor5-coremedia-studio-integration-mock": "14.1.2-rc.0",
     "@coremedia/ckeditor5-dataprocessor-support": "14.1.2-rc.0",
+    "@coremedia/ckeditor5-dom-converter": "14.1.2-rc.0",
     "@coremedia/ckeditor5-font-mapper": "14.1.2-rc.0",
     "@coremedia/ckeditor5-link-common": "14.1.2-rc.0",
     "@coremedia/service-agent": "^1.1.5",
-    "xml-formatter": "^2.6.1"
+    "xml-formatter": "^3.3.2"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-dev-utils": "^30.5.0",
+    "@ckeditor/ckeditor5-dev-translations": "^37.0.0",
+    "@ckeditor/ckeditor5-dev-utils": "^37.0.0",
     "@ckeditor/ckeditor5-inspector": "^4.1.0",
-    "@ckeditor/ckeditor5-dev-webpack-plugin": "^30.5.0",
-    "@types/ckeditor__ckeditor5-alignment": "29.0.7",
-    "@types/ckeditor__ckeditor5-autosave": "^32.0.0",
-    "@types/ckeditor__ckeditor5-autoformat": "^31.0.1",
-    "@types/ckeditor__ckeditor5-find-and-replace": "^29.1.2",
-    "@types/ckeditor__ckeditor5-basic-styles": "^28.0.2",
-    "@types/ckeditor__ckeditor5-block-quote": "^29.0.4",
-    "@types/ckeditor__ckeditor5-code-block": "^29.0.3",
-    "@types/ckeditor__ckeditor5-core": "^33.0.3",
-    "@types/ckeditor__ckeditor5-editor-classic": "^27.1.2",
-    "@types/ckeditor__ckeditor5-essentials": "^28.0.3",
-    "@types/ckeditor__ckeditor5-heading": "^29.0.3",
-    "@types/ckeditor__ckeditor5-highlight": "^29.0.3",
-    "@types/ckeditor__ckeditor5-image": "^33.0.0",
-    "@types/ckeditor__ckeditor5-indent": "^29.0.3",
-    "@types/ckeditor__ckeditor5-link": "^32.0.4",
-    "@types/ckeditor__ckeditor5-list": "^32.0.1",
-    "@types/ckeditor__ckeditor5-paragraph": "^27.0.5",
-    "@types/ckeditor__ckeditor5-paste-from-office": "^29.0.1",
-    "@types/ckeditor__ckeditor5-remove-format": "^28.0.3",
-    "@types/ckeditor__ckeditor5-source-editing": "^29.1.1",
-    "@types/ckeditor__ckeditor5-table": "^33.0.0",
-    "@types/node": "^18.8.1",
+    "@ckeditor/ckeditor5-theme-lark": "37.0.1",
+    "@types/node": "^18.15.11",
     "circular-dependency-plugin": "^5.2.2",
-    "css-loader": "^6.7.1",
+    "css-loader": "^6.7.3",
+    "esbuild-loader": "^3.0.1",
     "http-server": "^14.1.1",
-    "postcss": "^8.4.16",
-    "postcss-loader": "^7.0.1",
+    "postcss": "^8.4.21",
+    "postcss-loader": "^7.2.4",
     "raw-loader": "^4.0.2",
-    "rimraf": "^3.0.2",
-    "style-loader": "^3.3.1",
-    "terser-webpack-plugin": "^5.3.6",
-    "ts-loader": "^9.3.1",
-    "typescript": "^4.8.2",
-    "webpack": "^5.74.0",
-    "webpack-cli": "^4.10.0"
+    "rimraf": "^5.0.0",
+    "style-loader": "^3.3.2",
+    "terser-webpack-plugin": "^5.3.7",
+    "typescript": "^4.9.5",
+    "webpack": "^5.78.0",
+    "webpack-cli": "^5.0.1"
   },
   "scripts": {
-    "clean": "rimraf ./dist",
+    "clean": "pnpm clean:src && pnpm clean:dist",
+    "clean:src": "rimraf --glob \"src/**/*.@(js|js.map|d.ts|d.ts.map)\"",
+    "clean:dist": "rimraf ./dist",
     "build": "webpack --mode production --stats-error-details",
     "npm-check-updates": "npm-check-updates --upgrade",
     "start": "http-server . --port 0 -d false -o sample"