jrfnl
commented
1 day ago @tomasnorre Thanks for opening the issue.
I've already been looking into this and can confirm the issue.
To reproduce and investigate this, I've used a minimal setup with control:
Directory layout:
- project root
- src
- Sniffs
- SniffsDirSniff.php
- SniffsDirWithExcludeSniff.php
- StrictTypes (directory)
- CategorySniff.php
- CategoryWithExcludeSniff.phpThe content of the sniff files is the same with only minimal variation:
namespace Exercism\Sniffs;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
class SniffsDirSniff implements Sniff
{
public function register()
{
return [T_OPEN_TAG];
}
public function process(File $phpcsFile, $stackPtr)
{
$phpcsFile->addError('Running', $stackPtr, 'Control');
}
}The only differences between the four sniffs are:
- The namespace for the Category sniffs is updated to
Exercism\Sniffs\StrictTypes. - The error code for the
*WithExcludesniffs is updated fromControltoThisErrorShouldHaveBeenExcluded.
Ruleset:
<?xml version="1.0"?>
<ruleset
name="Exercism PHP Coding Standard"
>
<file>src</file>
<rule ref="src/Sniffs/SniffsDirSniff.php"/>
<!-- This works. -->
<rule ref="src/Sniffs/SniffsDirWithExcludeSniff.php">
<exclude-pattern>src/*</exclude-pattern>
</rule>
<rule ref="src/Sniffs/StrictTypes/CategorySniff.php"/>
<!-- This doesn't work, but should. -->
<rule ref="src/Sniffs/StrictTypes/CategoryWithExcludeSniff.php">
<exclude-pattern>src/*</exclude-pattern>
</rule>
</ruleset>Command run from the project root:
phpcs -ps --basepath=.Result
FILE: src\Sniffs\SniffsDirSniff.php
------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 1 LINE
------------------------------------------------------------------------------------------------
1 | ERROR | Running (.Sniffs.SniffsDir.Control)
1 | ERROR | Running (Exercism.StrictTypes.Category.Control)
1 | ERROR | Running (Exercism.StrictTypes.CategoryWithExclude.ThisErrorShouldHaveBeenExcluded)
------------------------------------------------------------------------------------------------
FILE: src\Sniffs\SniffsDirWithExcludeSniff.php
------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 1 LINE
------------------------------------------------------------------------------------------------
1 | ERROR | Running (.Sniffs.SniffsDir.Control)
1 | ERROR | Running (Exercism.StrictTypes.Category.Control)
1 | ERROR | Running (Exercism.StrictTypes.CategoryWithExclude.ThisErrorShouldHaveBeenExcluded)
------------------------------------------------------------------------------------------------
FILE: src\Sniffs\StrictTypes\CategorySniff.php
------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 1 LINE
------------------------------------------------------------------------------------------------
1 | ERROR | Running (.Sniffs.SniffsDir.Control)
1 | ERROR | Running (Exercism.StrictTypes.Category.Control)
1 | ERROR | Running (Exercism.StrictTypes.CategoryWithExclude.ThisErrorShouldHaveBeenExcluded)
------------------------------------------------------------------------------------------------
FILE: src\Sniffs\StrictTypes\CategoryWithExcludeSniff.php
------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 1 LINE
------------------------------------------------------------------------------------------------
1 | ERROR | Running (.Sniffs.SniffsDir.Control)
1 | ERROR | Running (Exercism.StrictTypes.Category.Control)
1 | ERROR | Running (Exercism.StrictTypes.CategoryWithExclude.ThisErrorShouldHaveBeenExcluded)
------------------------------------------------------------------------------------------------As the original discussion mentioned that it "used to work", I've done some git bisecting to validate this and see where things changed, starting at PHPCS 3.1.0.
My findings based on that are, however, different: This never worked (between PHPCS 3.1.0 and now) and it used to be worse.
- Prior to PHPCS 3.5.0, only two out of the four files were being scanned. This was reported in issue squizlabs/PHP_CodeSniffer#2391 and fixed via PR squizlabs/PHP_CodeSniffer#2392.
- Prior to PHPCS 3.5.4, the exclude also didn't work for the sniffs in the
SniffsDir. This was reported in issue squizlabs/PHP_CodeSniffer#2497 and fixed via PR squizlabs/PHP_CodeSniffer#2501.
This will need further investigation and a fix, which probably needs to build on the prior fix from squizlabs/PHP_CodeSniffer#2501.
tomasnorre
Created based on discussion: https://github.com/PHPCSStandards/PHP_CodeSniffer/discussions/680
Describe the bug
After adjusting (1) the Sniff according to https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Coding-Standard-Tutorial#creating-the-sniff my
exclude-patternisn't respected anymore.Code sample
ExplainStrictTypesSniff.php
Custom ruleset
When I run
vendor/bin/phpcs -sI don't get an error code, and the two errors are from theexclude-patternfiles from above.1) https://github.com/exercism/php/pull/857
To reproduce
Steps to reproduce the behavior:
KindergartenGarden.phpin a folder called.metawith the code sample aboveExplainStrictTypesSniff.phpin foldersrc/Sniffs/StrictTypes/from the code abovephpcs.xmlin base-folder with content from abovevendor/bin/phpcs -s .meta/KindergartenGarden.phpExpected behavior
I would expect the error not to be reported as the
.metadirectory is in theexclude-pattern.Versions (please complete the following information)
Please confirm
masterbranch of PHP_CodeSniffer.