style: auto formatting

Author: yCodeTech

yCodeTech/Sniffs/Commenting/DocblockFormatSniff.php

@@ -41,8 +41,6 @@ public function register()
      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
      * @param int $stackPtr The position of the current token in the
      *                                               stack passed in $tokens.
-     *
-     * @return void
      */
     public function process(File $phpcsFile, $stackPtr)
     {
@@ -63,13 +61,11 @@ public function process(File $phpcsFile, $stackPtr)
      *
      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
      * @param int $stackPtr The position of the @return token.
-     *
-     * @return void
      */
     private function checkReturnEmptyLine(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
-        
+
         // First, check if there are any other @ tags before this @return
         $hasOtherTags = false;
         $docBlockStart = $phpcsFile->findPrevious([T_DOC_COMMENT_OPEN_TAG], $stackPtr);
@@ -81,12 +77,12 @@ private function checkReturnEmptyLine(File $phpcsFile, $stackPtr)
                 }
             }
         }
-        
+
         // If there are no other tags before @return, don't require empty line
         if (!$hasOtherTags) {
             return;
         }
-        
+
         // Find the previous non-whitespace token
         $prev = $phpcsFile->findPrevious([T_DOC_COMMENT_WHITESPACE, T_DOC_COMMENT_STAR], ($stackPtr - 1), null, true);
         if ($prev === false) {
@@ -134,7 +130,7 @@ private function checkReturnEmptyLine(File $phpcsFile, $stackPtr)
                         break;
                     }
                 }
-                
+
                 $starIndent = str_repeat(' ', $starColumn - 1);
                 $newContent = $phpcsFile->eolChar . $starIndent . '*' . $phpcsFile->eolChar . $starIndent . '* ';
                 $phpcsFile->fixer->addContent($prev, $newContent);
@@ -148,8 +144,6 @@ private function checkReturnEmptyLine(File $phpcsFile, $stackPtr)
      *
      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
      * @param int $stackPtr The position of the @ tag token.
-     *
-     * @return void
      */
     private function checkTagSpacing(File $phpcsFile, $stackPtr)
     {
@@ -198,10 +192,10 @@ private function checkTagSpacing(File $phpcsFile, $stackPtr)
 
         // Replace all spaces that are 2 or more consecutive spaces, with a single space
         $normalizedContent = preg_replace('/( ){2,}/', ' ', $content);
-        
+
         // Fix missing space between type and variable
         $normalizedContent = preg_replace('/^([^\s]+)(\$\w+)/', '$1 $2', $normalizedContent);
-        
+
         // Check if content needs normalization
         if ($content !== $normalizedContent) {
             $needsFixing = true;
@@ -212,15 +206,15 @@ private function checkTagSpacing(File $phpcsFile, $stackPtr)
             $fix = $phpcsFile->addFixableError($error, $contentToken, 'TagSpacing');
             if ($fix === true) {
                 $phpcsFile->fixer->beginChangeset();
-                
+
                 // If there was a whitespace token, replace it and normalize content
                 if ($tokens[$next]['code'] === T_DOC_COMMENT_WHITESPACE) {
                     $phpcsFile->fixer->replaceToken($next, ' ');
                     $phpcsFile->fixer->replaceToken($contentToken, $normalizedContent);
                 }
-                
+
                 $phpcsFile->fixer->endChangeset();
             }
         }
     }
-}
+}

yCodeTech/Sniffs/Types/DisallowTypeLongNamesSniff.php

