-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add else and elseif statement as forbidden (#95)
* Add else and elseif statement as forbidden
- Loading branch information
1 parent
291077d
commit 2b9fdfa
Showing
6 changed files
with
103 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
46 changes: 46 additions & 0 deletions
46
src/BrandEmbassyCodingStandard/Sniffs/ForbiddenElseStatementSniff.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
<?php declare(strict_types = 1); | ||
|
||
namespace BrandEmbassyCodingStandard\Sniffs; | ||
|
||
use PHP_CodeSniffer\Files\File; | ||
use PHP_CodeSniffer\Sniffs\Sniff; | ||
use function strtolower; | ||
use const T_ELSE; | ||
use const T_ELSEIF; | ||
|
||
/** | ||
* @final | ||
*/ | ||
class ForbiddenElseStatementSniff implements Sniff | ||
{ | ||
public const CODE_FORBIDDEN_ELSE_STATEMENT_SNIFF = 'ForbiddenElseStatement'; | ||
|
||
|
||
/** | ||
* @return int[]|string[] | ||
*/ | ||
public function register(): array | ||
{ | ||
return [ | ||
T_ELSE, | ||
T_ELSEIF, | ||
]; | ||
} | ||
|
||
|
||
/** | ||
* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint | ||
* | ||
* @param int $stackPtr | ||
*/ | ||
public function process(File $phpcsFile, $stackPtr): void | ||
{ | ||
$tokens = $phpcsFile->getTokens(); | ||
|
||
$statement = strtolower($tokens[$stackPtr]['content']); | ||
|
||
$error = 'Use of ' . $statement . ' is forbidden. See: https://github.com/BrandEmbassy/developers-manifest/issues/365.'; | ||
|
||
$phpcsFile->addError($error, $stackPtr, self::CODE_FORBIDDEN_ELSE_STATEMENT_SNIFF); | ||
} | ||
} |
33 changes: 33 additions & 0 deletions
33
src/BrandEmbassyCodingStandard/Sniffs/ForbiddenElseStatementSniffTest.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
<?php declare(strict_types = 1); | ||
|
||
namespace BrandEmbassyCodingStandard\Sniffs; | ||
|
||
use SlevomatCodingStandard\Sniffs\TestCase; | ||
|
||
/** | ||
* @final | ||
*/ | ||
class ForbiddenElseStatementSniffTest extends TestCase | ||
{ | ||
public function testErrorIsAdded(): void | ||
{ | ||
$file = __DIR__ . '/__fixtures/codeWithElseStatement.php'; | ||
require_once $file; | ||
|
||
$report = self::checkFile($file); | ||
|
||
self::assertSniffError( | ||
$report, | ||
13, | ||
'ForbiddenElseStatement', | ||
'Use of elseif is forbidden.', | ||
); | ||
|
||
self::assertSniffError( | ||
$report, | ||
15, | ||
'ForbiddenElseStatement', | ||
'Use of else is forbidden.', | ||
); | ||
} | ||
} |
19 changes: 19 additions & 0 deletions
19
src/BrandEmbassyCodingStandard/Sniffs/__fixtures/codeWithElseStatement.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<?php declare(strict_types = 1); | ||
|
||
namespace BrandEmbassyCodingStandard\Sniffs\__fixtures; | ||
|
||
use Mockery\MockInterface; | ||
|
||
class CreateMockFunctions | ||
{ | ||
private function withNoPhpDoc(): void | ||
{ | ||
if (true) { | ||
echo 'bar'; | ||
} elseif (true) { | ||
echo 'lol'; | ||
} else { | ||
echo 'foo'; | ||
} | ||
} | ||
} |