Skip to content
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.

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

Squiz.WhiteSpace.MemberVarSpacing false positives when attributes used without docblock #3440

Merged

Conversation

javer
Copy link
Contributor

@javer javer commented Sep 24, 2021

Fixes false positives when class properties are declared with attributes and without DocComment.
Without this fix it's impossible to use only attributes for properties without DocComments, because this sniff forces you to insert blank line between the property and the attribute:

Expected 1 blank line(s) before member var; 0 found (Squiz.WhiteSpace.MemberVarSpacing.Incorrect)

Actual result:

--- src/Standards/Squiz/Tests/WhiteSpace/MemberVarSpacingUnitTest.inc.fixed
+++ PHP_CodeSniffer
@@ -363,12 +363,14 @@
{
     protected $propertyDouble;
     #[ThirdAttribute]
+
     protected $propertyWithoutSpacing;
 }

Expected result:

--- src/Standards/Squiz/Tests/WhiteSpace/MemberVarSpacingUnitTest.inc.fixed
+++ PHP_CodeSniffer
@@ -363,12 +363,14 @@
{
     protected $propertyDouble;
+
     #[ThirdAttribute]
     protected $propertyWithoutSpacing;
 }

@javer
Copy link
Contributor Author

javer commented Sep 28, 2021

@gsherwood Could you please take a look on this simple fix, which allows everybody to use property attributes without doc-comment?

@gsherwood gsherwood added this to Idea Bank in PHPCS v3 Development via automation Sep 29, 2021
@gsherwood gsherwood added this to the 3.6.2 milestone Sep 29, 2021
@jrfnl
Copy link
Contributor

jrfnl commented Oct 10, 2021

This is a more selective fix compared to PR #3334, which is open for the same and has an associated discussion open in #3419.

@javer javer force-pushed the fix-property-spacing-with-attributes branch from a247461 to 7f7a2cc Compare November 28, 2021 18:41
@javer
Copy link
Contributor Author

javer commented Nov 28, 2021

Rebased on the latest master to make the build green.

@gsherwood gsherwood changed the title PHP 8.0 | Squiz.WhiteSpace.MemberVarSpacing: fix support for attributes Squiz.WhiteSpace.MemberVarSpacing false positives when attributes used without docblock Dec 3, 2021
gsherwood added a commit that referenced this pull request Dec 3, 2021
@gsherwood gsherwood merged commit 7f7a2cc into squizlabs:master Dec 3, 2021
PHPCS v3 Development automation moved this from Idea Bank to Ready for Release Dec 3, 2021
@gsherwood
Copy link
Member

Thanks for finding, reporting, and fixing this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
PHPCS v3 Development
Ready for Release
Development

Successfully merging this pull request may close these issues.

None yet

3 participants