Introducing coding standards validation.

This commit is contained in:
Marcos Schratzenstaller
2019-04-22 17:28:46 -03:00
committed by Nathan Rice
parent 6e40c921ab
commit fd504d41ac
1624 changed files with 190339 additions and 262 deletions
@@ -0,0 +1,105 @@
<?php
/**
* \PHPCompatibility\Sniffs\UseDeclarations\NewGroupUseDeclarationsSniff.
*
* PHP version 7.0
*
* @category PHP
* @package PHPCompatibility
* @author Wim Godden <wim.godden@cu.be>
*/
namespace PHPCompatibility\Sniffs\UseDeclarations;
use PHPCompatibility\Sniff;
use PHP_CodeSniffer_File as File;
use PHP_CodeSniffer_Tokens as Tokens;
/**
* \PHPCompatibility\Sniffs\UseDeclarations\NewGroupUseDeclarationsSniff.
*
* PHP version 7.0
*
* @category PHP
* @package PHPCompatibility
* @author Wim Godden <wim.godden@cu.be>
*/
class NewGroupUseDeclarationsSniff extends Sniff
{
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array
*/
public function register()
{
if (defined('T_OPEN_USE_GROUP')) {
return array(T_OPEN_USE_GROUP);
} else {
return array(T_USE);
}
}
/**
* Processes this test, when one of its tokens is encountered.
*
* @param \PHP_CodeSniffer_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)
{
if ($this->supportsBelow('7.1') === false) {
return;
}
$tokens = $phpcsFile->getTokens();
$token = $tokens[$stackPtr];
// Deal with PHPCS pre-2.6.0.
if ($token['code'] === T_USE) {
$hasCurlyBrace = $phpcsFile->findNext(T_OPEN_CURLY_BRACKET, ($stackPtr + 1), null, false, null, true);
if ($hasCurlyBrace === false) {
return;
}
$prevToken = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($hasCurlyBrace - 1), null, true);
if ($prevToken === false || $tokens[$prevToken]['code'] !== T_NS_SEPARATOR) {
return;
}
$stackPtr = $hasCurlyBrace;
}
// Still here ? In that case, it is a group use statement.
if ($this->supportsBelow('5.6') === true) {
$phpcsFile->addError(
'Group use declarations are not allowed in PHP 5.6 or earlier',
$stackPtr,
'Found'
);
}
$closers = array(T_CLOSE_CURLY_BRACKET);
if (defined('T_CLOSE_USE_GROUP')) {
$closers[] = T_CLOSE_USE_GROUP;
}
$closeCurly = $phpcsFile->findNext($closers, ($stackPtr + 1), null, false, null, true);
if ($closeCurly === false) {
return;
}
$prevToken = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($closeCurly - 1), null, true);
if ($tokens[$prevToken]['code'] === T_COMMA) {
$phpcsFile->addError(
'Trailing comma\'s are not allowed in group use statements in PHP 7.1 or earlier',
$prevToken,
'TrailingCommaFound'
);
}
}
}
@@ -0,0 +1,102 @@
<?php
/**
* \PHPCompatibility\Sniffs\UseDeclarations\NewUseConstFunctionSniff.
*
* PHP version 5.6
*
* @category PHP
* @package PHPCompatibility
* @author Juliette Reinders Folmer <phpcompatibility_nospam@adviesenzo.nl>
*/
namespace PHPCompatibility\Sniffs\UseDeclarations;
use PHPCompatibility\Sniff;
use PHP_CodeSniffer_File as File;
use PHP_CodeSniffer_Tokens as Tokens;
/**
* \PHPCompatibility\Sniffs\UseDeclarations\NewUseConstFunctionSniff.
*
* The use operator has been extended to support importing functions and
* constants in addition to classes. This is achieved via the use function
* and use const constructs, respectively.
*
* PHP version 5.6
*
* @category PHP
* @package PHPCompatibility
* @author Juliette Reinders Folmer <phpcompatibility_nospam@adviesenzo.nl>
*/
class NewUseConstFunctionSniff extends Sniff
{
/**
* A list of keywords that can follow use statements.
*
* @var array(string => string)
*/
protected $validUseNames = array(
'const' => true,
'function' => true,
);
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array
*/
public function register()
{
return array(T_USE);
}
/**
* Processes this test, when one of its tokens is encountered.
*
* @param \PHP_CodeSniffer_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)
{
if ($this->supportsBelow('5.5') !== true) {
return;
}
$tokens = $phpcsFile->getTokens();
$nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true);
if ($nextNonEmpty === false) {
// Live coding.
return;
}
if (isset($this->validUseNames[strtolower($tokens[$nextNonEmpty]['content'])]) === false) {
// Not a `use const` or `use function` statement.
return;
}
// `use const` and `use function` have to be followed by the function/constant name.
$functionOrConstName = $phpcsFile->findNext(Tokens::$emptyTokens, ($nextNonEmpty + 1), null, true);
if ($functionOrConstName === false
// Identifies as T_AS or T_STRING, this covers both.
|| ($tokens[$functionOrConstName]['content'] === 'as'
|| $tokens[$functionOrConstName]['code'] === T_COMMA)
) {
// Live coding or incorrect use of reserved keyword, but that is
// covered by the ForbiddenNames sniff.
return;
}
// Still here ? In that case we have encountered a `use const` or `use function` statement.
$phpcsFile->addError(
'Importing functions and constants through a "use" statement is not supported in PHP 5.5 or lower.',
$nextNonEmpty,
'Found'
);
}
}