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 #330

Merged
merged 2 commits into from
Oct 6, 2023

Conversation

jrfnl
Copy link
Contributor

@jrfnl jrfnl commented Oct 6, 2023

Context

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

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: 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

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance 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
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-
@coveralls
Copy link

Pull Request Test Coverage Report for Build 6431400124

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 48.608%

Totals Coverage Status
Change from base Build 6431357349: 0.0%
Covered Lines: 1100
Relevant Lines: 2263

💛 - Coveralls

@jrfnl jrfnl merged commit b3fffa5 into trunk Oct 6, 2023
20 checks passed
@jrfnl jrfnl deleted the JRF/composer-tweaks branch October 6, 2023 12:11
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