Skip to content

CS: normalize code style rules [9] #1252

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
Sep 13, 2025
Merged

CS: normalize code style rules [9] #1252

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6e8853
PHPCS: remove redundant exclusion
jrfnl Sep 13, 2025
dc5bced
PHPCS: add some extra function comment rules
jrfnl Sep 13, 2025
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
18 changes: 13 additions & 5 deletions phpcs.xml.dist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,11 +157,6 @@
<!-- Do not allow ambiguous conditions. -->
<rule ref="Generic.CodeAnalysis.RequireExplicitBooleanOperatorPrecedence"/>

<!-- The testing bootstrap file uses string concats to stop IDEs seeing the class aliases -->
<rule ref="Generic.Strings.UnnecessaryStringConcat">
<exclude-pattern>tests/bootstrap\.php</exclude-pattern>
</rule>

<!-- This test file specifically *needs* Windows line endings for testing purposes. -->
<rule ref="Generic.Files.LineEndings.InvalidEOLChar">
<exclude-pattern>tests/Core/Tokenizers/PHP/*WinTest\.php</exclude-pattern>
Expand All @@ -187,4 +182,17 @@
<!-- Prevent conflict with function spacing sniff. -->
<exclude-pattern>/requirements\.php</exclude-pattern>
</rule>

<!-- Use select error codes from the Squiz FunctionComment sniff, which shouldn't conflict with the PEAR sniff. -->
<rule ref="Squiz.Commenting.FunctionComment.InvalidReturnVoid"/>
<rule ref="Squiz.Commenting.FunctionComment.InvalidNoReturn"/>
<rule ref="Squiz.Commenting.FunctionComment.InvalidReturnNotVoid"/>
<rule ref="Squiz.Commenting.FunctionComment.ThrowsNotCapital"/>
<rule ref="Squiz.Commenting.FunctionComment.ThrowsNoFullStop"/>
<rule ref="Squiz.Commenting.FunctionComment.InvalidReturnVoid"/>
<rule ref="Squiz.Commenting.FunctionComment.IncorrectTypeHint"/>
<rule ref="Squiz.Commenting.FunctionComment.InvalidTypeHint"/>
<rule ref="Squiz.Commenting.FunctionComment.ParamNameUnexpectedAmpersandPrefix"/>
<rule ref="Squiz.Commenting.FunctionComment.ParamCommentNotCapital"/>

</ruleset>
Loading