Add quit shortcut

danog · danog · commit bca86cf11bd3 · 2025-02-03T20:31:29.000+01:00
diff --git a/docs/running_psalm/command_line_usage.md b/docs/running_psalm/command_line_usage.md
@@ -54,7 +54,7 @@ Psalm now offers a `psalm-review` tool which allows you to manually review issue
 ./vendor/bin/psalm-review report.json code|phpstorm|code-server [ inv|rev|[~-]IssueType1 ] [ [~-]IssueType2 ] ...
 ```
 
-`psalm-review` parse the Psalm JSON report in report.json (generated using `vendor/bin/psalm --report=report.json`) and open the specified IDE at the line and column of the issue, one by one for all issues; press enter to go to the next issue.  
+`psalm-review` parse the Psalm JSON report in report.json (generated using `vendor/bin/psalm --report=report.json`) and open the specified IDE at the line and column of the issue, one by one for all issues; press enter to go to the next issue, `q` to quit.  
 
 The extra arguments may be used to filter only for issues of the specified types, or for all issues except the specified types (with the `~` or `-` inversion).  
 
diff --git a/src/Psalm/Internal/Cli/Review.php b/src/Psalm/Internal/Cli/Review.php
@@ -33,6 +33,7 @@
 use function strlen;
 use function strpos;
 use function substr;
+use function trim;
 
 use const JSON_THROW_ON_ERROR;
 use const PHP_EOL;
@@ -151,7 +152,11 @@ public static function run(array $argv): void
             echo PHP_EOL;
         
             self::r($mode($file, $line, $column));
-            readline();
+
+            /** @psalm-suppress RiskyTruthyFalsyComparison */
+            if (trim(readline("Press enter to continue, q to exit.") ?: '') === 'q') {
+                break;
+            }
         }
     }
 
@@ -164,7 +169,7 @@ private static function help(): never
                 "Will parse the Psalm JSON report in report.json ".
                 "and open the specified IDE at the line and column of the issue, ".
                 "one by one for all issues.".PHP_EOL.
-                "Press enter to go to the next issue.".PHP_EOL.PHP_EOL.
+                "Press enter to go to the next issue, q to quit.".PHP_EOL.PHP_EOL.
                 "The extra arguments may be used to filter only for issues of the specified types, ".
                 "or for all issues except the specified types (with the ~ or - inversion);".PHP_EOL.
                 "rev|inv keywords may be used to start from the end of the report.".PHP_EOL.PHP_EOL,
