fix(VariableComment): Allow phpcs:ignore comments before member variables (#3477601)

Author: klausi

.github/workflows/testing.yml

@@ -80,6 +80,8 @@ jobs:
         if: ${{ matrix.extra-tests == '1' }}
         # In case Drupal core files have known problems that should be
         # ignored temporarily, add them with the --ignore option.
+        # @todo Remove ignore option once Coder 8.3.27 is released and Drupal
+        # core is updated to that version.
         run: |
           cd drupal/core
-          ../../vendor/bin/phpcs -p
+          ../../vendor/bin/phpcs -p -s --ignore=lib/Drupal/Core/Entity/EntityType.php,lib/Drupal/Core/Recipe/RecipeInputFormTrait.php,lib/Drupal/Core/Form/FormState.php,modules/migrate/src/Plugin/Migration.php,modules/views/src/ViewExecutable.php,modules/views/src/Plugin/views/style/StylePluginBase.php

coder_sniffer/Drupal/Sniffs/Commenting/VariableCommentSniff.php

@@ -11,6 +11,7 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\AbstractVariableSniff;
+use PHP_CodeSniffer\Util\Tokens;
 
 /**
  * Parses and verifies class property doc comments.
@@ -38,7 +39,7 @@ class VariableCommentSniff extends AbstractVariableSniff
     public function processMemberVar(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
-        $ignore = [
+        $ignore = ([
             T_PUBLIC            => T_PUBLIC,
             T_PRIVATE           => T_PRIVATE,
             T_PROTECTED         => T_PROTECTED,
@@ -57,7 +58,7 @@ public function processMemberVar(File $phpcsFile, $stackPtr)
             T_FALSE             => T_FALSE,
             T_SELF              => T_SELF,
             T_PARENT            => T_PARENT,
-        ];
+        ] + Tokens::$phpcsCommentTokens);
 
         for ($commentEnd = ($stackPtr - 1); $commentEnd >= 0; $commentEnd--) {
             if (isset($ignore[$tokens[$commentEnd]['code']]) === true) {

tests/Drupal/Commenting/VariableCommentUnitTest.inc

@@ -96,4 +96,10 @@ class Test {
    */
   protected UserStorageInterface&MockObject $userStorageMock2;
 
+  /**
+   * The search score.
+   */
+  // phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName
+  public string $search_score;
+
 }

tests/Drupal/Commenting/VariableCommentUnitTest.inc.fixed

@@ -100,4 +100,10 @@ class Test {
    */
   protected UserStorageInterface&MockObject $userStorageMock2;
 
+  /**
+   * The search score.
+   */
+  // phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName
+  public string $search_score;
+
 }