Fix Command-Descriptions

README.md

@@ -32,6 +32,7 @@ This tool uses [a php parser written in php](https://github.com/nikic/PHP-Parser
 - Find Classes/Functions with the highest cyclomatic complexity
 - Halstead-Metrics
 - Most Used Constants (Order by name or value)
+- IDE-Integration (PHPStorm)
 
 ## Contributing
 Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

src/Console/AbstractCommand.php

@@ -141,19 +141,19 @@ abstract class AbstractCommand extends Command
     private const FORMAT_PATH_LINE = '%s:%s';
 
     /** @var string */
-    protected const FORMAT_PROCESSORS_DONE_MESSAGE = 'Processors processed magic numbers. Magic numbers found: %d';
+    protected const FORMAT_PROCESSORS_DONE_MESSAGE = '';
 
     /** @var string */
-    protected const FORMAT_PROCESSORS_PROGRESS_MESSAGE = 'Processor %d is processing magic numbers. Magic numbers found: %d'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded
+    protected const FORMAT_PROCESSORS_PROGRESS_MESSAGE = '';
 
     /** @var string */
-    private const FORMAT_TO_LINE = '%s%s'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded
+    private const FORMAT_TO_LINE = '%s%s';
 
     /** @var string */
-    private const FORMAT_VISITORS_DONE_MESSAGE = 'Visitors checked magic numbers in %d files. Magic numbers found: %d';
+    protected const FORMAT_VISITORS_DONE_MESSAGE = '';
 
     /** @var string */
-    private const FORMAT_VISITORS_PROGRESS_MESSAGE = 'Visitors are checking for magic numbers in files. Magic numbers found: %d'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded
+    protected const FORMAT_VISITORS_PROGRESS_MESSAGE = '';
 
     /** @var string */
     private const LINE_SEPARATOR = '-'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded
@@ -431,7 +431,7 @@ protected function parseFiles(array $files, Traverser $traverser, ProgressBar $t
             $traverser->setFile($file);
             $traverser->traverse($ast);
             $traverserProgressBar->setMessage(sprintf(
-                self::FORMAT_VISITORS_PROGRESS_MESSAGE,
+                static::FORMAT_VISITORS_PROGRESS_MESSAGE,
                 $traverser->getNodeOccurrencesCount()
             ));
         }
@@ -501,15 +501,15 @@ protected function processOccurrences(
 
         foreach ($this->processorRunner->process($occurrenceList) as $processorsDone) {
             $processorsProgressBar->setMessage(sprintf(
-                self::FORMAT_PROCESSORS_PROGRESS_MESSAGE,
+                static::FORMAT_PROCESSORS_PROGRESS_MESSAGE,
                 $processorsDone,
                 count($occurrenceList->getOccurrences())
             ));
             $processorsProgressBar->advance();
         }
 
         $processorsProgressBar->setMessage(sprintf(
-            self::FORMAT_PROCESSORS_DONE_MESSAGE,
+            static::FORMAT_PROCESSORS_DONE_MESSAGE,
             count($occurrenceList->getOccurrences())
         ));
         $this->finishProgressBar($processorsProgressBar, $output);
@@ -564,7 +564,7 @@ protected function traverseFiles(
         $this->parseFiles($files, $traverser, $traverserProgressBar);
 
         $traverserProgressBar->setMessage(sprintf(
-            self::FORMAT_VISITORS_DONE_MESSAGE,
+            static::FORMAT_VISITORS_DONE_MESSAGE,
             count($files),
             $traverser->getNodeOccurrencesCount()
         ));

src/Console/Application.php

@@ -22,7 +22,7 @@ class Application extends BaseApplication
     private const APPLICATION_NAME = 'php-analyzer';
 
     /** @var string */
-    private const APPLICATION_VERSION = '1.2.4';
+    private const APPLICATION_VERSION = '1.2.5';
 
     /** @var string */
     private const ARGUMENT_HELP = 'help';

src/Console/Command/MagicNumberDetectorCommand.php

@@ -39,6 +39,18 @@ class MagicNumberDetectorCommand extends AbstractCommand
     /** @var string */
     private const DEFAULT_VISITORS = 'Argument,Array,Assign,Condition,DefaultParameter,Operation,Property,Return,SwitchCase,Ternary'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded
 
+    /** @var string */
+    protected const FORMAT_PROCESSORS_DONE_MESSAGE = 'Processors processed magic numbers. Magic numbers found: %d';
+
+    /** @var string */
+    protected const FORMAT_PROCESSORS_PROGRESS_MESSAGE = 'Processor %d is processing magic numbers. Magic numbers found: %d'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded
+
+    /** @var string */
+    protected const FORMAT_VISITORS_DONE_MESSAGE = 'Visitors checked magic numbers in %d files. Magic numbers found: %d'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded
+
+    /** @var string */
+    protected const FORMAT_VISITORS_PROGRESS_MESSAGE = 'Visitors are checking for magic numbers in files. Magic numbers found: %d'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded
+
     /** @var string */
     private const HEADER_NUMBER = 'Number';
 

src/Console/Command/MagicStringDetectorCommand.php

@@ -38,6 +38,18 @@ class MagicStringDetectorCommand extends AbstractCommand
     /** @var string */
     private const DEFAULT_VISITORS = 'Argument,Array,Assign,Condition,DefaultParameter,Operation,Property,Return,SwitchCase,Ternary'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded
 
+    /** @var string */
+    protected const FORMAT_PROCESSORS_DONE_MESSAGE = 'Processors processed magic strings. Magic strings found: %d';
+
+    /** @var string */
+    protected const FORMAT_PROCESSORS_PROGRESS_MESSAGE = 'Processor %d is processing magic strings. Magic strings found: %d'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded
+
+    /** @var string */
+    protected const FORMAT_VISITORS_DONE_MESSAGE = 'Visitors checked magic strings in %d files. Magic strings found: %d'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded
+
+    /** @var string */
+    protected const FORMAT_VISITORS_PROGRESS_MESSAGE = 'Visitors are checking for magic strings in files. Magic strings found: %d'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded
+
     /** @var string */
     private const HEADER_OCCURRENCE = 'Occurrence';
 

src/Console/Command/MostUsedConditionsCommand.php

@@ -123,6 +123,12 @@ class MostUsedConditionsCommand extends AbstractCommand
     /** @var string */
     private const FORMAT_OCCURRENCE = '%s <flag>%s</flag><special-info>%s</special-info>';
 
+    /** @var string */
+    protected const FORMAT_PROCESSORS_DONE_MESSAGE = 'Processors processed conditions. Conditions found: %d';
+
+    /** @var string */
+    protected const FORMAT_PROCESSORS_PROGRESS_MESSAGE = 'Processor %d is processing conditions. Conditions found: %d'; //phpcs:ignore Generic.Files.LineLength.MaxExceeded
+
     /** @var string */
     private const FORMAT_TABLE_INFO_MAX_ENTRIES = '<info>Showing maximum %d conditions.</info>';
 
@@ -132,6 +138,12 @@ class MostUsedConditionsCommand extends AbstractCommand
     /** @var string */
     private const FORMAT_TABLE_INFO_SORT_BY = '<info>Sort Conditions by number of occurrences %s.</info>';
 
+    /** @var string */
+    protected const FORMAT_VISITORS_DONE_MESSAGE = 'Visitors checked conditions in %d files. Conditions found: %d'; //phpcs:ignore Generic.Files.LineLength.MaxExceeded
+
+    /** @var string */
+    protected const FORMAT_VISITORS_PROGRESS_MESSAGE = 'Visitors are checking for conditions in files. Conditions found: %d'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded
+
     /** @var string */
     private const HEADER_CONDITION = 'Condition';
 

tests/Integration/Console/ApplicationTest.php

@@ -14,7 +14,7 @@
 class ApplicationTest extends TestCase
 {
     /** @var string */
-    private const APPLICATION_INFO = 'php-analyzer 1.2.4 by Christopher Stenke <chris@isfett.com>' . \PHP_EOL;
+    private const APPLICATION_INFO = 'php-analyzer 1.2.5 by Christopher Stenke <chris@isfett.com>' . \PHP_EOL;
 
     /** @var Application */
     private $application;

tests/Integration/Console/Command/MagicNumberDetectorCommandTest.php

@@ -73,6 +73,7 @@ public function testRun(): void
             '<command-start>Starting magic-number-detector command</command-start>',
             $outputText
         );
+        $this->assertStringContainsString('Processors processed magic numbers. Magic numbers found:', $outputText);
 
         $expectedOutput = <<<EOT
 +--------------------------------------------------------------+----------------------------------------------+

tests/Integration/Console/Command/MagicStringDetectorCommandTest.php

@@ -74,6 +74,7 @@ public function testRun(): void
             '<command-start>Starting magic-string-detector command</command-start>',
             $outputText
         );
+        $this->assertStringContainsString('Processors processed magic strings. Magic strings found:', $outputText);
 
         $expectedOutput = <<<EOT
 +--------------------------------------------------------------+----------------------------------------------+

tests/Integration/Console/Command/MostUsedConditionsCommandTest.php

@@ -76,6 +76,7 @@ public function testRun(): void
             '<command-start>Starting most-used-conditions command</command-start>',
             $outputText
         );
+        $this->assertStringContainsString('Processors processed conditions. Conditions found:', $outputText);
 
         $expectedOutput = <<<EOT
 +-----------------------------------------------------------------------------------------------------------------------------------------+-------+