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: Update script names #741

Merged
merged 4 commits into from
Jan 31, 2023
Merged

Conversation

GaryJones
Copy link
Contributor

Better align with suggested script names at https://github.com/php-pds/composer-script-names, add script descriptions, and remove a redundant script for manually updating the list of installed code standards into PHPCS.

@GaryJones GaryJones added this to the 2.3.4 milestone Jan 24, 2023
@GaryJones GaryJones requested a review from a team as a code owner January 24, 2023 15:51
@GaryJones GaryJones self-assigned this Jan 24, 2023
@GaryJones GaryJones force-pushed the fix/composer-script-names branch from 0c63b7e to 9e597b3 Compare January 24, 2023 16:46
Copy link
Collaborator

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While I'm not adverse to these changes, it's unclear to me why the https://github.com/php-pds/composer-script-names repo is cited as an authoritative document. Based on the commit history, lack of discussion in issues or PRs, the "rules" stated in that repo sound like one-man's opinion.

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
@GaryJones
Copy link
Contributor Author

While I'm not adverse to these changes, it's unclear to me why the php-pds/composer-script-names repo is cited as an authoritative document. Based on the commit history, lack of discussion in issues or PRs, the "rules" stated in that repo sound like one-man's opinion.

The research suggests that it was done with analysis on 36,000+ packages, so while not authoritative in the form of it being from Composer or PHP-FIG, it indicates to me that the names proposed in this PR are better aligned with many other Composer script names in PHP packages in the community.

These appear when calling `composer list`.
This is no longer needed; the list of installed code standards for PHPCS is reliably updated on `composer install` and `composer update`.
Has the advantages of:
 - working on Windows machines.
 - extra CLI args such as `--sniffs` can be passed when calling `composer cs`.
@GaryJones GaryJones force-pushed the fix/composer-script-names branch from 9e597b3 to 6d52e98 Compare January 25, 2023 13:56
@jrfnl
Copy link
Collaborator

jrfnl commented Jan 25, 2023

@GaryJones I'll have a read through the research, don't have time for it right at this moment.

@rebeccahum rebeccahum merged commit 24af5df into develop Jan 31, 2023
@rebeccahum rebeccahum deleted the fix/composer-script-names branch January 31, 2023 18:51
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.

3 participants