Merge pull request #871 from Automattic/WIP/feature/various-doc-fixes

Author: GaryJones

.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

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 ) {
 

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;
 		}

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<int|string>
 	 */
 	public function register() {
-		// Set up all string targets.
+		// Set up all text string targets.
 		$this->string_tokens = Tokens::$textStringTokens;
 
 		$targets = $this->string_tokens;

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
  */

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
  */

WordPressVIPMinimum/Tests/Hooks/RestrictedHooksUnitTest.php

@@ -10,7 +10,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
  *

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
  */

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
  */

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
  */