Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Composer: normalize, script descriptions and other tweaks #309

Merged
merged 3 commits into from
Sep 26, 2023

Conversation

jrfnl
Copy link
Collaborator

@jrfnl jrfnl commented Sep 26, 2023

Composer: remove redundant script

This script hasn't been used (in practice) since the Composer PHPCS Installer plugin became a non-dev dependency, so we may as well remove it.

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 or composer 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-

This script hasn't been used (in practice) since the Composer PHPCS Installer plugin became a non-dev dependency, so we may as well remove it.
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
These descriptions will be used when a list of the available scripts is requested on the command-line using the `composer list` or `composer 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-
@jrfnl jrfnl added this to the 3.0 milestone Sep 26, 2023
@coveralls
Copy link

Coverage Status

coverage: 97.371%. remained the same when pulling 07a7fb7 on JRF/composer-tweaks into 3f0c760 on develop.

@jrfnl jrfnl merged commit 0e33b6b into develop Sep 26, 2023
30 checks passed
@jrfnl jrfnl deleted the JRF/composer-tweaks branch September 26, 2023 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants