4.0 | PSR12/FileHeader: make "SpacingAfter" and "SpacingInside" errorcodes modular #35
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
jrfnl
force-pushed
the
feature/psr12-fileheader-more-modular-errorcode-spacing-after
branch
2 times, most recently
from
73c72b9 to
43504ca
Compare
jrfnl
force-pushed
the
feature/psr12-fileheader-more-modular-errorcode-spacing-after
branch
from
43504ca to
9049c5c
Compare
jrfnl
changed the title
jrfnl
force-pushed
the
feature/psr12-fileheader-more-modular-errorcode-spacing-after
branch
2 times, most recently
from
c718ba3 to
650a507
Compare
jrfnl
force-pushed
the
feature/psr12-fileheader-more-modular-errorcode-spacing-after
branch
from
650a507 to
05662c5
Compare
…modular This changes the error codes for the `SpacingAfterBlock` and `SpacingInsideBlock` errors to modular error codes which include a reference to the type of header block, i.e. `SpacingAfterDeclareBlock`, `SpacingInsideUseFunctionBlock` etc. This allows for more selective application of the rules. Take for instance the quite common case of the header blocks all being separated by blank lines, except for the open tag and file docblock. ```php <?php /** * File docblock. */ namespace A\B\C; use B\C; ``` The modular errorcodes I'm proposing in this PR will allow for the sniff to be used to safeguard the blank lines between each section without enforcing a blank line between the PHP open tag and the file docblock using: ```xml <rule ref="PSR12.Files.FileHeader"> <exclude name="PSR12.Files.FileHeader.SpacingAfterTagBlock"/> </rule> ``` Fixes #3453
jrfnl
force-pushed
the
feature/psr12-fileheader-more-modular-errorcode-spacing-after
branch
from
05662c5 to
c9c4d05
Compare
fredden
approved these changes
Apr 15, 2025
jrfnl
deleted the
feature/psr12-fileheader-more-modular-errorcode-spacing-after
branch
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.
Description
Recreation of upstream PR squizlabs/PHP_CodeSniffer#2729:
Suggested changelog entry
PSR12.Files.FileHeadersniff now has more modular error codes to allow for more selectively applying the rules.PSR12.Files.FileHeader.SpacingAfterBlockerror code is replaced by:PSR12.Files.FileHeader.SpacingAfterTagBlockPSR12.Files.FileHeader.SpacingAfterDocblockBlockPSR12.Files.FileHeader.SpacingAfterDeclareBlockPSR12.Files.FileHeader.SpacingAfterNamespaceBlockPSR12.Files.FileHeader.SpacingAfterUseBlockPSR12.Files.FileHeader.SpacingAfterUseFunctionBlockPSR12.Files.FileHeader.SpacingAfterUseConstBlockPSR12.Files.FileHeader.SpacingInsideBlockerror code is replaced by:PSR12.Files.FileHeader.SpacingInsideUseBlockPSR12.Files.FileHeader.SpacingInsideUseFunctionBlockPSR12.Files.FileHeader.SpacingInsideUseConstBlock