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.Problem/Motivation
The composer:scaffold command is awkward. When using it, the full command is:
$ composer composer:scaffold
The sounds redundant.
Proposed resolution
Rename the composer:scaffold command to drupal:scaffold, and add scaffold as a command alias. This will allow both $ composer drupal:scaffold and $ composer scaffold.
Conflict with the existing drupal-composer/drupal-scaffold command should not be an issue, as any given site should use only one of the two plugins. To ensure this is always true, we could add a conflict statement to the drupal/core-composer-scaffold plugin's composer.json file.
Remaining tasks
- Consider in concert with #3086148: Make scaffold "extra" data key conform with plugin command name
- Update documentation as follow-on task (#3082601: Update Composer documentation to match Drupal 8.8.0+ capabilities)
User interface changes
None.
API changes
None.
Data model changes
None.
Release notes snippet
The composer:scaffold command was renamed drupal:scaffold.
| Comment | File | Size | Author |
|---|---|---|---|
| #6 | 3086081-5-to-6-interdiff.txt | 1.97 KB | greg.1.anderson |
| #6 | 3086081-6.patch | 7.93 KB | greg.1.anderson |
| #5 | 3086081-5.patch | 5.96 KB | hussainweb |
| #5 | interdiff-3-5.txt | 3.9 KB | hussainweb |
| #3 | 3086081-3.patch | 2.06 KB | hussainweb |
Comments
Comment #2
hussainweb+1 to this.
drupal:scaffoldmakes more sense thancomposer:scaffold.Comment #3
hussainwebI'm making the change here.
I can see two change records relevant to scaffolding and neither of them need updating. The documentation also doesn't refer to this command.
Comment #5
hussainwebChanging a few remaining references of
composer:scaffold.Comment #6
greg.1.anderson CreditAttribution: greg.1.anderson at Pantheon commentedHere's a patch to update some of the documentation as well.
Comment #7
johnwebdev CreditAttribution: johnwebdev commentedName change makes sense. Nice with some additional documentation as well. 👏
Comment #8
greg.1.anderson CreditAttribution: greg.1.anderson at Pantheon commentedComment #9
greg.1.anderson CreditAttribution: greg.1.anderson at Pantheon commentedLink to documentation update issue as follow-on task.
Comment #10
webchickTalked to @greg.1.anderson about this a bit, mainly to enquire if this name made sense in the context of what e.g. Symfony, Laravel do and what people might expect.
He stated that this is mostly an internal thing (this is also covered by the docs) but in the event you need to run it you at least aren't repeating yourself yourself. ;)
Fair enough! Committed and pushed to 8.8.x. Thanks!