Merge pull request #11000 from llaville/dynamic-help-text

Update help panel
vimeo · Jun 4, 2024 · d77790b · d77790b
2 parents 0294324 + bce59cf
commit d77790b
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 19 deletions.
diff --git a/src/Psalm/Internal/Analyzer/ProjectAnalyzer.php b/src/Psalm/Internal/Analyzer/ProjectAnalyzer.php
@@ -329,21 +329,7 @@ public static function getFileReportOptions(array $report_file_paths, bool $show
     {
         $report_options = [];
 
-        $mapping = [
-            'checkstyle.xml' => Report::TYPE_CHECKSTYLE,
-            'sonarqube.json' => Report::TYPE_SONARQUBE,
-            'codeclimate.json' => Report::TYPE_CODECLIMATE,
-            'summary.json' => Report::TYPE_JSON_SUMMARY,
-            'junit.xml' => Report::TYPE_JUNIT,
-            '.xml' => Report::TYPE_XML,
-            '.json' => Report::TYPE_JSON,
-            '.txt' => Report::TYPE_TEXT,
-            '.emacs' => Report::TYPE_EMACS,
-            '.pylint' => Report::TYPE_PYLINT,
-            '.console' => Report::TYPE_CONSOLE,
-            '.sarif' => Report::TYPE_SARIF,
-            'count.txt' => Report::TYPE_COUNT,
-        ];
+        $mapping = Report::getMapping();
 
         foreach ($report_file_paths as $report_file_path) {
             foreach ($mapping as $extension => $type) {

diff --git a/src/Psalm/Internal/Cli/Psalm.php b/src/Psalm/Internal/Cli/Psalm.php
@@ -31,11 +31,13 @@
 use Psalm\Progress\VoidProgress;
 use Psalm\Report;
 use Psalm\Report\ReportOptions;
+use ReflectionClass;
 use RuntimeException;
 use Symfony\Component\Filesystem\Path;
 
 use function array_filter;
 use function array_key_exists;
+use function array_keys;
 use function array_map;
 use function array_merge;
 use function array_slice;
@@ -67,11 +69,13 @@
 use function preg_replace;
 use function realpath;
 use function setlocale;
+use function sort;
 use function str_repeat;
 use function str_replace;
 use function strlen;
 use function strpos;
 use function substr;
+use function wordwrap;
 
 use const DIRECTORY_SEPARATOR;
 use const JSON_THROW_ON_ERROR;
@@ -87,6 +91,7 @@
 require_once __DIR__ . '/../Composer.php';
 require_once __DIR__ . '/../IncludeCollector.php';
 require_once __DIR__ . '/../../IssueBuffer.php';
+require_once __DIR__ . '/../../Report.php';
 
 /**
  * @internal
@@ -1250,6 +1255,21 @@ private static function generateStubs(
      */
     private static function getHelpText(): string
     {
+        $formats = [];
+        /** @var string $value */
+        foreach ((new ReflectionClass(Report::class))->getConstants() as $constant => $value) {
+            if (strpos($constant, 'TYPE_') === 0) {
+                $formats[] = $value;
+            }
+        }
+        sort($formats);
+        $outputFormats = wordwrap(implode(', ', $formats), 75, "\n            ");
+
+        /** @psalm-suppress ImpureMethodCall */
+        $reports = array_keys(Report::getMapping());
+        sort($reports);
+        $reportFormats = wordwrap('"' . implode('", "', $reports) . '"', 75, "\n        ");
+
         return <<<HELP
         Usage:
             psalm [options] [file...]
@@ -1333,8 +1353,8 @@ private static function getHelpText(): string
 
             --output-format=console
                 Changes the output format.
-                Available formats: compact, console, text, emacs, json, pylint, xml, checkstyle, junit, sonarqube,
-                                   github, phpstorm, codeclimate, by-issue-level
+                Available formats:
+                    $outputFormats
 
             --no-progress
                 Disable the progress indicator
@@ -1348,8 +1368,7 @@ private static function getHelpText(): string
         Reports:
             --report=PATH
                 The path where to output report file. The output format is based on the file extension.
-                (Currently supported formats: ".json", ".xml", ".txt", ".emacs", ".pylint", ".console",
-                ".sarif", "checkstyle.xml", "sonarqube.json", "codeclimate.json", "summary.json", "junit.xml")
+                (Currently supported formats: $reportFormats)
 
             --report-show-info[=BOOLEAN]
                 Whether the report should include non-errors in its output (defaults to true)

diff --git a/src/Psalm/Report.php b/src/Psalm/Report.php
@@ -97,4 +97,27 @@ protected function xmlEncode(string $data): string
     }
 
     abstract public function create(): string;
+
+    /**
+     * @return array<string, self::TYPE_*>
+     */
+    public static function getMapping(): array
+    {
+        return [
+            'checkstyle.xml' => self::TYPE_CHECKSTYLE,
+            'sonarqube.json' => self::TYPE_SONARQUBE,
+            'codeclimate.json' => self::TYPE_CODECLIMATE,
+            'summary.json' => self::TYPE_JSON_SUMMARY,
+            'junit.xml' => self::TYPE_JUNIT,
+            '.xml' => self::TYPE_XML,
+            '.sarif.json' => self::TYPE_SARIF,
+            '.json' => self::TYPE_JSON,
+            '.txt' => self::TYPE_TEXT,
+            '.emacs' => self::TYPE_EMACS,
+            '.pylint' => self::TYPE_PYLINT,
+            '.console' => self::TYPE_CONSOLE,
+            '.sarif' => self::TYPE_SARIF,
+            'count.txt' => self::TYPE_COUNT,
+        ];
+    }
 }