matthiasnoback / code-sniffer-sniff-dsl
DSL for writing sniffs for PHP_CodeSniffer
Installs: 3 035
Dependents: 1
Suggesters: 0
Security: 0
Stars: 10
Watchers: 7
Forks: 1
Open Issues: 0
Requires
- beberlei/assert: 2.*
- squizlabs/php_codesniffer: ~1.5
Requires (Dev)
- phpunit/phpunit: ~3.7
This package is auto-updated.
Last update: 2024-10-29 04:19:56 UTC
README
Using this library you can easily write code sniffs for PHP_CodeSniffer. When you don't use this DSL you will find yourself writing lots of specific, never reusable code.
Example
Say you want to create a code sniff that triggers an error if a PHP file contains an (auto-generated) doc comment at the top (this is called a "file comment"). You should first create a "matcher" for this specific situation:
<?php namespace Matthias\PhpCodingStandard\Sniffs\Commenting; use Matthias\Codesniffer\MatcherInterface; use Matthias\Codesniffer\Sequence\SequenceBuilder; class FileCommentMatcher implements MatcherInterface { public function matches(array $tokens, $tokenIndex) { $forwardSequence = SequenceBuilder::create() ->lookingForward() ->expect() ->token(T_WHITESPACE, ' ') // space ->token(T_STRING) // namespace root ->quantity() // sub namespaces ->any() ->succeeding() ->token(T_NS_SEPARATOR) ->token(T_STRING) ->end() ->end() ->token(T_SEMICOLON) // end of namespace declaration ->quantity() // two blank lines ->exactly(2) ->token(T_WHITESPACE, "\n") ->end() ->end() ->build(); $backwardSequence = SequenceBuilder::create() ->lookingBackward() ->expect() ->quantity() // the first new line is part of the PHP open tag ->exactly(1) ->token(T_WHITESPACE, "\n") ->end() ->end() ->build(); $oneBlankLineAfterNamespace = $forwardSequence->matches($tokens, $tokenIndex); $oneBlankLineBeforeNamespace = $backwardSequence->matches($tokens, $tokenIndex); return $oneBlankLineBeforeNamespace && $oneBlankLineAfterNamespace; } }
Next the actual sniff class is pretty simple:
<?php use Matthias\PhpCodingStandard\Sniffs\Commenting\FileCommentMatcher; class PhpCodingStandard_Sniffs_Commenting_NoFileCommentForClassSniff implements \PHP_CodeSniffer_Sniff { public function register() { // this sniff will be triggered when the code sniffer encounters a T_DOC_COMMENT token return array( T_DOC_COMMENT ); } public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // create the matcher $matcher = new FileCommentMatcher(); // use the matcher to determine if the current token is a file comment if ($matcher->matches($tokens, $stackPtr)) { $phpcsFile->addError('File should not have a file comment', $stackPtr); } } }