✨ New Universal.Attributes.BracketSpacing sniff#406
Merged
Conversation
New sniff to enforce a fixed number of spaces on the inside of attribute block brackets. By default, the sniff expects `0` spaces, but this is configurable via a custom ruleset using the `spaces` property. Also by default, new lines will not be allowed. This setting can also be toggled by changing the `ignoreNewlines` property in a custom ruleset. Additionally, when `ignoreNewlines` is set to `true`, the sniff will also check there are no blank lines at the start or end of the attribute block. Note: the `$spacing` and `$ignoreNewlines` property names are chosen to be in line with commonly used property names as used in PHPCS itself. This sniff can be used with the default settings to address the following rule from PER-CS: > 12.1 Basics > ... > Attribute names MUST immediately follow the opening attribute block indicator `#[` with no space. > > The closing attribute block indicator `]` MUST follow the last character of the attribute name or the closing `)` of its argument list, with no preceding space. Ref: https://www.php-fig.org/per/coding-style/#121-basics Includes fixers. Includes unit tests. Includes documentation. Fixes 386
Member
Author
|
Rebased without changes to get a passing build against the new CI requirements. |
7e4d7cf to
a668bf2
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
New sniff to enforce a fixed number of spaces on the inside of attribute block brackets. By default, the sniff expects
0spaces, but this is configurable via a custom ruleset using thespacesproperty.Also by default, new lines will not be allowed. This setting can also be toggled by changing the
ignoreNewlinesproperty in a custom ruleset.Additionally, when
ignoreNewlinesis set totrue, the sniff will also check there are no blank lines at the start or end of the attribute block.Note: the
$spacingand$ignoreNewlinesproperty names are chosen to be in line with commonly used property names as used in PHPCS itself.This sniff can be used with the default settings to address the following rule from PER-CS:
Ref: https://www.php-fig.org/per/coding-style/#121-basics
Includes fixers.
Includes metrics.
Includes unit tests.
Includes documentation.
Fixes #386