Skip to content

Add the PHPCSExtra package and start using a pletora of sniffs from it #63

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 2 commits into from
Oct 31, 2025
Merged

Add the PHPCSExtra package and start using a pletora of sniffs from it #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc2e719
Composer: add PHPCSExtra
jrfnl Feb 12, 2020
1618418
Ruleset: add various sniffs from PHPCSExtra
jrfnl Sep 2, 2020
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
145 changes: 145 additions & 0 deletions PHPCSDev/ruleset.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,15 @@
</rule>


<!--
####################################################################
PHP: Modernize a codebase when possible.
####################################################################
-->

<rule ref="Modernize.FunctionCalls.Dirname.FileConstant"/>


<!--
####################################################################
Code style: Check style for compliance with PSR12.
Expand Down Expand Up @@ -81,20 +90,43 @@
</properties>
</rule>

<!-- Prevent PHP 8 named parameters confusion. -->
<rule ref="Universal.NamingConventions.NoReservedKeywordParameterNames"/>


<!--
####################################################################
Code style: Various other additions.
Some of these rules will probably be enforced via PERCS once it is available, but we already want to use them.
####################################################################
-->

<!-- Enforce lowercase PHP tags. -->
<rule ref="Universal.PHP.LowercasePHPTag"/>

<!-- Enforce consistency in import use statements. -->
<rule ref="Universal.UseStatements.NoLeadingBackslash"/>
<rule ref="Universal.UseStatements.KeywordSpacing"/>
<rule ref="Universal.UseStatements.LowercaseFunctionConst"/>

<!-- Consistent modifier keyword order. PSR12 currently only enforces this for property declarations. -->
<rule ref="Universal.Classes.ModifierKeywordOrder"/>
<rule ref="Universal.Constants.ModifierKeywordOrder"/>

<!-- PSR12 doesn't enforce consistency in where boolean operators are placed. We do. -->
<rule ref="PSR12.ControlStructures.BooleanOperatorPlacement">
<properties>
<property name="allowOnly" value="first"/>
</properties>
</rule>

<!-- Same thing, but then for multi-line concatenation in statements. -->
<rule ref="Universal.Operators.ConcatPosition">
<properties>
<property name="allowOnly" value="start"/>
</properties>
</rule>

<!-- PSR12 appears to ignore blank lines for superfluous whitespace and in several other places. Let's fix that. -->
<rule ref="Squiz.WhiteSpace.SuperfluousWhitespace">
<properties>
Expand Down Expand Up @@ -129,6 +161,23 @@
<!-- No spacing inside heredoc/nowdocs identifiers. -->
<rule ref="Generic.WhiteSpace.HereNowdocIdentifierSpacing"/>

<!-- No spaces around type operators. -->
<rule ref="Universal.Operators.TypeSeparatorSpacing"/>

<!-- Always use parentheses when instantiating anonymous classes. -->
<rule ref="Universal.Classes.RequireAnonClassParentheses"/>

<!-- No space between the class keyword and the open parentheses for anonymous classes. -->
<rule ref="Universal.WhiteSpace.AnonClassKeywordSpacing"/>

<!-- Enforce consistent spacing around commas (no space before, one space or new line after). -->
<rule ref="Universal.WhiteSpace.CommaSpacing">
<exclude name="Universal.WhiteSpace.CommaSpacing.TooMuchSpaceAfterCommaBeforeTrailingComment"/>
</rule>

<!-- Disallow precision alignment (indentation). -->
<rule ref="Universal.WhiteSpace.PrecisionAlignment"/>

<!-- Align the equal operator in assignment blocks. -->
<rule ref="Generic.Formatting.MultipleStatementAlignment">
<properties>
Expand All @@ -148,24 +197,57 @@
<!-- Disallow Yoda conditions. -->
<rule ref="Generic.ControlStructures.DisallowYodaConditions"/>

<!-- Disallow alternative syntax for control structures. -->
<rule ref="Universal.ControlStructures.DisallowAlternativeSyntax"/>

<!-- Use self or static when referring to the class in use. -->
<rule ref="Squiz.Classes.SelfMemberReference"/>
<rule ref="Universal.CodeAnalysis.StaticInFinalClass"/>

<!-- Only one namespace per file. -->
<rule ref="Universal.Namespaces.OneDeclarationPerFile"/>

<!-- Don't allow curly brace syntax for namespace declarations. -->
<rule ref="Universal.Namespaces.DisallowCurlyBraceSyntax"/>

<!-- Only one object structure per file. -->
<rule ref="Generic.Files.OneObjectStructurePerFile"/>

<!-- And don't mix OO declarations and function declarations in one file. -->
<rule ref="Universal.Files.SeparateFunctionsFromOO"/>

<!-- Disallow non-strict comparisons and the use of the not operator. -->
<rule ref="Squiz.Operators.ComparisonOperatorUsage">
<exclude name="Squiz.Operators.ComparisonOperatorUsage.ImplicitTrue"/>
</rule>

<!-- Enforce lowercase ::class. -->
<rule ref="Universal.Constants.LowercaseClassResolutionKeyword"/>

<!-- PHP native magic constants should be uppercase. -->
<rule ref="Universal.Constants.UppercaseMagicConstants"/>

<!-- Alphabetize lists of extended and implemented interfaces. -->
<rule ref="Universal.OOStructures.AlphabeticExtendsImplements"/>

<!-- Disallow the use of fully qualified true/false/null. -->
<rule ref="Universal.PHP.NoFQNTrueFalseNull"/>

