StatusWriter: add writeNewline() and forceWriteNewline() methods

Includes test.
Includes updating various snippets calling the StatusWrite to print new lines.

Author: jrfnl

src/Files/LocalFile.php

@@ -123,7 +123,7 @@ public function process()
         }//end if
 
         if (PHP_CODESNIFFER_VERBOSITY > 1) {
-            StatusWriter::write('');
+            StatusWriter::writeNewline();
         }
 
         parent::process();

src/Reports/Cbf.php

@@ -153,10 +153,10 @@ public function generate(
 
         if (empty($lines) === true) {
             if (($totalErrors + $totalWarnings) === 0) {
-                StatusWriter::write('');
+                StatusWriter::writeNewline();
                 StatusWriter::write('No violations were found');
             } else {
-                StatusWriter::write('');
+                StatusWriter::writeNewline();
                 StatusWriter::write('No fixable errors were found');
             }
 

src/Ruleset.php

@@ -478,7 +478,7 @@ public function showSniffDeprecations()
         StatusWriter::write($messages, 0, 0);
 
         $closer = wordwrap('Deprecated sniffs are still run, but will stop working at some point in the future.', $reportWidth, PHP_EOL);
-        StatusWriter::write(PHP_EOL);
+        StatusWriter::writeNewline(2);
         StatusWriter::write($closer, 0, 2);
 
     }//end showSniffDeprecations()

src/Runner.php

@@ -516,7 +516,7 @@ private function run()
             && $this->config->interactive === false
             && $this->config->showProgress === true
         ) {
-            StatusWriter::write('', 0, 2);
+            StatusWriter::writeNewline(2);
         }
 
         if ($this->config->cache === true) {

src/Standards/Generic/Sniffs/WhiteSpace/ScopeIndentSniff.php

@@ -152,7 +152,8 @@ public function process(File $phpcsFile, $stackPtr)
 
         if ($this->debug === true) {
             $line = $tokens[$stackPtr]['line'];
-            StatusWriter::write(PHP_EOL."Start with token $stackPtr on line $line with indent $currentIndent");
+            StatusWriter::writeNewline();
+            StatusWriter::write("Start with token $stackPtr on line $line with indent $currentIndent");
         }
 
         if (empty($this->ignoreIndentation) === true) {

src/Tokenizers/PHP.php

@@ -605,7 +605,7 @@ protected function tokenize($string)
             }//end if
 
             if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                StatusWriter::write('');
+                StatusWriter::writeNewline();
             }
 
             /*

src/Util/Cache.php

@@ -51,7 +51,7 @@ public static function load(Ruleset $ruleset, Config $config)
         // At this point, the loaded class list contains the core PHPCS code
         // and all sniffs that have been loaded as part of the run.
         if (PHP_CODESNIFFER_VERBOSITY > 1) {
-            StatusWriter::write('');
+            StatusWriter::writeNewline();
             StatusWriter::write('Generating loaded file list for code hash', 1);
         }
 

src/Util/Writers/StatusWriter.php

@@ -98,6 +98,36 @@ public static function forceWrite($message, $indent=0, $newlines=1)
     }//end forceWrite()
 
 
+    /**
+     * Prints a new line to STDERR.
+     *
+     * @param int $nr Number of new lines to print.
+     *                Defaults to 1.
+     *
+     * @return void
+     */
+    public static function writeNewline($nr=1)
+    {
+        self::write('', 0, $nr);
+
+    }//end writeNewline()
+
+
+    /**
+     * Prints a new line to STDERR, even if status messages have been paused.
+     *
+     * @param int $nr Number of new lines to print.
+     *                Defaults to 1.
+     *
+     * @return void
+     */
+    public static function forceWriteNewline($nr=1)
+    {
+        self::forceWrite('', 0, $nr);
+
+    }//end forceWriteNewline()
+
+
     /**
      * Pauses the printing of status messages.
      *

tests/Core/Util/Writers/StatusWriterTest.php

@@ -248,6 +248,32 @@ public function testStatusDoesGetForcePrintedWhenPausedAndResumed()
     }//end testStatusDoesGetForcePrintedWhenPausedAndResumed()
 
 
+    /**
+     * Verify sending new lines to StdErr.
+     *
+     * @return void
+     */
+    public function testWriteNewline()
+    {
+        $this->expectNoStdoutOutput();
+
+        $this->assertFalse(StatusWriter::isPaused());
+
+        // Print new line.
+        StatusWriter::writeNewline();
+
+        StatusWriter::pause();
+        $this->assertTrue(StatusWriter::isPaused());
+
+        // As the StatusWriter is paused, only the force printed new line should print, the other one should be ignored.
+        StatusWriter::writeNewline();
+        StatusWriter::forceWriteNewline();
+
+        $this->assertStderrOutputSameString(PHP_EOL.PHP_EOL);
+
+    }//end testWriteNewline()
+
+
     /**
      * Verify that the StatusWriter only resumes when all previous "pause" calls are rescinded.
      *