Merged
Conversation
Align the code style scripts with the conventions defined in plugin-standards. Rename `cbf` to `cs-fix` and use the `@php ./vendor/bin/` prefix for both `cs` and `cs-fix`. Update the development docs to reference the canonical script aliases.
GaryJones
added
the
type: maintenance
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Our Composer scripts for code style checking and auto-fixing used
non-standard names (
cscallingphpcsdirectly,cbfcallingphpcbf), which diverged from the conventions defined inplugin-standards. Developers working across multiple plugins shouldn't
need to remember different command names for the same operation.
This renames
cbftocs-fixand updates both scripts to use the@php ./vendor/bin/prefix, aligning with the standard scriptdefinitions. The development documentation is also updated to reference
the canonical
composer csandcomposer cs-fixaliases rather thancalling the binaries directly.
Test plan
composer cs— confirms PHPCS executes correctlycomposer cs-fix— confirms PHPCBF executes correctlycomposer run --list— confirms both scripts appear with descriptions