Enforce PSR-12 and organise imports on Winter CMS core files #1188
Conversation
This file contains 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
This commit changes the PHP code sniffer to use PSR-12 rules, as that ruleset will pick up a lot of the code style issues being flagged in PRs recently. In order to set the baseline, all current core files have been reformatted to fit the ruleset.
- Convert all aliases to qualified class names (mainly facades) - Reorder imports alphabetically - Ensure last item in array has a trailing comma - Strip out unused imports
bennothommo
changed the title
LukeTowers
reviewed
Aug 23, 2024
LukeTowers
reviewed
Aug 23, 2024
LukeTowers
reviewed
Aug 23, 2024
LukeTowers
reviewed
Aug 23, 2024
LukeTowers
reviewed
Aug 23, 2024
LukeTowers
reviewed
Aug 23, 2024
LukeTowers
reviewed
Aug 23, 2024
LukeTowers
reviewed
Aug 23, 2024
|
@bennothommo can you submit a PR to our developer guidelines docs to reflect these changes? Also, is it worth adding a Another thing to check is our stub files, I'm not sure if they've all been updated to our latest preferences for generating PHP files. |
This will allow us to use the ruleset in plugins as well
With new ruleset, it now passes
This command will allow developers to check code style against the Winter CMS code style rules in both the core and installed plugins.
LukeTowers
reviewed
Sep 4, 2024
| parent::__construct(); | ||
|
|
||
| // Register aliases for backwards compatibility with October | ||
| $this->setAliases(['winter:phpcs']); |
There was a problem hiding this comment.
We have a property for that already: https://github.com/wintercms/winter/blob/develop/modules/system/console/asset/mix/MixCompile.php#L34-L39
bennothommo
added
enhancement
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This commit changes the PHP code sniffer to use PSR-12 rules, as that ruleset will pick up a lot of the code style issues being flagged in PRs recently.
In order to set the baseline, all current core files have been reformatted to fit the ruleset.
I have also implemented rules around imports in files - mainly, taking out the aliases and using qualified facades and class names, and stripping out unused imports. This will improve IDE support for PHP intelligence and code completion.
Arrays are also now enforced to have a trailing comma to improve diffs.
Sorry in advance for the code review... 😬
php artisan winter:phpcscommand