feat: Allow custom phpcs coding standard #149
Open
Conversation
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
damienwebdev
requested changes
Sep 22, 2023
| working-directory: standard | ||
| run: composer require dealerdirect/phpcodesniffer-composer-installer | ||
|
|
||
| - name: Install Magento2 Coding Standard |
Member
There was a problem hiding this comment.
Are these two things (the custom standard install and the Magento standard install) mutually exclusive? Wouldn't custom_standard have a dep on Magento?
| run: composer require "magento/magento-coding-standard:${{ inputs.version || '*' }}" | ||
|
|
||
| - name: Register Coding Standard | ||
| - name: Install Custom Coding Standard |
Member
There was a problem hiding this comment.
I foresee two situations for this action to be used:
- Extensions
- Stores
both of them will often have this extra repo already included in require-dev. Should we be the ones to install this? It seems like an unnecessary network IO if it is already installed. Perhaps #133 applies to this as well?
I don't personally think custom_coding_standard_repo is a good idea, though I like the ability to change the standard via coding_standard
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Currently, when
mage-os/github-actions/coding-standardis used the Magento 2 coding standard is always used.What is the new behavior?
If we want to make this the default PHPCS coding standard workflow we should add an option to specify a custom coding standard. This is usefull for vendors who want to modify/add sniffs to the official Magento 2 coding standards.
For example, we have excluded some rules
You can see the new options in action here
In addition to this, i've also added
dealerdirect/phpcodesniffer-composer-installer, so all of the available phpcs standards in the project are automatically registered. The "Register Coding Standard" step became redundant and was removed.Does this PR introduce a breaking change?