Skip to content

Core: add section about trait use statement rules with select new sniffs #2303

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 19, 2023
Merged

Core: add section about trait use statement rules with select new sniffs #2303

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions WordPress-Core/ruleset.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -483,6 +483,35 @@
<rule ref="Generic.Files.OneObjectStructurePerFile"/>


<!--
#############################################################################
Handbook: Object-Oriented Programming - Trait Use Statements.
Ref: https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/#trait-use-statements
#############################################################################
-->
<!-- Covers rule: Trait use statements should be at the top of a class ... -->
<!-- Covered by the PSR12.Traits.UseDeclaration sniff. -->

<!-- Rule: ... and should have exactly one blank line before the first use statement,
and at least one blank line after the last statement.
The only exception is when the class only contains trait use statements,
in which case the blank line after may be omitted. -->
<!-- Blank line after covered by the PSR12.Traits.UseDeclaration sniff. -->

<!-- Covers rule: (example based rules: spacing, grouping and indentation). -->
<rule ref="PSR12.Traits.UseDeclaration"/>

<!-- Allow for a blank line between the OO statement and the first trait use statement. -->
<rule ref="PSR12.Traits.UseDeclaration.UseAfterBrace">
<severity>0</severity>
</rule>

<!-- Prevent duplicate messages - spacing after use is already covered by `Generic.WhiteSpace.LanguageConstructSpacing`. -->
<rule ref="PSR12.Traits.UseDeclaration.SpaceAfterUse">
<severity>0</severity>
</rule>


<!--
#############################################################################
Handbook: Object-Oriented Programming - Visibility should always be declared.
Expand Down