@@ -48,7 +48,7 @@ class DisallowTypeLongNamesSniff implements Sniff
 
     /**
      * Returns an array of tokens this test wants to listen for.
-     * 
+     *
      * Once PHP_CodeSniffer encounters one of these tokens, it calls the process method.
      *
      * @return array<int>
@@ -70,8 +70,6 @@ public function register()
      *
      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
      * @param int $stackPtr The position of the current token in the stack.
-     *
-     * @return void
      */
     public function process(File $phpcsFile, $stackPtr)
     {
@@ -107,8 +105,6 @@ public function process(File $phpcsFile, $stackPtr)
      *
      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
      * @param int $stackPtr The position of the current token in the stack.
-     *
-     * @return void
      */
     private function processDocblockTag(File $phpcsFile, $stackPtr)
     {
@@ -156,8 +152,6 @@ private function processDocblockTag(File $phpcsFile, $stackPtr)
      *
      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
      * @param int $stackPtr The position of the current token in the stack.
-     *
-     * @return void
      */
     private function processFunctionTypes(File $phpcsFile, $stackPtr)
     {
@@ -212,8 +206,6 @@ private function processFunctionTypes(File $phpcsFile, $stackPtr)
      *
      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
      * @param int $stackPtr The position of the current token in the stack.
-     *
-     * @return void
      */
     private function processPropertyType(File $phpcsFile, $stackPtr)
     {
@@ -222,7 +214,7 @@ private function processPropertyType(File $phpcsFile, $stackPtr)
         // Look backwards to find the visibility keyword.
         $visibilityTokens = [T_PUBLIC, T_PRIVATE, T_PROTECTED, T_STATIC, T_VAR];
         $visibilityPtr = $phpcsFile->findPrevious($visibilityTokens, $stackPtr - 1);
-        
+
         if ($visibilityPtr === false) {
             return;
         }
@@ -251,8 +243,7 @@ private function processPropertyType(File $phpcsFile, $stackPtr)
      * @param int $stackPtr The position of the type token.
      * @param string $context The context (parameter, return, property).
      * @param array $data Data to format the error message with.
-     *
-     * @return void
+     * @param string|null $docblockTagName The docblock tag name if applicable.
      */
     private function checkTypeToken(File $phpcsFile, $stackPtr, $context, $docblockTagName = null)
     {
@@ -261,7 +252,7 @@ private function checkTypeToken(File $phpcsFile, $stackPtr, $context, $docblockT
         if (isset($this->processedTokens[$filename][$stackPtr])) {
             return;
         }
-        
+
         // Mark this token as processed
         $this->processedTokens[$filename][$stackPtr] = true;
 
@@ -276,14 +267,14 @@ private function checkTypeToken(File $phpcsFile, $stackPtr, $context, $docblockT
         foreach ($extractedTypes as $extractedType) {
             // Get the short type name from the mapping.
             $shortType = $this->typeNames[$extractedType];
-            
+
             // This pattern matches for both simple types and types within generic type syntax,
             // using word boundaries to avoid partial matches.
             $pattern = '/\b' . preg_quote($extractedType, '/') . '\b/i';
 
             // Replace long name type with short name in the entire content.
             $replacedContent = preg_replace($pattern, $shortType, $replacedContent);
-            
+
             // Double-check that replacement actually happened, by comparing the original
             // content with the replaced content.
             // If replacement occurred, we will report an error.
@@ -311,8 +302,6 @@ private function checkTypeToken(File $phpcsFile, $stackPtr, $context, $docblockT
      * @param string $context The context (parameter, return, property, etc.).
      * @param string|null $docblockTagName The docblock tag name if applicable.
      * @param string $replacedContent The replacement content.
-     *
-     * @return void
      */
     private function reportAndFixError(
         File $phpcsFile,
@@ -425,4 +414,4 @@ private function extractTypesFromContent($content)
         // Return all found long-form types
         return array_unique($foundTypes);
     }
-}
+}

yCodeTech/Tests/Commenting/DocblockFormatUnitTest.php

@@ -53,4 +53,4 @@ public function getWarningList()
     {
         return [];
     }
-}
+}

yCodeTech/Tests/README.md

@@ -36,6 +36,7 @@ composer test-all
 ### Option 2: Manual Testing
 
 Test individual sniffs:
+
 ```bash
 # Test DisallowTypeLongNamesSniff
 vendor/bin/phpcs --standard=./yCodeTech/ruleset.xml yCodeTech/Tests/Types/DisallowTypeLongNamesUnitTest.inc
@@ -50,6 +51,7 @@ vendor/bin/phpcs --standard=./yCodeTech/ruleset.xml yCodeTech/Tests/Commenting/F
 ### Option 3: Auto-fix Testing
 
 Test that violations can be automatically fixed:
+
 ```bash
 # Copy test file and run auto-fix
 cp yCodeTech/Tests/Types/DisallowTypeLongNamesUnitTest.inc temp_test.php
@@ -60,54 +62,59 @@ rm temp_test.php
 ## Test Coverage
 
 ### DisallowTypeLongNamesSniff Tests
-- ✅ `boolean` → `bool` conversion in @param tags
-- ✅ `integer` → `int` conversion in @param tags  
-- ✅ `boolean` → `bool` conversion in @return tags
-- ✅ `integer` → `int` conversion in @return tags
-- ✅ `boolean` → `bool` conversion in @var tags
-- ✅ `integer` → `int` conversion in @var tags
-- ✅ `boolean` → `bool` conversion in @property tags
-- ✅ `integer` → `int` conversion in @property tags
-- ✅ Static analysis tags (@phpstan-*, @psalm-*)
-- ✅ Union types (boolean|string → bool|string)
-- ✅ Function parameter type declarations
-- ✅ Function return type declarations
-- ✅ Class property type declarations
-- ✅ Type casting (boolean) → (bool), (integer) → (int)
-- ✅ Nullable types (?boolean → ?bool)
-- ✅ Context-aware detection (no duplicates)
+
+-   ✅ `boolean` → `bool` conversion in @param tags
+-   ✅ `integer` → `int` conversion in @param tags
+-   ✅ `boolean` → `bool` conversion in @return tags
+-   ✅ `integer` → `int` conversion in @return tags
+-   ✅ `boolean` → `bool` conversion in @var tags
+-   ✅ `integer` → `int` conversion in @var tags
+-   ✅ `boolean` → `bool` conversion in @property tags
+-   ✅ `integer` → `int` conversion in @property tags
+-   ✅ Static analysis tags (@phpstan-\*, @psalm-\*)
+-   ✅ Union types (boolean|string → bool|string)
+-   ✅ Function parameter type declarations
+-   ✅ Function return type declarations
+-   ✅ Class property type declarations
+-   ✅ Type casting (boolean) → (bool), (integer) → (int)
+-   ✅ Nullable types (?boolean → ?bool)
+-   ✅ Context-aware detection (no duplicates)
 
 ### DocblockFormatSniff Tests
-- ✅ Exactly 1 space between @param elements
-- ✅ Zero space detection and fixing
-- ✅ Multiple space detection and fixing  
-- ✅ Empty line before @return tag
-- ✅ All @ tag types (param, return, var, throws, see, etc.)
-- ✅ Static analysis tag spacing
+
+-   ✅ Exactly 1 space between @param elements
+-   ✅ Zero space detection and fixing
+-   ✅ Multiple space detection and fixing
+-   ✅ Empty line before @return tag
+-   ✅ All @ tag types (param, return, var, throws, see, etc.)
+-   ✅ Static analysis tag spacing
 
 ### FunctionCommentSniff Tests
-- ✅ Missing @return tag detection
-- ✅ Auto-insertion of @return mixed
-- ✅ Void function detection (explicit void)
-- ✅ Implicit void function detection (echo-only)
-- ✅ Empty return statement detection
-- ✅ Correct indentation for auto-inserted tags
+
+-   ✅ Missing @return tag detection
+-   ✅ Auto-insertion of @return mixed
+-   ✅ Void function detection (explicit void)
+-   ✅ Implicit void function detection (echo-only)
+-   ✅ Empty return statement detection
+-   ✅ Correct indentation for auto-inserted tags
 
 ## Expected Results
 
 Each test file contains deliberate violations that should be detected by the corresponding sniff. The test classes define the exact line numbers where errors should occur.
 
 When running the tests, you should see:
-- **All violations detected** on the expected lines
-- **Auto-fixing capabilities** working correctly
-- **No false positives** on correct code
+
+-   **All violations detected** on the expected lines
+-   **Auto-fixing capabilities** working correctly
+-   **No false positives** on correct code
 
 ## Integration Testing
 
 The `StandardIntegrationTest` provides comprehensive testing of all sniffs working together, ensuring:
-- No conflicts between sniffs
-- Proper violation detection across all rule types
-- Consistent behavior of the entire standard
+
+-   No conflicts between sniffs
+-   Proper violation detection across all rule types
+-   Consistent behaviour of the entire standard
 
 ## Adding New Tests
 

yCodeTech/Tests/Types/DisallowTypeLongNamesUnitTest.php

@@ -6,7 +6,7 @@
 
 /**
  * Unit test class for DisallowTypeLongNamesSniff
- * 
+ *
  * The code to test are split into several .inc files to cover different scenarios.
  * As documented here: https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/4.x/.github/CONTRIBUTING.md#multiple-test-case-files
  */
@@ -33,13 +33,13 @@ public function getErrorList($testFile = "")
                     12 => 1,  // @param boolean
                     13 => 1,  // @param integer
                     15 => 1,  // @return boolean
-                    
+
                     // Class docblock errors
                     25 => 1,  // @property integer
                     26 => 1,  // @property-read integer
                     27 => 1,  // @property-write boolean
                     28 => 1,  // @method boolean
-                    
+
                     // Property and method docblock errors
                     35 => 1,  // @var boolean
                     42 => 1,  // @param boolean
@@ -60,7 +60,7 @@ public function getErrorList($testFile = "")
                     // Global type casting errors
                     10 => 1,  // (boolean) cast
                     11 => 1,  // (integer) cast
-                    
+
                     // Function type casting errors
                     18 => 1,  // (boolean) cast
                     19 => 1,  // (integer) cast
@@ -79,7 +79,7 @@ public function getErrorList($testFile = "")
                     13 => 1,  // @param array<string, integer>
                     14 => 2,  // @param Collection<boolean, integer>
                     16 => 2,  // @return Map<integer, boolean>
-                    
+
                     // Complex generic errors
                     26 => 2,  // @param Generator<integer, boolean>
                     27 => 1,  // @param Promise<boolean>
@@ -103,4 +103,4 @@ public function getWarningList()
     {
         return [];
     }
-}
+}