Merge pull request #8 from PHPCSStandards/feature/tokenlist-enhance-output

Debug\TokenList: enhance the output

Author: jrfnl

Debug/Sniffs/Debug/TokenListSniff.php

@@ -60,10 +60,23 @@ public function register()
     public function process(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
+        $last   = ($phpcsFile->numTokens - 1);
+
+        $ptrPadding  = max(3, strlen($last));
+        $linePadding = strlen($tokens[$last]['line']);
 
         $oldIniValue = \ini_set('xdebug.overload_var_dump', 1);
 
         echo \PHP_EOL;
+        echo \str_pad('Ptr', $ptrPadding, ' ', \STR_PAD_BOTH),
+            ' :: ', \str_pad('Ln', ($linePadding + 1), ' ', \STR_PAD_BOTH),
+            ' :: ', \str_pad('Col', 4, ' ', \STR_PAD_BOTH),
+            ' :: ', 'Cond',
+            ' :: ', \str_pad('Token Type', 26), // Longest token type name is 26 chars.
+            ' :: [len]: Content', \PHP_EOL;
+
+        echo \str_repeat('-', ($ptrPadding + $linePadding + 35 + 16 + 18)), \PHP_EOL;
+
         foreach ($tokens as $ptr => $token) {
             if (isset($token['length']) === false) {
                 $token['length'] = strlen($token['content']);
@@ -82,8 +95,17 @@ public function process(File $phpcsFile, $stackPtr)
                 }
             }
 
-            echo $ptr, ' :: L', \str_pad($token['line'], 3, '0', \STR_PAD_LEFT), ' :: C', $token['column'],
-                ' :: ', $token['type'], ' :: (', $token['length'], ') :: ', $content, \PHP_EOL;
+            $conditionCount = 'F'; // False.
+            if (isset($token['conditions'])) {
+                $conditionCount = count($token['conditions']);
+            }
+
+            echo \str_pad($ptr, $ptrPadding, ' ', \STR_PAD_LEFT),
+                ' :: L', \str_pad($token['line'], $linePadding, '0', \STR_PAD_LEFT),
+                ' :: C', \str_pad($token['column'], 3, ' ', \STR_PAD_LEFT),
+                ' :: CC', \str_pad($conditionCount, 2, ' ', \STR_PAD_LEFT),
+                ' :: ', \str_pad($token['type'], 26), // Longest token type name is 26 chars.
+                ' :: [', $token['length'], ']: ', $content, \PHP_EOL;
         }
 
         // If necessary, reset the ini setting.

Debug/Tests/Debug/TokenListUnitTest.php

@@ -15,7 +15,7 @@
 /**
  * Unit test class for the TokenList sniff.
  *
- * @covers PHPCSStandards\Debug\Sniffs\Debug::TokenListSniff
+ * @covers PHPCSStandards\Debug\Sniffs\Debug\TokenListSniff
  *
  * @since 1.0.0
  */

Debug/Tests/Debug/TokenListZUnitTest.php

@@ -15,7 +15,7 @@
 /**
  * Unit test class for the TokenList sniff.
  *
- * @covers PHPCSStandards\Debug\Sniffs\Debug::TokenListSniff
+ * @covers PHPCSStandards\Debug\Sniffs\Debug\TokenListSniff
  *
  * @since 1.0.0
  */
@@ -33,7 +33,12 @@ public function testOutput()
 
         $this->assertNotEmpty($output);
 
-        $expected = '0 :: L001 :: C1 :: T_OPEN_TAG :: (5) :: <?php';
+        $expected  = 'Ptr :: Ln :: Col  :: Cond :: Token Type                 :: [len]: Content';
+        $expected .= PHP_EOL;
+        $expected .= '-------------------------------------------------------------------------';
+        $expected .= PHP_EOL;
+        $expected .= '  0 :: L1 :: C  1 :: CC 0 :: T_OPEN_TAG                 :: [5]: <?php';
+
         $this->assertSame($expected, $output);
     }
 }

README.md

@@ -132,35 +132,37 @@ phpcs ./SniffNameUnitTest.inc --standard=Debug
 ```bash
 phpcs ./SniffNameUnitTest.inc --standard=YourStandard,Debug --sniffs=YourStandard.Category.NewSniffName,Debug.Debug.TokenList
 ```
