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 the file, add script descriptions, remove redundant script #353

Merged
merged 3 commits into from
Sep 27, 2023

Conversation

jrfnl
Copy link
Contributor

@jrfnl jrfnl commented Sep 27, 2023

Summary

This PR can be summarized in the following changelog entry:

  • Tidy up composer.json file and improve usability of scripts

Relevant 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: remove redundant script

This script has been superseded by the Composer plugin handling this automatically.

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-

Test instructions

This PR can be tested by following these steps:

  • N/A

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
This script has been superseded by the Composer plugin handling this automatically.
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 yoast cs/qa changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog labels Sep 27, 2023
@jrfnl jrfnl added this to the 3.2 milestone Sep 27, 2023
@jrfnl jrfnl merged commit c447993 into develop Sep 27, 2023
16 checks passed
@jrfnl jrfnl deleted the JRF/composer-tweaks branch September 27, 2023 11:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog yoast cs/qa
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant