Fix phpcs locally with PHP 8.2, fix #43

kagg-design · web-flow · commit 45cd985d9970 · 2024-02-08T21:49:03.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@ All notable changes to this project will be documented in this file and formatte
 ## [1.1.1] - 2024-XX-XX
 ### Fixed
 - Function return type broke WPForms.Formatting.EmptyLineBeforeReturn sniff.
+- The phpcs did not work locally with PHP 8+.
 
 ## [1.1.0] - 2023-09-07
 ### Fixed
diff --git a/WPForms/Sniffs/BaseSniff.php b/WPForms/Sniffs/BaseSniff.php
@@ -67,7 +67,7 @@ protected function getRootDirectory( $phpcsFile ) {
 	}
 
 	/**
-	 * Get relative path from project root directory.
+	 * Get a relative path from project root directory.
 	 *
 	 * @since 1.0.0
 	 *
@@ -119,7 +119,7 @@ protected function normalizeFilename( $filename ) {
 	}
 
 	/**
-	 * Get first argument of a function.
+	 * Get the first argument of a function.
 	 *
 	 * @since 1.0.0
 	 *
@@ -152,7 +152,7 @@ protected function getFirstArgument( $phpcsFile, $stackPtr ) {
 	}
 
 	/**
-	 * Check whether the token is break in switch statement.
+	 * Check whether the token is break in the switch statement.
 	 *
 	 * @since 1.0.4
 	 *
@@ -176,7 +176,7 @@ protected function isBreakInSwitch( $phpcsFile, $token ) {
 	}
 
 	/**
-	 * Get fully qualified class name.
+	 * Get a fully qualified class name.
 	 *
 	 * @since 1.0.0
 	 *
@@ -219,7 +219,7 @@ protected function getFullyQualifiedClassName( $phpcsFile ) {
 		$fqcn = $this->camelToSnake( str_replace( '\\', '', $namespace ) ) . '_' . $class;
 
 		// Fix WPForms.
-		// Remove _plugin for main plugin class, which is usually Plugin.
+		// Remove _plugin for the main plugin class, which is usually Plugin.
 		$fqcn = str_replace( [ 'wp_forms', '_plugin' ], [ 'wpforms', '' ], $fqcn );
 
 		$fqcnArr = explode( '_', $fqcn );
diff --git a/WPForms/Sniffs/Comments/DeprecatedTagHooksSniff.php b/WPForms/Sniffs/Comments/DeprecatedTagHooksSniff.php
@@ -59,7 +59,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
diff --git a/WPForms/Sniffs/Comments/DeprecatedTagSniff.php b/WPForms/Sniffs/Comments/DeprecatedTagSniff.php
@@ -39,7 +39,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
diff --git a/WPForms/Sniffs/Comments/DescriptionStopSymbolPropertySniff.php b/WPForms/Sniffs/Comments/DescriptionStopSymbolPropertySniff.php
@@ -18,7 +18,7 @@ class DescriptionStopSymbolPropertySniff extends PropertyBaseSniff {
 	use Description;
 
 	/**
-	 * Called to process class member vars.
+	 * Process Process this test when one of its tokens is encountered..
 	 *
 	 * @since 1.0.0
 	 *
diff --git a/WPForms/Sniffs/Comments/DescriptionStopSymbolSniff.php b/WPForms/Sniffs/Comments/DescriptionStopSymbolSniff.php
@@ -37,7 +37,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
diff --git a/WPForms/Sniffs/Comments/LanguageInjectionSniff.php b/WPForms/Sniffs/Comments/LanguageInjectionSniff.php
@@ -29,7 +29,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
diff --git a/WPForms/Sniffs/Comments/NoSpacesAfterParamTagSniff.php b/WPForms/Sniffs/Comments/NoSpacesAfterParamTagSniff.php
@@ -40,7 +40,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
@@ -59,7 +59,7 @@ public function process( File $phpcsFile, $stackPtr ) {
 			return;
 		}
 
-		// More than 1 spaces.
+		// More than one space.
 		if ( $tokens[ $tag['tag'] + 1 ]['length'] > 1 ) {
 			$phpcsFile->addError(
 				sprintf(
diff --git a/WPForms/Sniffs/Comments/PHPDocDefineSniff.php b/WPForms/Sniffs/Comments/PHPDocDefineSniff.php
@@ -31,7 +31,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
diff --git a/WPForms/Sniffs/Comments/PHPDocHooksSniff.php b/WPForms/Sniffs/Comments/PHPDocHooksSniff.php
@@ -42,7 +42,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
diff --git a/WPForms/Sniffs/Comments/ParamTagHooksSniff.php b/WPForms/Sniffs/Comments/ParamTagHooksSniff.php
@@ -47,14 +47,15 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
 	 * @param File $phpcsFile The PHP_CodeSniffer file where the token was found.
 	 * @param int  $stackPtr  The position in the PHP_CodeSniffer file's token stack where the token was found.
 	 *
 	 * @return void
+	 * @noinspection UnusedFunctionResultInspection
 	 */
 	public function process( File $phpcsFile, $stackPtr ) {
 
diff --git a/WPForms/Sniffs/Comments/ReturnTagHooks.php b/WPForms/Sniffs/Comments/ReturnTagHooks.php
@@ -53,7 +53,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
diff --git a/WPForms/Sniffs/Comments/ShortDescriptionHooksSniff.php b/WPForms/Sniffs/Comments/ShortDescriptionHooksSniff.php
@@ -47,7 +47,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
diff --git a/WPForms/Sniffs/Comments/SinceTagDefineSniff.php b/WPForms/Sniffs/Comments/SinceTagDefineSniff.php
@@ -35,7 +35,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
diff --git a/WPForms/Sniffs/Comments/SinceTagHooksSniff.php b/WPForms/Sniffs/Comments/SinceTagHooksSniff.php
@@ -47,7 +47,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
diff --git a/WPForms/Sniffs/Comments/SinceTagPropertySniff.php b/WPForms/Sniffs/Comments/SinceTagPropertySniff.php
@@ -18,7 +18,7 @@ class SinceTagPropertySniff extends PropertyBaseSniff {
 	use CommentTag;
 
 	/**
-	 * Called to process class member vars.
+	 * Process class member vars.
 	 *
 	 * @since 1.0.0
 	 *
diff --git a/WPForms/Sniffs/Comments/SinceTagSniff.php b/WPForms/Sniffs/Comments/SinceTagSniff.php
@@ -39,7 +39,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
diff --git a/WPForms/Sniffs/Comments/TranslatorsSniff.php b/WPForms/Sniffs/Comments/TranslatorsSniff.php
@@ -31,7 +31,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
diff --git a/WPForms/Sniffs/Formatting/EmptyLineAfterAssigmentVariablesSniff.php b/WPForms/Sniffs/Formatting/EmptyLineAfterAssigmentVariablesSniff.php
@@ -27,7 +27,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
@@ -46,7 +46,7 @@ public function process( File $phpcsFile, $stackPtr ) {
 			return;
 		}
 
-		// Detect the last ";" for detect end of this operation for multiline expressions.
+		// Detect the last ";" for detect the end of this operation for multiline expressions.
 		$semicolon          = $phpcsFile->findNext( [ T_SEMICOLON ], $stackPtr + 1 );
 		$nextAfterSemicolon = $phpcsFile->findNext( Tokens::$emptyTokens, $semicolon + 1, null, true );
 
@@ -57,7 +57,7 @@ public function process( File $phpcsFile, $stackPtr ) {
 
 		$nextLineTokens = $this->getTokenNextLine( $phpcsFile, $semicolon );
 
-		// If next line is empty line.
+		// If the next line is an empty line.
 		if ( empty( $nextLineTokens ) ) {
 			return;
 		}
@@ -77,7 +77,7 @@ public function process( File $phpcsFile, $stackPtr ) {
 	}
 
 	/**
-	 * Get list of tokens that allowed in next line after assigment.
+	 * Get the list of tokens that allowed in the next line after assigment.
 	 *
 	 * @since 1.0.0
 	 *
@@ -95,7 +95,7 @@ private function getAllowedTokensAfterAssigment() {
 	}
 
 	/**
-	 * Get tokens in last line.
+	 * Get tokens in the last line.
 	 *
 	 * @since 1.0.0
 	 *
@@ -127,7 +127,7 @@ private function getTokenNextLine( $phpcsFile, $semicolon ) {
 				break;
 			}
 
-			// Skip if the next line is also assignment statement.
+			// Skip if the next line is also an assignment statement.
 			if ( in_array( $tokens[ $i ]['code'], Tokens::$assignmentTokens, true ) ) {
 				return [];
 			}
diff --git a/WPForms/Sniffs/Formatting/EmptyLineAfterFunctionDeclarationSniff.php b/WPForms/Sniffs/Formatting/EmptyLineAfterFunctionDeclarationSniff.php
@@ -29,7 +29,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
diff --git a/WPForms/Sniffs/Formatting/EmptyLineBeforeReturnSniff.php b/WPForms/Sniffs/Formatting/EmptyLineBeforeReturnSniff.php
@@ -29,7 +29,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
diff --git a/WPForms/Sniffs/Formatting/SwitchSniff.php b/WPForms/Sniffs/Formatting/SwitchSniff.php
@@ -31,7 +31,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
diff --git a/WPForms/Sniffs/PHP/BackSlashSniff.php b/WPForms/Sniffs/PHP/BackSlashSniff.php
@@ -29,7 +29,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
@@ -123,7 +123,7 @@ private function processComments( $phpcsFile, $stackPtr ) {
 	}
 
 	/**
-	 * Remove backslash message.
+	 * Remove the backslash message.
 	 *
 	 * @since 1.0.0
 	 *
diff --git a/WPForms/Sniffs/PHP/ConditionsYodaDisableSniff.php b/WPForms/Sniffs/PHP/ConditionsYodaDisableSniff.php
@@ -32,7 +32,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
diff --git a/WPForms/Sniffs/PHP/HooksMethodSniff.php b/WPForms/Sniffs/PHP/HooksMethodSniff.php
@@ -47,7 +47,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
@@ -64,9 +64,7 @@ public function process( File $phpcsFile, $stackPtr ) {
 			return;
 		}
 
-		$classname = $this->getFullyQualifiedClassName( $phpcsFile );
-
-		if ( ! $classname ) {
+		if ( ! $this->getFullyQualifiedClassName( $phpcsFile ) ) {
 			return;
 		}
 
diff --git a/WPForms/Sniffs/PHP/UseStatementSniff.php b/WPForms/Sniffs/PHP/UseStatementSniff.php
@@ -28,7 +28,7 @@ public function register() {
 	}
 
 	/**
-	 * Processes this test, when one of its tokens is encountered.
+	 * Process this test when one of its tokens is encountered.
 	 *
 	 * @since 1.0.0
 	 *
@@ -171,7 +171,7 @@ private function findInThrows( $phpcsFile, $entityName, $stackPtr ) {
 			$closePtr   = $phpcsFile->findNext( T_DOC_COMMENT_CLOSE_TAG, $stackPtr + 1 );
 			$commentPtr = $phpcsFile->findNext( T_DOC_COMMENT_STRING, $stackPtr + 1, $closePtr );
 
-			if ( $commentPtr && $entityName === explode( ' ', $tokens[ $commentPtr ]['content'] )[0] ) {
+			if ( $commentPtr && $entityName === explode( ' ', $tokens[ $commentPtr ]['content'], 2 )[0] ) {
 				return true;
 			}
 		}
diff --git a/WPForms/Sniffs/PHP/ValidateDomainSniff.php b/WPForms/Sniffs/PHP/ValidateDomainSniff.php
diff --git a/WPForms/Sniffs/PHP/ValidateHooksSniff.php b/WPForms/Sniffs/PHP/ValidateHooksSniff.php
diff --git a/WPForms/Sniffs/PropertyBaseSniff.php b/WPForms/Sniffs/PropertyBaseSniff.php
diff --git a/WPForms/Tests/TestCase.php b/WPForms/Tests/TestCase.php
diff --git a/WPForms/Tests/Tests/BaseSniffTest.php b/WPForms/Tests/Tests/BaseSniffTest.php
diff --git a/WPForms/Tests/bootstrap.php b/WPForms/Tests/bootstrap.php
diff --git a/WPForms/Traits/Description.php b/WPForms/Traits/Description.php
diff --git a/WPForms/Traits/DuplicateHook.php b/WPForms/Traits/DuplicateHook.php
diff --git a/WPForms/ruleset.xml b/WPForms/ruleset.xml
diff --git a/composer.lock b/composer.lock

Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ protected function getRootDirectory( $phpcsFile ) {`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`/**`
`70`		`- * Get relative path from project root directory.`
	`70`	`+ * Get a relative path from project root directory.`
`71`	`71`	`*`
`72`	`72`	`* @since 1.0.0`
`73`	`73`	`*`
`@@ -119,7 +119,7 @@ protected function normalizeFilename( $filename ) {`
`119`	`119`	`}`
`120`	`120`
`121`	`121`	`/**`
`122`		`- * Get first argument of a function.`
	`122`	`+ * Get the first argument of a function.`
`123`	`123`	`*`
`124`	`124`	`* @since 1.0.0`
`125`	`125`	`*`
`@@ -152,7 +152,7 @@ protected function getFirstArgument( $phpcsFile, $stackPtr ) {`
`152`	`152`	`}`
`153`	`153`
`154`	`154`	`/**`
`155`		`- * Check whether the token is break in switch statement.`
	`155`	`+ * Check whether the token is break in the switch statement.`
`156`	`156`	`*`
`157`	`157`	`* @since 1.0.4`
`158`	`158`	`*`
`@@ -176,7 +176,7 @@ protected function isBreakInSwitch( $phpcsFile, $token ) {`
`176`	`176`	`}`
`177`	`177`
`178`	`178`	`/**`
`179`		`- * Get fully qualified class name.`
	`179`	`+ * Get a fully qualified class name.`
`180`	`180`	`*`
`181`	`181`	`* @since 1.0.0`
`182`	`182`	`*`
`@@ -219,7 +219,7 @@ protected function getFullyQualifiedClassName( $phpcsFile ) {`
`219`	`219`	`$fqcn = $this->camelToSnake( str_replace( '\\', '', $namespace ) ) . '_' . $class;`
`220`	`220`
`221`	`221`	`// Fix WPForms.`
`222`		`- // Remove _plugin for main plugin class, which is usually Plugin.`
	`222`	`+ // Remove _plugin for the main plugin class, which is usually Plugin.`
`223`	`223`	`$fqcn = str_replace( [ 'wp_forms', '_plugin' ], [ 'wpforms', '' ], $fqcn );`
`224`	`224`
`225`	`225`	`$fqcnArr = explode( '_', $fqcn );`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ public function register() {`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`/**`
`62`		`- * Processes this test, when one of its tokens is encountered.`
	`62`	`+ * Process this test when one of its tokens is encountered.`
`63`	`63`	`*`
`64`	`64`	`* @since 1.0.0`
`65`	`65`	`*`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public function register() {`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`/**`
`42`		`- * Processes this test, when one of its tokens is encountered.`
	`42`	`+ * Process this test when one of its tokens is encountered.`
`43`	`43`	`*`
`44`	`44`	`* @since 1.0.0`
`45`	`45`	`*`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ class DescriptionStopSymbolPropertySniff extends PropertyBaseSniff {`
`18`	`18`	`use Description;`
`19`	`19`
`20`	`20`	`/**`
`21`		`- * Called to process class member vars.`
	`21`	`+ * Process Process this test when one of its tokens is encountered..`
`22`	`22`	`*`
`23`	`23`	`* @since 1.0.0`
`24`	`24`	`*`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public function register() {`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`/**`
`40`		`- * Processes this test, when one of its tokens is encountered.`
	`40`	`+ * Process this test when one of its tokens is encountered.`
`41`	`41`	`*`
`42`	`42`	`* @since 1.0.0`
`43`	`43`	`*`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public function register() {`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`/**`
`32`		`- * Processes this test, when one of its tokens is encountered.`
	`32`	`+ * Process this test when one of its tokens is encountered.`
`33`	`33`	`*`
`34`	`34`	`* @since 1.0.0`
`35`	`35`	`*`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public function register() {`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`/**`
`43`		`- * Processes this test, when one of its tokens is encountered.`
	`43`	`+ * Process this test when one of its tokens is encountered.`
`44`	`44`	`*`
`45`	`45`	`* @since 1.0.0`
`46`	`46`	`*`
`@@ -59,7 +59,7 @@ public function process( File $phpcsFile, $stackPtr ) {`
`59`	`59`	`return;`
`60`	`60`	`}`
`61`	`61`
`62`		`- // More than 1 spaces.`
	`62`	`+ // More than one space.`
`63`	`63`	`if ( $tokens[ $tag['tag'] + 1 ]['length'] > 1 ) {`
`64`	`64`	`$phpcsFile->addError(`
`65`	`65`	`sprintf(`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public function register() {`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`/**`
`34`		`- * Processes this test, when one of its tokens is encountered.`
	`34`	`+ * Process this test when one of its tokens is encountered.`
`35`	`35`	`*`
`36`	`36`	`* @since 1.0.0`
`37`	`37`	`*`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public function register() {`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`/**`
`45`		`- * Processes this test, when one of its tokens is encountered.`
	`45`	`+ * Process this test when one of its tokens is encountered.`
`46`	`46`	`*`
`47`	`47`	`* @since 1.0.0`
`48`	`48`	`*`