-	
+
 The output will look something along the lines of:
 ```
-0 :: L001 :: C1 :: T_OPEN_TAG :: (5) :: <?php
-
-1 :: L002 :: C1 :: T_WHITESPACE :: (0) ::
-
-2 :: L003 :: C1 :: T_COMMENT :: (32) :: // Boolean not operator: All OK.
-
-3 :: L004 :: C1 :: T_IF :: (2) :: if
-4 :: L004 :: C3 :: T_WHITESPACE :: (1) ::
-5 :: L004 :: C4 :: T_OPEN_PARENTHESIS :: (1) :: (
-6 :: L004 :: C5 :: T_WHITESPACE :: (1) ::
-7 :: L004 :: C6 :: T_CONSTANT_ENCAPSED_STRING :: (4) :: 'bb'
-8 :: L004 :: C10 :: T_WHITESPACE :: (1) ::
-9 :: L004 :: C11 :: T_IS_NOT_IDENTICAL :: (3) :: !==
-10 :: L004 :: C14 :: T_WHITESPACE :: (1) ::
-11 :: L004 :: C15 :: T_CONSTANT_ENCAPSED_STRING :: (4) :: 'bb'
-12 :: L004 :: C19 :: T_WHITESPACE :: (1) ::
-13 :: L004 :: C20 :: T_CLOSE_PARENTHESIS :: (1) :: )
-14 :: L004 :: C21 :: T_WHITESPACE :: (1) ::
-15 :: L004 :: C22 :: T_OPEN_CURLY_BRACKET :: (1) :: {
-16 :: L004 :: C23 :: T_WHITESPACE :: (0) ::
-
-17 :: L005 :: C1 :: T_WHITESPACE :: (1) :: \t
-18 :: L005 :: C2 :: T_IF :: (2) :: if
-19 :: L005 :: C4 :: T_WHITESPACE :: (1) ::
-20 :: L005 :: C5 :: T_OPEN_PARENTHESIS :: (1) :: (
-21 :: L005 :: C6 :: T_WHITESPACE :: (0) ::
+Ptr :: Ln :: Col  :: Cond :: Token Type                 :: [len]: Content
+-------------------------------------------------------------------------
+  0 :: L1 :: C  1 :: CC 0 :: T_OPEN_TAG                 :: [5]: <?php
+
+  1 :: L2 :: C  1 :: CC 0 :: T_WHITESPACE               :: [0]:
+
+  2 :: L3 :: C  1 :: CC 0 :: T_COMMENT                  :: [32]: // Boolean not operator: All OK.
+
+  3 :: L4 :: C  1 :: CC 0 :: T_IF                       :: [2]: if
+  4 :: L4 :: C  3 :: CC 0 :: T_WHITESPACE               :: [1]:
+  5 :: L4 :: C  4 :: CC 0 :: T_OPEN_PARENTHESIS         :: [1]: (
+  6 :: L4 :: C  5 :: CC 0 :: T_WHITESPACE               :: [1]:
+  7 :: L4 :: C  6 :: CC 0 :: T_CONSTANT_ENCAPSED_STRING :: [4]: 'bb'
+  8 :: L4 :: C 10 :: CC 0 :: T_WHITESPACE               :: [1]:
+  9 :: L4 :: C 11 :: CC 0 :: T_IS_NOT_IDENTICAL         :: [3]: !==
+ 10 :: L4 :: C 14 :: CC 0 :: T_WHITESPACE               :: [1]:
+ 11 :: L4 :: C 15 :: CC 0 :: T_CONSTANT_ENCAPSED_STRING :: [4]: 'bb'
+ 12 :: L4 :: C 19 :: CC 0 :: T_WHITESPACE               :: [1]:
+ 13 :: L4 :: C 20 :: CC 0 :: T_CLOSE_PARENTHESIS        :: [1]: )
+ 14 :: L4 :: C 21 :: CC 0 :: T_WHITESPACE               :: [1]:
+ 15 :: L4 :: C 22 :: CC 0 :: T_OPEN_CURLY_BRACKET       :: [1]: {
+ 16 :: L4 :: C 23 :: CC 0 :: T_WHITESPACE               :: [0]:
+
+ 17 :: L5 :: C  1 :: CC 0 :: T_WHITESPACE               :: [1]: \t
+ 18 :: L5 :: C  2 :: CC 0 :: T_IF                       :: [2]: if
+ 19 :: L5 :: C  4 :: CC 0 :: T_WHITESPACE               :: [1]:
+ 20 :: L5 :: C  5 :: CC 0 :: T_OPEN_PARENTHESIS         :: [1]: (
+ 21 :: L5 :: C  6 :: CC 0 :: T_WHITESPACE               :: [0]:
 ```
 
 PHPCS itself can also display similar information using the `-vv` or `-vvv` verbosity flags, however, when using those, you will receive a *lot* more information than just the token list and, while useful for debugging PHPCS itself, the additional information is mostly just noise when developing a sniff.