-
Notifications
You must be signed in to change notification settings - Fork 160
AC-664: Create phpcs static check for CodingStandardsIgnoreAnnotationUsageTest #257
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
dc69a01
AC-664: Create phpcs static check for CodingStandardsIgnoreAnnotation…
loginesta 1a3f16f
AC-664: Create phpcs static check for CodingStandardsIgnoreAnnotation…
loginesta 52bfc45
Merge branch 'develop' of github.com:magento/magento-coding-standard …
loginesta 98b8cd8
AC-664: Create phpcs static check for CodingStandardsIgnoreAnnotation…
loginesta 8207a11
AC-664: Create phpcs static check for CodingStandardsIgnoreAnnotation…
loginesta 0449dbd
AC-664: Create phpcs static check for CodingStandardsIgnoreAnnotation…
loginesta File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
47 changes: 47 additions & 0 deletions
47
Magento2/Sniffs/Legacy/CodingStandardsIgnoreAnnotationUsageSniff.php
This file contains hidden or 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,47 @@ | ||
<?php | ||
/** | ||
* Copyright © Magento, Inc. All rights reserved. | ||
* See COPYING.txt for license details. | ||
*/ | ||
|
||
namespace Magento2\Sniffs\Legacy; | ||
|
||
use PHP_CodeSniffer\Files\File; | ||
use PHP_CodeSniffer\Sniffs\Sniff; | ||
|
||
class CodingStandardsIgnoreAnnotationUsageSniff implements Sniff | ||
{ | ||
private const CODING_STANDARDS_IGNORE_FILE = '@codingStandardsIgnoreFile'; | ||
|
||
private const WARNING_CODE = 'avoidAnnotation'; | ||
|
||
private const WARNING_MESSAGE = '@codingStandardsIgnoreFile annotation must be avoided. ' | ||
. 'Use codingStandardsIgnoreStart/codingStandardsIgnoreEnd to suppress code fragment ' | ||
. 'or use codingStandardsIgnoreLine to suppress line. '; | ||
|
||
/** | ||
* @inheritDoc | ||
*/ | ||
public function register(): array | ||
{ | ||
return [ | ||
T_COMMENT | ||
]; | ||
} | ||
|
||
/** | ||
* @inheritDoc | ||
*/ | ||
public function process(File $phpcsFile, $stackPtr) | ||
{ | ||
$tokens = $phpcsFile->getTokens(); | ||
|
||
if (strpos($tokens[$stackPtr - 1]['content'], self::CODING_STANDARDS_IGNORE_FILE) !== false) { | ||
$phpcsFile->addWarning( | ||
self::WARNING_MESSAGE . $phpcsFile->getFilename(), | ||
$stackPtr, | ||
self::WARNING_CODE | ||
); | ||
} | ||
} | ||
} |
37 changes: 37 additions & 0 deletions
37
Magento2/Tests/Legacy/CodingStandardsIgnoreAnnotationUsageUnitTest.inc
This file contains hidden or 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,37 @@ | ||
<?php | ||
/** | ||
* Copyright © Magento, Inc. All rights reserved. | ||
* See COPYING.txt for license details. | ||
*/ | ||
|
||
// @codingStandardsIgnoreFile | ||
class Sample | ||
{ | ||
/** | ||
* @var int | ||
*/ | ||
private $randomNumber; | ||
|
||
/** | ||
* @throws Exception | ||
*/ | ||
public function __construct() { | ||
$this->randomNumber = random_int(0, 999); | ||
} | ||
|
||
/** | ||
* @return int | ||
*/ | ||
public function getRandomNumber(): int | ||
{ | ||
return $this->randomNumber; | ||
} | ||
|
||
/** | ||
* @param int $randomNumber | ||
*/ | ||
public function setRandomNumber(int $randomNumber): void | ||
{ | ||
$this->randomNumber = $randomNumber; | ||
} | ||
} |
26 changes: 26 additions & 0 deletions
26
Magento2/Tests/Legacy/CodingStandardsIgnoreAnnotationUsageUnitTest.php
This file contains hidden or 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,26 @@ | ||
<?php | ||
|
||
namespace Magento2\Tests\Legacy; | ||
|
||
use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest; | ||
|
||
class CodingStandardsIgnoreAnnotationUsageUnitTest extends AbstractSniffUnitTest | ||
{ | ||
/** | ||
* @inheritdoc | ||
*/ | ||
public function getErrorList() | ||
{ | ||
return []; | ||
} | ||
|
||
/** | ||
* @inheritdoc | ||
*/ | ||
public function getWarningList() | ||
{ | ||
return [ | ||
7 => 1 | ||
]; | ||
} | ||
} |
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There must be an error at line 7, that's where
@codingStandardsIgnoreFile
is setThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know, i set it up empty because was expecting complains on command line when running
vendor/bin/phpunit
.Actually, it must be a warning.