Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.This is based on my understanding of how things work and may be flawed to to lack of complete understanding...
My struggle with the current state of things when installing the external libraries with composer is two fold. It requires:
- Running a drush command, and
- Manually modifying a composer.json file.
Additionally, this process must be repeated if there is any modification to the generated composer.json by the module maintainer.
It would be much better in my opinion to simply include the libraries in the webform module's composer.json file by default. This way the dependencies area automatically installed once the module is installed/required via composer. Drush commands could live on for Drush Make users or tar.gz installers.
Short of that I'm considering a contrib module "Webform Libraries" or such that simply has the same composer.json that drush generates so that it can be required via composer to download the libraries. It feels hacky, and would create some maintenance to keep it inline with Webform but unless the dependencies end up in the Webform composer file, I think it makes the most sense.
Ideas, thoughts, corrections?
| Comment | File | Size | Author |
|---|---|---|---|
| #7 | composer_ckeditor-2885338-8.patch | 5.56 KB | jrockowitz |
| |||
Comments
Comment #2
artis CreditAttribution: artis at Texas Creative commentedComment #3
jrockowitz CreditAttribution: jrockowitz as a volunteer and at The Big Blue House commentedDrupal's testbot does not support dependencies in a module's composer.json file.
Also most libraries are optional so we can't assume all libraries should be installed.
Another option could be to create a drush command that updates the entire installations /composer.json file to include the selected webform libraries.
Comment #4
jrockowitz CreditAttribution: jrockowitz as a volunteer and at The Big Blue House commentedI think writing a `drush webform-composer-update` might be the best solution.
One trick would be to add an
_webform: trueproperty to any composer.json repository managed using this commandComment #5
artis CreditAttribution: artis at Texas Creative commentedThe additional drush command is better, but still runs into an issue where when `composer update` is run and there is a new version of Webform the composer.json file will be overridden, right?
Here is a thought...other modules use bower for js/css dependencies, then we can maintain/update them through bower. Providing that as an optional way to install the webform dependencies, if possible, would help with the maintenance issue since many of us are already maintaining bower packages separate to composer.
This seems like a larger issue than just Webform, I'll try to find out where that discussion is happening and weight in there too.
Thanks!
BTW, this module is mind-blowing! You've done a phenomenal job!
Comment #6
jrockowitz CreditAttribution: jrockowitz as a volunteer and at The Big Blue House commentedI think it is worth experimenting with the drush command because webform libraries are optional and can be enabled/disabled via the UI. This is a unique requirement/feature.
BTW, the drush command would update the composer.json for the entire Drupal installation not the Webform module.
I would be open to adding a drush command that generates the needed bower file but I am not actively using Bower.
also @see #2605130: Best practices for handling external libraries in Drupal 8/9 and 10
Comment #7
jrockowitz CreditAttribution: jrockowitz as a volunteer and at The Big Blue House commentedOnce you apply the patch, make sure to backup your site and composer.json, and then execute `drush webform-composer-update`.
Comment #9
jrockowitz CreditAttribution: jrockowitz as a volunteer and at The Big Blue House commented@see https://www.drupal.org/docs/8/modules/webform/webform-libraries