Constants/ConstantString: improve clarity of error message

jrfnl · jrfnl · commit 68260d29b846 · 2025-07-21T19:11:12.000+02:00
diff --git a/WordPressVIPMinimum/Sniffs/Constants/ConstantStringSniff.php b/WordPressVIPMinimum/Sniffs/Constants/ConstantStringSniff.php
@@ -64,7 +64,7 @@ public function process_parameters( $stackPtr, $group_name, $matched_content, $p
 
 		$tstring_token = $this->phpcsFile->findNext( T_STRING, $param['start'], $param['end'] + 1 );
 
-		$message = 'Constant name, as a string, should be used along with `%s()`.';
+		$message = 'The `%s()` function expects to be passed the constant name as a text string.';
 		$data    = [ $this->tokens[ $stackPtr ]['content'] ];
 		$this->phpcsFile->addError( $message, $tstring_token, 'NotCheckingConstantName', $data );
 	}

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ public function process_parameters( $stackPtr, $group_name, $matched_content, $p`
`64`	`64`
`65`	`65`	`$tstring_token = $this->phpcsFile->findNext( T_STRING, $param['start'], $param['end'] + 1 );`
`66`	`66`
`67`		- $message = 'Constant name, as a string, should be used along with `%s()`.';
	`67`	+ $message = 'The `%s()` function expects to be passed the constant name as a text string.';
`68`	`68`	`$data = [ $this->tokens[ $stackPtr ]['content'] ];`
`69`	`69`	`$this->phpcsFile->addError( $message, $tstring_token, 'NotCheckingConstantName', $data );`
`70`	`70`	`}`