"Option #2" installation instructions seem to be wrong

Created on 1 July 2024, 10 months ago

Steps to reproduce

  1. Install Drupal 10.2.7
  2. Follow Option 2 instructions for installation of anchor_link module and library via Composer
  3. Confirm that library is installed to web/libraries/ckeditor5-anchor-drupal
  4. Attempt to enable module

Error appears:

[error]  Unable to install module 'anchor_link' due to unmet requirement(s):
  - Before you can use the Anchor Link module, you need to download the plugin from ckeditor.com and place it in /libraries/link. Check the README.md for more information. <a href="https://ckeditor.com/addon/link">Get the plugin here</a>. (Currently using CKEditor Anchor Link version CKEditor Anchor Link library missing)
[error]  Unable to install module 'fakeobjects' due to unmet requirement(s):
  - Before you can use the FakeObjects module, you need to download the plugin from ckeditor.com and place it in /libraries/fakeobjects. Check the README.txt for more information. <a href="http://ckeditor.com/addon/fakeobjects">Get the plugin here</a>. (Currently using FakeObjects version Plugin not detected)

Proposed resolution

It seems like this line in the installation instructions:
composer config --json extra.installer-paths.web\/libraries\/ckeditor5-anchor-drupal '["npm-asset/northernco--ckeditor5-anchor-drupal"]'
should be:
composer config --json extra.installer-paths.web\/libraries\/link '["npm-asset/northernco--ckeditor5-anchor-drupal"]'
That takes care of the first error.

When it comes to the second error (fakeobjects), anchor_link's own composer.json lists it as a dependency in its "require" list. Usually when a module has a dependency, it is automatically downloaded and when you `drush en` the original module, the dependency is installed/enabled with it (provided that you approve that action).

It should be made clear in the instructions whether the user has to also require the fakeobjects module or install it as a library in a similar fashion to "northernco--ckeditor5-anchor-drupal."

🐛 Bug report
Status

Closed: works as designed

Version

2.7

Component

Documentation

Created by

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Production build 0.71.5 2024