Skip to content

Commit 44a09f0

Browse files
gsherwoodgsherwood
committed
Renamed sniffs and tweaked error messages (ref #3055)
1 parent 998f1da commit 44a09f0

13 files changed

+29
-29
lines changed

‎package.xml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -320,11 +320,11 @@ http://pear.php.net/dtd/package-2.0.xsd">
320320
<file baseinstalldir="PHP/CodeSniffer" name="NestingLevelStandard.xml" role="php" />
321321
</dir>
322322
<dir name="NamingConventions">
323-
<file baseinstalldir="PHP/CodeSniffer" name="AbstractPrefixRequiredForAbstractClassStandard.xml" role="php" />
323+
<file baseinstalldir="PHP/CodeSniffer" name="AbstractClassNamePrefixStandard.xml" role="php" />
324324
<file baseinstalldir="PHP/CodeSniffer" name="CamelCapsFunctionNameStandard.xml" role="php" />
325325
<file baseinstalldir="PHP/CodeSniffer" name="ConstructorNameStandard.xml" role="php" />
326-
<file baseinstalldir="PHP/CodeSniffer" name="InterfaceSuffixRequiredForInterfaceStandard.xml" role="php" />
327-
<file baseinstalldir="PHP/CodeSniffer" name="TraitSuffixRequiredForTraitStandard.xml" role="php" />
326+
<file baseinstalldir="PHP/CodeSniffer" name="InterfaceNameSuffixStandard.xml" role="php" />
327+
<file baseinstalldir="PHP/CodeSniffer" name="TraitNameSuffixStandard.xml" role="php" />
328328
<file baseinstalldir="PHP/CodeSniffer" name="UpperCaseConstantNameStandard.xml" role="php" />
329329
</dir>
330330
<dir name="PHP">
@@ -428,11 +428,11 @@ http://pear.php.net/dtd/package-2.0.xsd">
428428
<file baseinstalldir="PHP/CodeSniffer" name="NestingLevelSniff.php" role="php" />
429429
</dir>
430430
<dir name="NamingConventions">
431-
<file baseinstalldir="PHP/CodeSniffer" name="AbstractPrefixRequiredForAbstractClassSniff.php" role="php" />
431+
<file baseinstalldir="PHP/CodeSniffer" name="AbstractClassNamePrefixSniff.php" role="php" />
432432
<file baseinstalldir="PHP/CodeSniffer" name="CamelCapsFunctionNameSniff.php" role="php" />
433433
<file baseinstalldir="PHP/CodeSniffer" name="ConstructorNameSniff.php" role="php" />
434-
<file baseinstalldir="PHP/CodeSniffer" name="InterfaceSuffixRequiredForInterfaceSniff.php" role="php" />
435-
<file baseinstalldir="PHP/CodeSniffer" name="TraitSuffixRequiredForTraitSniff.php" role="php" />
434+
<file baseinstalldir="PHP/CodeSniffer" name="InterfaceNameSuffixSniff.php" role="php" />
435+
<file baseinstalldir="PHP/CodeSniffer" name="TraitNameSuffixSniff.php" role="php" />
436436
<file baseinstalldir="PHP/CodeSniffer" name="UpperCaseConstantNameSniff.php" role="php" />
437437
</dir>
438438
<dir name="PHP">
@@ -676,16 +676,16 @@ http://pear.php.net/dtd/package-2.0.xsd">
676676
<file baseinstalldir="PHP/CodeSniffer" name="NestingLevelUnitTest.php" role="test" />
677677
</dir>
678678
<dir name="NamingConventions">
679-
<file baseinstalldir="PHP/CodeSniffer" name="AbstractPrefixRequiredForAbstractClassUnitTest.inc" role="test" />
680-
<file baseinstalldir="PHP/CodeSniffer" name="AbstractPrefixRequiredForAbstractClassUnitTest.php" role="test" />
679+
<file baseinstalldir="PHP/CodeSniffer" name="AbstractClassNamePrefixUnitTest.inc" role="test" />
680+
<file baseinstalldir="PHP/CodeSniffer" name="AbstractClassNamePrefixUnitTest.php" role="test" />
681681
<file baseinstalldir="PHP/CodeSniffer" name="CamelCapsFunctionNameUnitTest.inc" role="test" />
682682
<file baseinstalldir="PHP/CodeSniffer" name="CamelCapsFunctionNameUnitTest.php" role="test" />
683683
<file baseinstalldir="PHP/CodeSniffer" name="ConstructorNameUnitTest.inc" role="test" />
684684
<file baseinstalldir="PHP/CodeSniffer" name="ConstructorNameUnitTest.php" role="test" />
685-
<file baseinstalldir="PHP/CodeSniffer" name="InterfaceSuffixRequiredForInterfaceUnitTest.inc" role="test" />
686-
<file baseinstalldir="PHP/CodeSniffer" name="InterfaceSuffixRequiredForInterfaceUnitTest.php" role="test" />
687-
<file baseinstalldir="PHP/CodeSniffer" name="TraitSuffixRequiredForTraitUnitTest.inc" role="test" />
688-
<file baseinstalldir="PHP/CodeSniffer" name="TraitSuffixRequiredForTraitUnitTest.php" role="test" />
685+
<file baseinstalldir="PHP/CodeSniffer" name="InterfaceNameSuffixUnitTest.inc" role="test" />
686+
<file baseinstalldir="PHP/CodeSniffer" name="InterfaceNameSuffixUnitTest.php" role="test" />
687+
<file baseinstalldir="PHP/CodeSniffer" name="TraitNameSuffixUnitTest.inc" role="test" />
688+
<file baseinstalldir="PHP/CodeSniffer" name="TraitNameSuffixUnitTest.php" role="test" />
689689
<file baseinstalldir="PHP/CodeSniffer" name="UpperCaseConstantNameUnitTest.inc" role="test" />
690690
<file baseinstalldir="PHP/CodeSniffer" name="UpperCaseConstantNameUnitTest.php" role="test" />
691691
</dir>

‎src/Standards/Generic/Docs/NamingConventions/AbstractPrefixRequiredForAbstractClassStandard.xml renamed to ‎src/Standards/Generic/Docs/NamingConventions/AbstractClassNamePrefixStandard.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<documentation title="Abstract class name">
22
<standard>
33
<![CDATA[
4-
Abstract classes MUST be prefixed by Abstract: e.g. AbstractBar.
4+
Abstract class names must be prefixed with "Abstract", e.g. AbstractBar.
55
]]>
66
</standard>
77
<code_comparison>

‎src/Standards/Generic/Docs/NamingConventions/InterfaceSuffixRequiredForInterfaceStandard.xml renamed to ‎src/Standards/Generic/Docs/NamingConventions/InterfaceNameSuffixStandard.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
<documentation title="Interface name">
1+
<documentation title="Interface name suffix">
22
<standard>
33
<![CDATA[
4-
Interfaces MUST be suffixed by Interface: e.g. BarInterface.
4+
Interface names must be suffixed with "Interface", e.g. BarInterface.
55
]]>
66
</standard>
77
<code_comparison>

‎src/Standards/Generic/Docs/NamingConventions/TraitSuffixRequiredForTraitStandard.xml renamed to ‎src/Standards/Generic/Docs/NamingConventions/TraitNameSuffixStandard.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
<documentation title="Trait name">
1+
<documentation title="Trait name suffix">
22
<standard>
33
<![CDATA[
4-
Traits MUST be suffixed by Trait: e.g. BarTrait.
4+
Trait names must be suffixed with "Trait", e.g. BarTrait.
55
]]>
66
</standard>
77
<code_comparison>

‎src/Standards/Generic/Sniffs/NamingConventions/AbstractPrefixRequiredForAbstractClassSniff.php renamed to ‎src/Standards/Generic/Sniffs/NamingConventions/AbstractClassNamePrefixSniff.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
use PHP_CodeSniffer\Files\File;
1212
use PHP_CodeSniffer\Sniffs\Sniff;
1313

14-
class AbstractPrefixRequiredForAbstractClassSniff implements Sniff
14+
class AbstractClassNamePrefixSniff implements Sniff
1515
{
1616

1717

@@ -51,7 +51,7 @@ public function process(File $phpcsFile, $stackPtr)
5151

5252
$prefix = substr($className, 0, 8);
5353
if (strtolower($prefix) !== 'abstract') {
54-
$phpcsFile->addError('Abstract classes MUST be prefixed by Abstract: e.g. AbstractBar. Found: %s', $stackPtr, 'Missing', [$className]);
54+
$phpcsFile->addError('Abstract class names must be prefixed with "Abstract"; found "%s"', $stackPtr, 'Missing', [$className]);
5555
}
5656

5757
}//end process()

‎src/Standards/Generic/Sniffs/NamingConventions/InterfaceSuffixRequiredForInterfaceSniff.php renamed to ‎src/Standards/Generic/Sniffs/NamingConventions/InterfaceNameSuffixSniff.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
use PHP_CodeSniffer\Files\File;
1212
use PHP_CodeSniffer\Sniffs\Sniff;
1313

14-
class InterfaceSuffixRequiredForInterfaceSniff implements Sniff
14+
class InterfaceNameSuffixSniff implements Sniff
1515
{
1616

1717

@@ -45,7 +45,7 @@ public function process(File $phpcsFile, $stackPtr)
4545

4646
$suffix = substr($interfaceName, -9);
4747
if (strtolower($suffix) !== 'interface') {
48-
$phpcsFile->addError('Interfaces MUST be suffixed by Interface: e.g. BarInterface. Found: %s', $stackPtr, 'Missing', [$interfaceName]);
48+
$phpcsFile->addError('Interface names must be suffixed with "Interface"; found "%s"', $stackPtr, 'Missing', [$interfaceName]);
4949
}
5050

5151
}//end process()

‎src/Standards/Generic/Sniffs/NamingConventions/TraitSuffixRequiredForTraitSniff.php renamed to ‎src/Standards/Generic/Sniffs/NamingConventions/TraitNameSuffixSniff.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
use PHP_CodeSniffer\Files\File;
1212
use PHP_CodeSniffer\Sniffs\Sniff;
1313

14-
class TraitSuffixRequiredForTraitSniff implements Sniff
14+
class TraitNameSuffixSniff implements Sniff
1515
{
1616

1717

@@ -45,7 +45,7 @@ public function process(File $phpcsFile, $stackPtr)
4545

4646
$suffix = substr($traitName, -5);
4747
if (strtolower($suffix) !== 'trait') {
48-
$phpcsFile->addError('Traits MUST be suffixed by Trait: e.g. BarTrait. Found: %s', $stackPtr, 'Missing', [$traitName]);
48+
$phpcsFile->addError('Trait names must be suffixed with "Trait"; found "%s"', $stackPtr, 'Missing', [$traitName]);
4949
}
5050

5151
}//end process()

‎src/Standards/Generic/Tests/NamingConventions/AbstractPrefixRequiredForAbstractClassUnitTest.inc renamed to ‎src/Standards/Generic/Tests/NamingConventions/AbstractClassNamePrefixUnitTest.inc

File renamed without changes.

‎src/Standards/Generic/Tests/NamingConventions/AbstractPrefixRequiredForAbstractClassUnitTest.php renamed to ‎src/Standards/Generic/Tests/NamingConventions/AbstractClassNamePrefixUnitTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22
/**
3-
* Unit test class for the AbstractPrefixRequiredForAbstractClass sniff.
3+
* Unit test class for the AbstractClassNamePrefix sniff.
44
*
55
* @author Anna Borzenko <[email protected]>
66
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
@@ -10,7 +10,7 @@
1010

1111
use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
1212

13-
class AbstractPrefixRequiredForAbstractClassUnitTest extends AbstractSniffUnitTest
13+
class AbstractClassNamePrefixUnitTest extends AbstractSniffUnitTest
1414
{
1515

1616

‎src/Standards/Generic/Tests/NamingConventions/InterfaceSuffixRequiredForInterfaceUnitTest.inc renamed to ‎src/Standards/Generic/Tests/NamingConventions/InterfaceNameSuffixUnitTest.inc

File renamed without changes.

0 commit comments

Comments
 (0)