From 7444c9c03d11a0cb310b5782bcb69a80aa11b26d Mon Sep 17 00:00:00 2001 From: Rodrigo Primo Date: Wed, 10 Apr 2024 11:38:15 -0300 Subject: [PATCH 1/2] Squiz/ClosingDeclarationComment: sort registered tokens alphabetically This should make it easier to find if a given is registered by this sniff or not. --- .../Sniffs/Commenting/ClosingDeclarationCommentSniff.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Standards/Squiz/Sniffs/Commenting/ClosingDeclarationCommentSniff.php b/src/Standards/Squiz/Sniffs/Commenting/ClosingDeclarationCommentSniff.php index f059d05f93..f96940c5eb 100644 --- a/src/Standards/Squiz/Sniffs/Commenting/ClosingDeclarationCommentSniff.php +++ b/src/Standards/Squiz/Sniffs/Commenting/ClosingDeclarationCommentSniff.php @@ -24,10 +24,10 @@ class ClosingDeclarationCommentSniff implements Sniff public function register() { return [ - T_FUNCTION, T_CLASS, - T_INTERFACE, T_ENUM, + T_FUNCTION, + T_INTERFACE, ]; }//end register() From 6edc97ebf583d31184268f9562467b30f0e0c800 Mon Sep 17 00:00:00 2001 From: Rodrigo Primo Date: Wed, 10 Apr 2024 11:47:09 -0300 Subject: [PATCH 2/2] Squiz/ClosingDeclarationComment: add trait support Now this sniff will also check for the closing declaration comment in traits. --- .../Sniffs/Commenting/ClosingDeclarationCommentSniff.php | 5 ++++- .../Commenting/ClosingDeclarationCommentUnitTest.1.inc | 6 ++++++ .../ClosingDeclarationCommentUnitTest.1.inc.fixed | 6 ++++++ .../Tests/Commenting/ClosingDeclarationCommentUnitTest.php | 1 + 4 files changed, 17 insertions(+), 1 deletion(-) diff --git a/src/Standards/Squiz/Sniffs/Commenting/ClosingDeclarationCommentSniff.php b/src/Standards/Squiz/Sniffs/Commenting/ClosingDeclarationCommentSniff.php index f96940c5eb..44bd4388db 100644 --- a/src/Standards/Squiz/Sniffs/Commenting/ClosingDeclarationCommentSniff.php +++ b/src/Standards/Squiz/Sniffs/Commenting/ClosingDeclarationCommentSniff.php @@ -1,6 +1,6 @@ * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600) @@ -28,6 +28,7 @@ public function register() T_ENUM, T_FUNCTION, T_INTERFACE, + T_TRAIT, ]; }//end register() @@ -72,6 +73,8 @@ public function process(File $phpcsFile, $stackPtr) $comment = '//end class'; } else if ($tokens[$stackPtr]['code'] === T_INTERFACE) { $comment = '//end interface'; + } else if ($tokens[$stackPtr]['code'] === T_TRAIT) { + $comment = '//end trait'; } else { $comment = '//end enum'; }//end if diff --git a/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.1.inc b/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.1.inc index 5c9a9bcf4c..560370bfb1 100644 --- a/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.1.inc +++ b/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.1.inc @@ -116,3 +116,9 @@ $anon = new class {}; // Arrow functions don't need end comments. $arrow = fn($a) => $a; + +trait TestTrait { +}//end trait + +trait TestTrait { +} diff --git a/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.1.inc.fixed b/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.1.inc.fixed index 0b1f3faa21..8c69014528 100644 --- a/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.1.inc.fixed +++ b/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.1.inc.fixed @@ -109,3 +109,9 @@ $anon = new class {}; // Arrow functions don't need end comments. $arrow = fn($a) => $a; + +trait TestTrait { +}//end trait + +trait TestTrait { +}//end trait diff --git a/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.php b/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.php index e1752039b1..fcbb026423 100644 --- a/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.php +++ b/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.php @@ -50,6 +50,7 @@ public function getErrorList($testFile='') 101 => 1, 106 => 1, 110 => 1, + 124 => 1, ]; case 'ClosingDeclarationCommentUnitTest.4.inc':