Chris@0: <?php
Chris@0: /**
Chris@17:  * \Drupal\Sniffs\Files\TxtFileLineLengthSniff.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@0: 
Chris@17: namespace Drupal\Sniffs\Files;
Chris@17: 
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17: 
Chris@0: /**
Chris@17:  * \Drupal\Sniffs\Files\TxtFileLineLengthSniff.
Chris@0:  *
Chris@0:  * Checks all lines in a *.txt or *.md file and throws warnings if they are over 80
Chris@0:  * characters in length.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@17: class TxtFileLineLengthSniff implements Sniff
Chris@0: {
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns an array of tokens this test wants to listen for.
Chris@0:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public function register()
Chris@0:     {
Chris@0:         return array(T_INLINE_HTML);
Chris@0: 
Chris@0:     }//end register()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Processes this test, when one of its tokens is encountered.
Chris@0:      *
Chris@17:      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
Chris@17:      * @param int                         $stackPtr  The position of the current token in the
Chris@17:      *                                               stack passed in $tokens.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@17:     public function process(File $phpcsFile, $stackPtr)
Chris@0:     {
Chris@0:         $fileExtension = strtolower(substr($phpcsFile->getFilename(), -3));
Chris@0:         if ($fileExtension === 'txt' || $fileExtension === '.md') {
Chris@0:             $tokens = $phpcsFile->getTokens();
Chris@0: 
Chris@0:             $content    = rtrim($tokens[$stackPtr]['content']);
Chris@0:             $lineLength = mb_strlen($content, 'UTF-8');
Chris@0:             // Lines without spaces are allowed to be longer (for example long URLs).
Chris@17:             // Markdown allowed to be longer for lines
Chris@17:             // - without spaces
Chris@17:             // - starting with #
Chris@17:             // - containing URLs (https://)
Chris@17:             // - starting with | (tables).
Chris@17:             if ($lineLength > 80 && preg_match('/^([^ ]+$|#|.*https?:\/\/|\|)/', $content) === 0) {
Chris@0:                 $data    = array(
Chris@0:                             80,
Chris@0:                             $lineLength,
Chris@0:                            );
Chris@0:                 $warning = 'Line exceeds %s characters; contains %s characters';
Chris@0:                 $phpcsFile->addWarning($warning, $stackPtr, 'TooLong', $data);
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class