diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 5da9ed79..bb5f3fdf 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -91,6 +91,7 @@ When you introduce new `public` sniff properties, or your sniff extends a class ### Pre-requisites * VIP Coding Standards * WordPress-Coding-Standards +* VariableAnalysis * PHPCSUtils 1.x * PHP_CodeSniffer 3.x * PHPUnit 4.x - 9.x @@ -144,15 +145,18 @@ The easiest way to do this is to add a `phpunit.xml` file to the root of your VI Expected output: ``` -PHPUnit 9.6.15 by Sebastian Bergmann and contributors. +Note: Tests are running in "CS" mode -........................................ 40 / 40 (100%) +PHPUnit 9.6.23 by Sebastian Bergmann and contributors. -45 sniff test files generated 175 unique error codes; 0 were fixable (0%) +Runtime: PHP 8.4.10 +Configuration: phpunit.xml.dist -Time: 150 ms, Memory: 20.00 MB +....................................... 39 / 39 (100%) -OK (40 tests, 0 assertions) +52 sniff test files generated 172 unique error codes; 0 were fixable (0%) + +Time: 00:00.862, Memory: 58.00 MB ``` ### Unit Testing conventions diff --git a/WordPressVIPMinimum/Sniffs/AbstractVariableRestrictionsSniff.php b/WordPressVIPMinimum/Sniffs/AbstractVariableRestrictionsSniff.php index a2b149ab..4619807c 100644 --- a/WordPressVIPMinimum/Sniffs/AbstractVariableRestrictionsSniff.php +++ b/WordPressVIPMinimum/Sniffs/AbstractVariableRestrictionsSniff.php @@ -122,8 +122,6 @@ protected function setup_groups() { * @param int $stackPtr The position of the current token in the stack. * @return int|void Integer stack pointer to skip forward or void to continue * normal file processing. - * - * @throws \PHP_CodeSniffer\Exceptions\RuntimeException Exception. */ public function process_token( $stackPtr ) { diff --git a/WordPressVIPMinimum/Sniffs/Security/ProperEscapingFunctionSniff.php b/WordPressVIPMinimum/Sniffs/Security/ProperEscapingFunctionSniff.php index ffcdce77..d746aa2c 100644 --- a/WordPressVIPMinimum/Sniffs/Security/ProperEscapingFunctionSniff.php +++ b/WordPressVIPMinimum/Sniffs/Security/ProperEscapingFunctionSniff.php @@ -187,7 +187,7 @@ public function process_token( $stackPtr ) { $html = $this->phpcsFile->findPrevious( $ignore, $stackPtr - 1, null, true ); - // Use $textStringTokens b/c heredoc and nowdoc tokens will never be encountered in this context anyways.. + // Use $textStringTokens b/c heredoc and nowdoc tokens will never be encountered in this context anyways. if ( $html === false || isset( Tokens::$textStringTokens[ $this->tokens[ $html ]['code'] ] ) === false ) { return; } diff --git a/WordPressVIPMinimum/Sniffs/UserExperience/AdminBarRemovalSniff.php b/WordPressVIPMinimum/Sniffs/UserExperience/AdminBarRemovalSniff.php index ae98644b..c6fe02ee 100644 --- a/WordPressVIPMinimum/Sniffs/UserExperience/AdminBarRemovalSniff.php +++ b/WordPressVIPMinimum/Sniffs/UserExperience/AdminBarRemovalSniff.php @@ -85,7 +85,7 @@ class AdminBarRemovalSniff extends AbstractFunctionParameterSniff { ]; /** - * String tokens within PHP files we want to deal with. + * Text string tokens within PHP files we want to deal with. * * Set from the register() method. * @@ -120,7 +120,7 @@ class AdminBarRemovalSniff extends AbstractFunctionParameterSniff { * @return array */ public function register() { - // Set up all string targets. + // Set up all text string targets. $this->string_tokens = Tokens::$textStringTokens; $targets = $this->string_tokens; diff --git a/WordPressVIPMinimum/Tests/Constants/RestrictedConstantsUnitTest.php b/WordPressVIPMinimum/Tests/Constants/RestrictedConstantsUnitTest.php index 3c718f6b..4429b324 100644 --- a/WordPressVIPMinimum/Tests/Constants/RestrictedConstantsUnitTest.php +++ b/WordPressVIPMinimum/Tests/Constants/RestrictedConstantsUnitTest.php @@ -10,7 +10,7 @@ use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest; /** - * Unit test class for the ConstantRestrictions sniff. + * Unit test class for the RestrictedConstants sniff. * * @covers \WordPressVIPMinimum\Sniffs\Constants\RestrictedConstantsSniff */ diff --git a/WordPressVIPMinimum/Tests/Hooks/AlwaysReturnInFilterUnitTest.php b/WordPressVIPMinimum/Tests/Hooks/AlwaysReturnInFilterUnitTest.php index fa04f72e..fe022949 100644 --- a/WordPressVIPMinimum/Tests/Hooks/AlwaysReturnInFilterUnitTest.php +++ b/WordPressVIPMinimum/Tests/Hooks/AlwaysReturnInFilterUnitTest.php @@ -10,7 +10,7 @@ use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest; /** - * Unit test class for the Hooks/AlwaysReturn sniff. + * Unit test class for the AlwaysReturnInFilter sniff. * * @covers \WordPressVIPMinimum\Sniffs\Hooks\AlwaysReturnInFilterSniff */ diff --git a/WordPressVIPMinimum/Tests/Hooks/RestrictedHooksUnitTest.php b/WordPressVIPMinimum/Tests/Hooks/RestrictedHooksUnitTest.php index 8e1c65dc..56da7d62 100644 --- a/WordPressVIPMinimum/Tests/Hooks/RestrictedHooksUnitTest.php +++ b/WordPressVIPMinimum/Tests/Hooks/RestrictedHooksUnitTest.php @@ -9,7 +9,7 @@ use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest; /** - * Unit test class for the Filters/RestrictedHooks sniff. + * Unit test class for the RestrictedHooks sniff. * * @since 0.4.0 * diff --git a/WordPressVIPMinimum/Tests/JS/DangerouslySetInnerHTMLUnitTest.php b/WordPressVIPMinimum/Tests/JS/DangerouslySetInnerHTMLUnitTest.php index 8f2ca838..68e85bb1 100644 --- a/WordPressVIPMinimum/Tests/JS/DangerouslySetInnerHTMLUnitTest.php +++ b/WordPressVIPMinimum/Tests/JS/DangerouslySetInnerHTMLUnitTest.php @@ -10,7 +10,7 @@ use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest; /** - * Unit test class for the HTML String concatenation in JS sniff. + * Unit test class for the DangerouslySetInnerHTML sniff. * * @covers \WordPressVIPMinimum\Sniffs\JS\DangerouslySetInnerHTMLSniff */ diff --git a/WordPressVIPMinimum/Tests/JS/InnerHTMLUnitTest.php b/WordPressVIPMinimum/Tests/JS/InnerHTMLUnitTest.php index 20c01177..3c9e5de3 100644 --- a/WordPressVIPMinimum/Tests/JS/InnerHTMLUnitTest.php +++ b/WordPressVIPMinimum/Tests/JS/InnerHTMLUnitTest.php @@ -10,7 +10,7 @@ use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest; /** - * Unit test class for the HTML String concatenation in JS sniff. + * Unit test class for the InnerHTML sniff. * * @covers \WordPressVIPMinimum\Sniffs\JS\InnerHTMLSniff */ diff --git a/WordPressVIPMinimum/Tests/JS/WindowUnitTest.php b/WordPressVIPMinimum/Tests/JS/WindowUnitTest.php index 32ed5cae..0de812d0 100644 --- a/WordPressVIPMinimum/Tests/JS/WindowUnitTest.php +++ b/WordPressVIPMinimum/Tests/JS/WindowUnitTest.php @@ -10,7 +10,7 @@ use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest; /** - * Unit test class for the HTML String concatenation in JS sniff. + * Unit test class for the JS/Window sniff. * * @covers \WordPressVIPMinimum\Sniffs\JS\WindowSniff */ diff --git a/WordPressVIPMinimum/Tests/Performance/FetchingRemoteDataUnitTest.php b/WordPressVIPMinimum/Tests/Performance/FetchingRemoteDataUnitTest.php index 670ef4c5..9f9ede3a 100644 --- a/WordPressVIPMinimum/Tests/Performance/FetchingRemoteDataUnitTest.php +++ b/WordPressVIPMinimum/Tests/Performance/FetchingRemoteDataUnitTest.php @@ -10,7 +10,7 @@ use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest; /** - * Unit test class for the ExitAfterRedirect sniff. + * Unit test class for the FetchingRemoteData sniff. * * @covers \WordPressVIPMinimum\Sniffs\Performance\FetchingRemoteDataSniff */ diff --git a/WordPressVIPMinimum/Tests/Security/PHPFilterFunctionsUnitTest.php b/WordPressVIPMinimum/Tests/Security/PHPFilterFunctionsUnitTest.php index e708a38c..1faa0728 100644 --- a/WordPressVIPMinimum/Tests/Security/PHPFilterFunctionsUnitTest.php +++ b/WordPressVIPMinimum/Tests/Security/PHPFilterFunctionsUnitTest.php @@ -10,7 +10,7 @@ use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest; /** - * Unit test class for the WP_Query params sniff. + * Unit test class for the PHPFilterFunctions sniff. * * @covers \WordPressVIPMinimum\Sniffs\Security\PHPFilterFunctionsSniff */ diff --git a/WordPressVIPMinimum/Tests/Variables/RestrictedVariablesUnitTest.php b/WordPressVIPMinimum/Tests/Variables/RestrictedVariablesUnitTest.php index a5659be0..e5b7ecf2 100644 --- a/WordPressVIPMinimum/Tests/Variables/RestrictedVariablesUnitTest.php +++ b/WordPressVIPMinimum/Tests/Variables/RestrictedVariablesUnitTest.php @@ -10,7 +10,7 @@ use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest; /** - * Unit test class for the VIP_RestrictedVariables sniff. + * Unit test class for the RestrictedVariables sniff. * * @covers \WordPressVIPMinimum\Sniffs\Variables\RestrictedVariablesSniff */ diff --git a/WordPressVIPMinimum/Tests/Variables/ServerVariablesUnitTest.php b/WordPressVIPMinimum/Tests/Variables/ServerVariablesUnitTest.php index 610dabd0..c7d89d70 100644 --- a/WordPressVIPMinimum/Tests/Variables/ServerVariablesUnitTest.php +++ b/WordPressVIPMinimum/Tests/Variables/ServerVariablesUnitTest.php @@ -10,7 +10,7 @@ use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest; /** - * Unit test class for the Variable Analysis sniff. + * Unit test class for the ServerVariables sniff. * * @covers \WordPressVIPMinimum\Sniffs\Variables\ServerVariablesSniff */