Generic/SpreadOperatorSpacingAfter: minor message readability improve…

…ment Use `space`/`spaces` depending on the value of the `$spacing` property instead of using `space(s)` in the error message.
PHPCSStandards · Dec 4, 2023 · 511b877 · 511b877
1 parent 45d33e0
commit 511b877
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -87,6 +87,8 @@ The file documents changes to the PHP_CodeSniffer project.
     - Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
 - Tests using the PHPCS native test framework with multiple test case files will now run the test case files in numeric order.
     - Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
+- Generic/SpreadOperatorSpacingAfter: minor message readability improvement
+    - Thanks to Juliette Reinders Folmer (@jrfnl) for the patch
 
 ### Removed
 - Removed support for installing via PEAR

diff --git a/src/Standards/Generic/Sniffs/WhiteSpace/SpreadOperatorSpacingAfterSniff.php b/src/Standards/Generic/Sniffs/WhiteSpace/SpreadOperatorSpacingAfterSniff.php
@@ -54,8 +54,12 @@ public function register()
      */
     public function process(File $phpcsFile, $stackPtr)
     {
-        $tokens        = $phpcsFile->getTokens();
-        $this->spacing = (int) $this->spacing;
+        $tokens         = $phpcsFile->getTokens();
+        $this->spacing  = (int) $this->spacing;
+        $pluralizeSpace = 's';
+        if ($this->spacing === 1) {
+            $pluralizeSpace = '';
+        }
 
         $nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true);
         if ($nextNonEmpty === false) {
@@ -81,8 +85,11 @@ public function process(File $phpcsFile, $stackPtr)
 
         $nextNonWhitespace = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
         if ($nextNonEmpty !== $nextNonWhitespace) {
-            $error = 'Expected %s space(s) after the spread operator; comment found';
-            $data  = [$this->spacing];
+            $error = 'Expected %s space%s after the spread operator; comment found';
+            $data  = [
+                $this->spacing,
+                $pluralizeSpace,
+            ];
             $phpcsFile->addError($error, $stackPtr, 'CommentFound', $data);
 
             if ($tokens[($stackPtr + 1)]['code'] === T_WHITESPACE) {
@@ -107,9 +114,10 @@ public function process(File $phpcsFile, $stackPtr)
             return;
         }
 
-        $error = 'Expected %s space(s) after the spread operator; %s found';
+        $error = 'Expected %s space%s after the spread operator; %s found';
         $data  = [
             $this->spacing,
+            $pluralizeSpace,
             $found,
         ];