Review 13.4 Merged

90878[TASK] Update to CKEditor 5 46.1.1

Garvin Hicking CR +2 V +2 Nightmare +1542 −1415 updated 10/02/25, 11:34

Commit message

With the upgrade to CKEditor 5 46.x, three relevant changes
are made:

1.  The API naming of TypeScript imports has changed a lot. Custom
    CKEditor 5 plugins that utilize TypeScript build chains will
    need to be adapted to match update type imports. The created
    JavaScript modules however remain compatible, so this is not
    regarded as a breaking change.
    See [1] for a large table of "before->after" renames.

2.  A new opinionated default CSS is used by CKEditor to apply some
    improved styling over contents displayed within the RTE interface.
    Most of these are overruled by TYPO3's default CSS integration
    though. Possible customizations need to respect this.

3.  A few CSS classes have been renamed, see [2].
    These are for example referenced in custom CKEditor YAML
    configuration files.

Referenced CSS class names are updated.
The Core's custom plugin (LinkBrowser) is adapted to compile against
CKEditor 5 v46, but build output actually remains unchanged, as
only type imports had to be adapted, while runtime compatibility
was preserved.

Additionally, the naming of "CKEditor 5" (instead of "CKeditor"
or "CKEditor v5" or "CKEditor5") has been globally replaced
to match the proper product name. We also care to not be
called "typo v3". ;-)

Commands:

  cd Build
  npm --prefix overrides/ckeditor5 version 46.1.1
  npm install --save ./overrides/ckeditor5 $(
    grep @ckeditor/ package.json | \
    grep -v @ckeditor/ckeditor5-dev-utils | \
    grep -v @ckeditor/ckeditor5-inspector | \
    sed 's/^[^"]*"\([^"]*\)".*/\1@46.1.1/' \
  )
  npm install --save @ckeditor/ckeditor5-icons@^46.1.1
  npm install --save @ckeditor/ckeditor5-inspector@^5.0.0
  npm run build

[1] https://ckeditor.com/docs/ckeditor5/latest/updating/nim-migration/migrating-imports.html
[2] https://ckeditor.com/docs/ckeditor5/latest/updating/guides/update-to-46.html

Review

  • Code review CR +2 Done
    • Garvin Hicking +2
  • Verified V +2 Done
    • Garvin Hicking +2
    • core-ci +1 CI

Issues 1

Files 65

Show 45 more files

Review log 57

  1. Garvin Hicking commented on patch set 1 10/02/25, 10:50

    Cherry Picked from branch main. The following files contain Git conflicts: * typo3/sysext/rte_ckeditor/Classes/Configuration/CKEditor5Migrator.php * typo3/sysext/rte_ckeditor/Tests/Unit/Configuration/CKEditor5MigratorTest.php
  2. core-ci voted on patch set 1 V -1 10/02/25, 11:00 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85903

  3. Garvin Hicking commented on patch set 2 V -1 10/02/25, 11:14

    Published edit on patch set 1.
  4. Garvin Hicking marked it ready for review 10/02/25, 11:14

  5. core-ci voted on patch set 2 V +1 10/02/25, 11:25 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85907

  6. Garvin Hicking voted on patch set 2 CR +2 V +2 10/02/25, 11:34

  7. Garvin Hicking merged patch set 3 10/02/25, 11:34