Composer: normalize the file, add script descriptions #330
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
composer.json
file and improve usability of scriptsSummary
This PR can be summarized in the following changelog entry:
composer.json
file and improve usability of scriptsRelevant technical choices:
Composer: normalize the file
Well, mostly (scripts are not alphabetized, but still grouped by task).
Note: this is done as a one-time only action. The normalize script will not be run in CI to enforce normalization.
Style has been standardized to
--indent-style=tab --indent-size=1
.Ref: https://github.com/ergebnis/composer-normalize
Composer: add script descriptions
These descriptions will be used when a list of the available scripts is requested on the command-line using the
composer list
orcomposer run -l
commands.These descriptions also help document the different scripts for the maintainers of the
composer.json
file.Ref: https://getcomposer.org/doc/articles/scripts.md#custom-descriptions-
Test instructions
Test instructions for the acceptance test before the PR gets merged
This PR can be acceptance tested by following these steps: