WP/I18n: fix SuperfluousDefaultTextDomain auto-fix code to allow for named params

The auto-fixer for the `SuperfluousDefaultTextDomain` warning attempts to remove a complete parameter, though it will bow out from auto-fixing when there is a comment in the tokens which would be removed.

This auto-fixer code and the code to determine whether an auto-fix is possible, now needs adjusting to allow for function calls with named parameters as otherwise the fixer could cause parse errors.
* The parameter label and the `:` also needs to be removed.
* If the named parameter is the first parameter, there will not be a preceding comma, but we will need to remove the comma behind it.
* The range of tokens which needs to be checked for comments to determine whether the error is auto-fixable needs to be expanded.

This commit makes those changes.

Includes additional unit tests to safeguard the fixes.

Author: jrfnl

WordPress/Sniffs/WP/I18nSniff.php

@@ -578,8 +578,28 @@ private function check_textdomain_matches( $matched_content, $param_name, $param
 
 			$first_non_empty = $this->phpcsFile->findNext( Tokens::$emptyTokens, $param_info['start'], ( $param_info['end'] + 1 ), true );
 
-			$before_param = $this->phpcsFile->findPrevious( \T_WHITESPACE, ( $first_non_empty - 1 ), null, true );
-			if ( \T_COMMA === $this->tokens[ $before_param ]['code'] ) {
+			// Prevent removing comments when auto-fixing.
+			$remove_from = ( $param_info['start'] - 1 );
+			$remove_to   = $first_non_empty;
+
+			if ( isset( $param_info['name_token'] ) ) {
+				$remove_from = $this->phpcsFile->findPrevious( Tokens::$emptyTokens, ( $param_info['name_token'] - 1 ), null, true );
+				if ( \T_OPEN_PARENTHESIS === $this->tokens[ $remove_from ]['code'] ) {
+					++$remove_from; // Don't remove the open parenthesis.
+
+					/*
+					 * Named param as first param in the function call, if we fix this, we need to
+					 * remove the comma _after_ the parameter as well to prevent creating a parse error.
+					 */
+					$remove_to = $param_info['end'];
+					if ( \T_COMMA === $this->tokens[ ( $param_info['end'] + 1 ) ]['code'] ) {
+						++$remove_to; // Include the comma.
+					}
+				}
+			}
+
+			// Now, make sure there are no comments in the tokens we want to remove.
+			if ( $this->phpcsFile->findNext( Tokens::$commentTokens, $remove_from, ( $remove_to + 1 ) ) === false ) {
 				$fixable = true;
 			}
 
@@ -590,9 +610,8 @@ private function check_textdomain_matches( $matched_content, $param_name, $param
 
 			$fix = $this->phpcsFile->addFixableWarning( $error, $first_non_empty, $error_code, $data );
 			if ( true === $fix ) {
-				// Remove preceeding comma, whitespace and the text domain token.
 				$this->phpcsFile->fixer->beginChangeset();
-				for ( $i = $before_param; $i <= $first_non_empty; $i++ ) {
+				for ( $i = $remove_from; $i <= $remove_to; $i++ ) {
 					$this->phpcsFile->fixer->replaceToken( $i, '' );
 				}
 				$this->phpcsFile->fixer->endChangeset();

WordPress/Tests/WP/I18nUnitTest.1.inc

@@ -290,5 +290,16 @@ _nx( number: $i, domain: 'my-slug', plural: 'translate %s me', single: 'translat
 __( 'translate me', 'default', ); // Bad: superfluous domain (positional with trailing comma).
 __( 'translate me', 'default' /*comment*/, ); // Bad: superfluous domain (positional with trailing comma and comment).
 
+// Safeguard handling of named params by the SuperfluousDefaultTextDomain fixer.
+__( text: 'translate me', domain: 'default' ); // Bad: superfluous domain.
+__( text: 'translate me', domain: 'default', ); // Bad: superfluous domain (with trailing comma).
+_n_noop( domain: 'default', singular: 'translate me', plural: 'translate me', ); // Bad: superfluous domain.
+_nx_noop( singular: 'translate me', domain: 'default' /*comment*/, plural: 'translate me', context: 'context', ); // Bad: superfluous domain.
+
+// These should not be auto-fixable as we don't want to remove the comment.
+__( text: 'translate me', domain: /*comment*/ 'default' ); // Bad: superfluous domain.
+_n_noop( domain: 'default' /*comment*/, singular: 'translate me', plural: 'translate me', ); // Bad: superfluous domain.
+_nx_noop( singular: 'translate me', domain /*comment*/: 'default', plural: 'translate me', context: 'context', ); // Bad: superfluous domain.
+
 // phpcs:set WordPress.WP.I18n text_domain[]
 // phpcs:set WordPress.WP.I18n check_translator_comments true

WordPress/Tests/WP/I18nUnitTest.1.inc.fixed

@@ -290,5 +290,16 @@ _nx( number: $i, domain: 'my-slug', plural: 'translate %s me', single: 'translat
 __( 'translate me', ); // Bad: superfluous domain (positional with trailing comma).
 __( 'translate me' /*comment*/, ); // Bad: superfluous domain (positional with trailing comma and comment).
 
+// Safeguard handling of named params by the SuperfluousDefaultTextDomain fixer.
+__( text: 'translate me' ); // Bad: superfluous domain.
+__( text: 'translate me', ); // Bad: superfluous domain (with trailing comma).
+_n_noop( singular: 'translate me', plural: 'translate me', ); // Bad: superfluous domain.
+_nx_noop( singular: 'translate me' /*comment*/, plural: 'translate me', context: 'context', ); // Bad: superfluous domain.
+
+// These should not be auto-fixable as we don't want to remove the comment.
+__( text: 'translate me', domain: /*comment*/ 'default' ); // Bad: superfluous domain.
+_n_noop( domain: 'default' /*comment*/, singular: 'translate me', plural: 'translate me', ); // Bad: superfluous domain.
+_nx_noop( singular: 'translate me', domain /*comment*/: 'default', plural: 'translate me', context: 'context', ); // Bad: superfluous domain.
+
 // phpcs:set WordPress.WP.I18n text_domain[]
 // phpcs:set WordPress.WP.I18n check_translator_comments true

WordPress/Tests/WP/I18nUnitTest.php

@@ -203,6 +203,13 @@ public function getWarningList( $testFile = '' ) {
 					285 => 1,
 					290 => 1,
 					291 => 1,
+					294 => 1,
+					295 => 1,
+					296 => 1,
+					297 => 1,
+					300 => 1,
+					301 => 1,
+					302 => 1,
 				);
 
 			case 'I18nUnitTest.2.inc':