drupal-ckeditor-libraries-group composer installation support

Created on 6 March 2020, over 4 years ago

Updated 25 January 2024, 10 months ago

Problem/Motivation

With an increasing usage of Drupal 8/9 composer installation, configuration, and updates, composer support for CKEditor 4 plugins have been mediocre at best. With the deprecation of #2912387: Stop using wikimedia/composer-merge-plugin → , we need a composer installation solution that eases the library burden for new installations.

CKEditor 4.x is epected to be replaced by CKEditor 5.x in Drupal 10: #2966864: Add optional support for CKEditor 5 in D9 so we can remove CKE 4 from Drupal 10 →

Proposed resolution

Based on the work in #3104018: Support library auto install via composer in asset dir → , we would like to request the Drupl CKEditor contrib module community collaborate and centralize composer repos under an auto-install method, rather than requiring additional root directory composer.json configurations → or modules such as drupal_libraries → .

We have begun a drupal-ckeditor-libraries-group → packagist repo to house these packages, and would like to have other CKEditor module contrib join this collection and make composer installs as easy as possible.

Big kudos to @voleger for the original request and partnerships to get the initial work done on this.

Remaining tasks

1. Confirm whether this would be appropriate for composer installs of this module.
2. Create a module owned Github repo to house a local copy of the required ckeditor plugin.
3. Create a packagist account.
4. Contact either @voleger and @Webbeh on adding a GitHub repo to the packagist account, and setting your local Github and packagist account to the repo.
5. After the repo is in place, create a patch (a la 3104018-31.patch) to update composer.json to point to the new repo.
6. Success!

User interface changes

TBD.

✨ Feature request

Status

Active

Version

1.0

Component

Code

Created by

🇺🇸United States Webbeh Georgia, USA

Live updates comments and jobs are added and updated live.

Incomplete comments

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment 10 months ago →

miiimooo Europe

Here a quickfix if you need to add this in your project while there is no progress on this issue (since ckeditor4 is deprecated I doubt there will be much progress)

    "repositories": [
        {
            "type": "package",
            "package": {
                "name": "ckeditor-plugin/a11ychecker",
                "version": "1.1.1",
                "type": "drupal-library",
                "dist": {
                    "url": "https://download.ckeditor.com/a11ychecker/releases/a11ychecker_1.1.1.zip",
                    "type": "zip"
                }
            }
        }

composer require ckeditor-plugin/a11ychecker

Check your (web/)libraries folder for presence of the a11ychecker folder

Comment 10 months ago →
🇨🇦Canada RobLoach Earth
Also note that there's a new version of the module at https://www.drupal.org/project/ckeditor_a11ychecker/issues/3394274 📌 Create a version compatible with CKEditor5 Needs review

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024