<!-- Prevent really long lists with all (global) functions/constants used in a file. -->
<rule ref="Universal.UseStatements.DisallowUseConst"/>
<rule ref="Universal.UseStatements.DisallowUseFunction"/>


<!--
####################################################################
Code style: Array declarations.
####################################################################
-->

<!-- This (incomplete) ruleset may cause some duplication for now, but that will be fixed once
the ruleset is completed and we can remove the `Squiz.Arrays.ArrayDeclaration` sniff. -->
<rule ref="NormalizedArrays"/>

<!-- Enforce short array syntax. -->
<rule ref="Generic.Arrays.DisallowLongArraySyntax"/>

Expand Down Expand Up @@ -226,12 +308,33 @@
</rule>


<!--
####################################################################
PHPCS compatibility additions.
####################################################################
-->

<!-- The PHPCS autoloader does not handle sniffs which extends other sniffs well, so prevent problems by making all sniffs final. -->
<rule ref="Universal.Classes.RequireFinalClass"/>

<!-- Enforce methods in traits to be final to prevent (accidental) overloading. -->
<rule ref="Universal.FunctionDeclarations.RequireFinalMethodsInTraits"/>


<!--
####################################################################
Code Analysis additions.
####################################################################
-->

<!-- Testability: long closures make for code which is more difficult to test. -->
<rule ref="Universal.FunctionDeclarations.NoLongClosures">
<!-- Disable the warning after 5 lines, only have the error after 8 lines. -->
<properties>
<property name="recommendedLines " value="1000"/>
</properties>
</rule>

<!-- Efficiency: don't use function calls within the condition of a for loop. -->
<rule ref="Generic.CodeAnalysis.ForLoopWithTestFunctionCall"/>

Expand All @@ -244,6 +347,9 @@
<!-- Efficiency: don't unnecessarily use heredocs. -->
<rule ref="Generic.Strings.UnnecessaryHeredoc"/>

<!-- Efficiency: simplify code when possible. -->
<rule ref="Universal.CodeAnalysis.NoEchoSprintf"/>

<!-- Error prevention: warns when an inner loop uses the same incrementor as the outer loop. -->
<rule ref="Generic.CodeAnalysis.JumbledIncrementer"/>

Expand All @@ -255,6 +361,36 @@
<!-- Error prevention: use parentheses when mixing boolean operators. -->
<rule ref="Generic.CodeAnalysis.RequireExplicitBooleanOperatorPrecedence"/>

<!-- Error prevention: Don't allow mixed arrays (keyed/non-keyed). -->
<rule ref="Universal.Arrays.MixedKeyedUnkeyedArray"/>

<!-- Error prevention: Don't allow mixed arrays (integer/string keys). -->
<rule ref="Universal.Arrays.MixedArrayKeyTypes"/>

<!-- Error prevention: Prevent issues with duplicate arrays keys. -->
<rule ref="Universal.Arrays.DuplicateArrayKey"/>

<!-- Error prevention: Prevent issues with precedent order. -->
<rule ref="Universal.Operators.DisallowLogicalAndOr"/>

<!-- Error prevention: Prevent logic errors as most devs don't understand short ternary well enough. -->
<rule ref="Universal.Operators.DisallowShortTernary"/>

<!-- Error prevention: Prevent issues when in/decremented variables get moved around and are suddenly no longer stand-alone. -->
<rule ref="Universal.Operators.DisallowStandalonePostIncrementDecrement"/>

<!-- Error prevention: Prevent creation of constructor/destructors which will not work as expected. -->
<rule ref="Universal.CodeAnalysis.ConstructorDestructorReturn"/>

<!-- Error prevention: Prevent unpredictable code behaviour. -->
<rule ref="Universal.CodeAnalysis.ForeachUniqueAssignment"/>

<!-- Error prevention: Prevent incomprehensible code. -->
<rule ref="Universal.CodeAnalysis.NoDoubleNegative"/>

<!-- Error prevention: don't allow people to do silly things. -->
<rule ref="Universal.PHP.OneStatementInShortEchoTag"/>

<!-- Clean up: remove redundant code. -->
<rule ref="Squiz.PHP.NonExecutableCode">
<!-- Allow for return statement in otherwise empty function. -->
Expand All @@ -264,7 +400,16 @@
<!-- Clean up: no empty statements. -->
<rule ref="Generic.CodeAnalysis.EmptyPHPStatement"/>

<!-- Clean up: no lonely if statements. -->
<rule ref="Universal.ControlStructures.DisallowLonelyIf"/>

<!-- Clean up: no useless aliases in import use statements. -->
<rule ref="Universal.UseStatements.NoUselessAliases"/>

<!-- Parse error prevention: guard against merge conflict artifacts. -->
<rule ref="Generic.VersionControl.GitMergeConflict"/>

<!-- Lower cognitive load. -->
<rule ref="Universal.UseStatements.DisallowMixedGroupUse"/>

</ruleset>
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"php" : ">=5.4",
"squizlabs/php_codesniffer" : "^3.13.3 || ^4.0.0",
"phpcompatibility/php-compatibility" : "^10.0.0@dev",
"dealerdirect/phpcodesniffer-composer-installer" : "^0.7 || ^1.0"
Copy link
Member Author

@jrfnl jrfnl Oct 31, 2025

Choose a reason for hiding this comment

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

Note: we inherit the Composer installer plugin now via both PHPCSExtra and PHPCompatibility.
Better not to have our own requirement to prevent conflicts between the allowed versions.

"phpcsstandards/phpcsextra" : "^1.4.2"
},
"require-dev" : {
"roave/security-advisories" : "dev-master"
Expand Down