Merge branch 'master' into shepherd-use-list-of-issues

# Conflicts: # src/Psalm/Plugin/Shepherd.php
alies-dev · May 31, 2023 · 5e7e067 · 5e7e067
2 parents 2fa943a + 5b2efad
commit 5e7e067
Show file tree

Hide file tree

Showing 17 changed files with 70 additions and 47 deletions.
diff --git a/src/Psalm/Internal/Analyzer/IssueData.php b/src/Psalm/Internal/Analyzer/IssueData.php
@@ -11,6 +11,12 @@
  */
 class IssueData
 {
+    public const SEVERITY_INFO = 'info';
+    public const SEVERITY_ERROR = 'error';
+
+    /**
+     * @var self::SEVERITY_*
+     */
     public string $severity;
 
     public int $line_from;
@@ -93,6 +99,7 @@ class IssueData
     public ?string $dupe_key = null;
 
     /**
+     * @param self::SEVERITY_* $severity
      * @param ?list<DataFlowNodeData|array{label: string, entry_path_type: string}> $taint_trace
      * @param ?list<DataFlowNodeData> $other_references
      */

diff --git a/src/Psalm/Internal/Cli/Psalm.php b/src/Psalm/Internal/Cli/Psalm.php
@@ -403,7 +403,20 @@ private static function initOutputFormat(array $options): string
     {
         return isset($options['output-format']) && is_string($options['output-format'])
             ? $options['output-format']
-            : Report::TYPE_CONSOLE;
+            : self::findDefaultOutputFormat();
+    }
+
+    /**
+     * @return Report::TYPE_*
+     */
+    private static function findDefaultOutputFormat(): string
+    {
+        $emulator = getenv('TERMINAL_EMULATOR');
+        if (is_string($emulator) && substr($emulator, 0, 9) === 'JetBrains') {
+            return Report::TYPE_PHP_STORM;
+        }
+
+        return Report::TYPE_CONSOLE;
     }
 
     private static function initShowInfo(array $options): bool

diff --git a/src/Psalm/Internal/Codebase/Analyzer.php b/src/Psalm/Internal/Codebase/Analyzer.php
@@ -1552,13 +1552,13 @@ private function taskDoneClosure(array $issues): void
         $has_info = false;
 
         foreach ($issues as $issue) {
-            if ($issue->severity === 'error') {
-                $has_error = true;
-                break;
-            }
-
-            if ($issue->severity === 'info') {
-                $has_info = true;
+            switch ($issue->severity) {
+                case IssueData::SEVERITY_INFO:
+                    $has_info = true;
+                    break;
+                default:
+                    $has_error = true;
+                    break;
             }
         }
 

diff --git a/src/Psalm/Internal/LanguageServer/LanguageServer.php b/src/Psalm/Internal/LanguageServer/LanguageServer.php
@@ -728,10 +728,9 @@ function (IssueData $issue_data): Diagnostic {
                         new Position($end_line - 1, $end_column - 1),
                     );
                     switch ($severity) {
-                        case Config::REPORT_INFO:
+                        case IssueData::SEVERITY_INFO:
                             $diagnostic_severity = DiagnosticSeverity::WARNING;
                             break;
-                        case Config::REPORT_ERROR:
                         default:
                             $diagnostic_severity = DiagnosticSeverity::ERROR;
                             break;
@@ -788,7 +787,7 @@ function (IssueData $issue_data): Diagnostic {
                                 );
 
                                 if ($position !== false) {
-                                    $issue_data->severity = Config::REPORT_INFO;
+                                    $issue_data->severity = IssueData::SEVERITY_INFO;
                                     /** @psalm-suppress MixedArgument */
                                     array_splice($issue_baseline[$file][$type]['s'], $position, 1);
                                     /** @psalm-suppress MixedArrayAssignment, MixedOperand, MixedAssignment */
@@ -797,7 +796,7 @@ function (IssueData $issue_data): Diagnostic {
                             } else {
                                 /** @psalm-suppress MixedArrayAssignment */
                                 $issue_baseline[$file][$type]['s'] = [];
-                                $issue_data->severity = Config::REPORT_INFO;
+                                $issue_data->severity = IssueData::SEVERITY_INFO;
                                 /** @psalm-suppress MixedArrayAssignment, MixedOperand, MixedAssignment */
                                 $issue_baseline[$file][$type]['o']--;
                             }
@@ -806,7 +805,7 @@ function (IssueData $issue_data): Diagnostic {
                     }, $data[$file_path] ?? []),
                     function (IssueData $issue_data) {
                         //Hide Warnings
-                        if ($issue_data->severity === Config::REPORT_INFO &&
+                        if ($issue_data->severity === IssueData::SEVERITY_INFO &&
                             $this->client->clientConfiguration->hideWarnings
                         ) {
                             return false;

diff --git a/src/Psalm/Issue/CodeIssue.php b/src/Psalm/Issue/CodeIssue.php
@@ -68,6 +68,9 @@ public static function getIssueType(): string
         return array_pop($fqcn_parts);
     }
 
+    /**
+     * @param IssueData::SEVERITY_* $severity
+     */
     public function toIssueData(string $severity): IssueData
     {
         $location = $this->code_location;

diff --git a/src/Psalm/IssueBuffer.php b/src/Psalm/IssueBuffer.php
@@ -302,7 +302,7 @@ public static function add(CodeIssue $e, bool $is_fixable = false): bool
 
         if ($reporting_level === Config::REPORT_INFO) {
             if ($is_tainted || !self::alreadyEmitted($emitted_key)) {
-                self::$issues_data[$e->getFilePath()][] = $e->toIssueData(Config::REPORT_INFO);
+                self::$issues_data[$e->getFilePath()][] = $e->toIssueData(IssueData::SEVERITY_INFO);
 
                 if ($is_fixable) {
                     self::addFixableIssue($issue_type);
@@ -331,7 +331,7 @@ public static function add(CodeIssue $e, bool $is_fixable = false): bool
 
         if ($is_tainted || !self::alreadyEmitted($emitted_key)) {
             ++self::$error_count;
-            self::$issues_data[$e->getFilePath()][] = $e->toIssueData(Config::REPORT_ERROR);
+            self::$issues_data[$e->getFilePath()][] = $e->toIssueData(IssueData::SEVERITY_ERROR);
 
             if ($is_fixable) {
                 self::addFixableIssue($issue_type);
@@ -598,13 +598,13 @@ public static function finish(
                                 );
 
                                 if ($position !== false) {
-                                    $issue_data->severity = Config::REPORT_INFO;
+                                    $issue_data->severity = IssueData::SEVERITY_INFO;
                                     array_splice($issue_baseline[$file][$type]['s'], $position, 1);
                                     $issue_baseline[$file][$type]['o']--;
                                 }
                             } else {
                                 $issue_baseline[$file][$type]['s'] = [];
-                                $issue_data->severity = Config::REPORT_INFO;
+                                $issue_data->severity = IssueData::SEVERITY_INFO;
                                 $issue_baseline[$file][$type]['o']--;
                             }
                         }
@@ -618,7 +618,7 @@ public static function finish(
                         foreach ($issues as $issue_name => $issue) {
                             if ($issue['o'] !== 0) {
                                 $issues_data[$file_path][] = new IssueData(
-                                    Config::REPORT_ERROR,
+                                    IssueData::SEVERITY_ERROR,
                                     0,
                                     0,
                                     UnusedBaselineEntry::getIssueType(),

diff --git a/src/Psalm/Plugin/Shepherd.php b/src/Psalm/Plugin/Shepherd.php
@@ -123,7 +123,7 @@ private static function collectPayloadToSend(AfterAnalysisEvent $event): ?array
         $issues = $event->getIssues();
         $normalized_data = $issues === [] ? [] : array_values(array_filter(
             array_merge(...array_values($issues)), // flatten an array
-            static fn(IssueData $i): bool => $i->severity === 'error',
+            static fn(IssueData $i): bool => $i->severity === IssueData::SEVERITY_ERROR,
         ));
 
         $codebase = $event->getCodebase();

diff --git a/src/Psalm/Report.php b/src/Psalm/Report.php
@@ -74,7 +74,7 @@ public function __construct(
         if (!$report_options->show_info) {
             $this->issues_data = array_filter(
                 $issues_data,
-                static fn(IssueData $issue_data): bool => $issue_data->severity !== Config::REPORT_INFO,
+                static fn(IssueData $issue_data): bool => $issue_data->severity !== IssueData::SEVERITY_INFO,
             );
         } else {
             $this->issues_data = $issues_data;

diff --git a/src/Psalm/Report/CompactReport.php b/src/Psalm/Report/CompactReport.php
@@ -3,6 +3,7 @@
 namespace Psalm\Report;
 
 use Psalm\Config;
+use Psalm\Internal\Analyzer\IssueData;
 use Psalm\Report;
 use Symfony\Component\Console\Helper\Table;
 use Symfony\Component\Console\Output\BufferedOutput;
@@ -31,7 +32,7 @@ public function create(): string
 
         $output = [];
         foreach ($this->issues_data as $i => $issue_data) {
-            if (!$this->show_info && $issue_data->severity === Config::REPORT_INFO) {
+            if (!$this->show_info && $issue_data->severity === IssueData::SEVERITY_INFO) {
                 continue;
             }
 

diff --git a/src/Psalm/Report/EmacsReport.php b/src/Psalm/Report/EmacsReport.php
@@ -2,7 +2,7 @@
 
 namespace Psalm\Report;
 
-use Psalm\Config;
+use Psalm\Internal\Analyzer\IssueData;
 use Psalm\Report;
 
 use function sprintf;
@@ -18,7 +18,7 @@ public function create(): string
                 $issue_data->file_path,
                 $issue_data->line_from,
                 $issue_data->column_from,
-                ($issue_data->severity === Config::REPORT_ERROR ? 'error' : 'warning'),
+                ($issue_data->severity === IssueData::SEVERITY_ERROR ? 'error' : 'warning'),
                 $issue_data->type,
                 $issue_data->message,
                 $issue_data->link,

diff --git a/src/Psalm/Report/GithubActionsReport.php b/src/Psalm/Report/GithubActionsReport.php
@@ -2,7 +2,7 @@
 
 namespace Psalm\Report;
 
-use Psalm\Config;
+use Psalm\Internal\Analyzer\IssueData;
 use Psalm\Report;
 
 use function sprintf;
@@ -34,7 +34,7 @@ public function create(): string
 
             $output .= sprintf(
                 '::%1$s %2$s::%3$s',
-                ($issue_data->severity === Config::REPORT_ERROR ? 'error' : 'warning'),
+                ($issue_data->severity === IssueData::SEVERITY_ERROR ? 'error' : 'warning'),
                 $properties,
                 $data,
             ) . "\n";

diff --git a/src/Psalm/Report/JunitReport.php b/src/Psalm/Report/JunitReport.php
@@ -27,8 +27,8 @@ public function create(): string
         $ndata = [];
 
         foreach ($this->issues_data as $error) {
-            $is_error = $error->severity === Config::REPORT_ERROR;
-            $is_warning = $error->severity === Config::REPORT_INFO;
+            $is_error = $error->severity === IssueData::SEVERITY_ERROR;
+            $is_warning = $error->severity === IssueData::SEVERITY_INFO;
 
             if (!$is_error && !$is_warning) {
                 continue;

diff --git a/src/Psalm/Report/TextReport.php b/src/Psalm/Report/TextReport.php
@@ -2,7 +2,7 @@
 
 namespace Psalm\Report;
 
-use Psalm\Config;
+use Psalm\Internal\Analyzer\IssueData;
 use Psalm\Report;
 
 use function sprintf;
@@ -18,7 +18,7 @@ public function create(): string
                 $issue_data->file_path,
                 $issue_data->line_from,
                 $issue_data->column_from,
-                ($issue_data->severity === Config::REPORT_ERROR ? 'error' : 'warning'),
+                ($issue_data->severity === IssueData::SEVERITY_ERROR ? 'error' : 'warning'),
                 $issue_data->type,
                 $issue_data->message,
             ) . "\n";

diff --git a/tests/ByIssueLevelAndTypeReportTest.php b/tests/ByIssueLevelAndTypeReportTest.php
@@ -75,7 +75,7 @@ public function testItGeneratesReport(): void
     private function issueData(int $errorLevel, string $type): IssueData
     {
         return new IssueData(
-            'error',
+            IssueData::SEVERITY_ERROR,
             1,
             1,
             $type,

diff --git a/tests/ErrorBaselineTest.php b/tests/ErrorBaselineTest.php
@@ -187,7 +187,7 @@ public function testCreateShouldAggregateIssuesPerFile(): void
             [
                 'sample/sample-file.php' => [
                     new IssueData(
-                        'error',
+                        IssueData::SEVERITY_ERROR,
                         0,
                         0,
                         'MixedAssignment',
@@ -204,7 +204,7 @@ public function testCreateShouldAggregateIssuesPerFile(): void
                         0,
                     ),
                     new IssueData(
-                        'error',
+                        IssueData::SEVERITY_ERROR,
                         0,
                         0,
                         'MixedAssignment',
@@ -221,7 +221,7 @@ public function testCreateShouldAggregateIssuesPerFile(): void
                         0,
                     ),
                     new IssueData(
-                        'error',
+                        IssueData::SEVERITY_ERROR,
                         0,
                         0,
                         'MixedAssignment',
@@ -238,7 +238,7 @@ public function testCreateShouldAggregateIssuesPerFile(): void
                         0,
                     ),
                     new IssueData(
-                        'error',
+                        IssueData::SEVERITY_ERROR,
                         0,
                         0,
                         'MixedOperand',
@@ -274,7 +274,7 @@ public function testCreateShouldAggregateIssuesPerFile(): void
                 ],
                 'sample/sample-file2.php' => [
                     new IssueData(
-                        'error',
+                        IssueData::SEVERITY_ERROR,
                         0,
                         0,
                         'MixedAssignment',
@@ -291,7 +291,7 @@ public function testCreateShouldAggregateIssuesPerFile(): void
                         0,
                     ),
                     new IssueData(
-                        'error',
+                        IssueData::SEVERITY_ERROR,
                         0,
                         0,
                         'MixedAssignment',
@@ -308,7 +308,7 @@ public function testCreateShouldAggregateIssuesPerFile(): void
                         0,
                     ),
                     new IssueData(
-                        'error',
+                        IssueData::SEVERITY_ERROR,
                         0,
                         0,
                         'TypeCoercion',
@@ -410,7 +410,7 @@ public function testUpdateShouldRemoveExistingIssuesWithoutAddingNewOnes(): void
         $newIssues = [
             'sample/sample-file.php' => [
                 new IssueData(
-                    'error',
+                    IssueData::SEVERITY_ERROR,
                     0,
                     0,
                     'MixedAssignment',
@@ -427,7 +427,7 @@ public function testUpdateShouldRemoveExistingIssuesWithoutAddingNewOnes(): void
                     0,
                 ),
                 new IssueData(
-                    'error',
+                    IssueData::SEVERITY_ERROR,
                     0,
                     0,
                     'MixedAssignment',
@@ -444,7 +444,7 @@ public function testUpdateShouldRemoveExistingIssuesWithoutAddingNewOnes(): void
                     0,
                 ),
                 new IssueData(
-                    'error',
+                    IssueData::SEVERITY_ERROR,
                     0,
                     0,
                     'MixedOperand',
@@ -461,7 +461,7 @@ public function testUpdateShouldRemoveExistingIssuesWithoutAddingNewOnes(): void
                     0,
                 ),
                 new IssueData(
-                    'error',
+                    IssueData::SEVERITY_ERROR,
                     0,
                     0,
                     'MixedOperand',
@@ -480,7 +480,7 @@ public function testUpdateShouldRemoveExistingIssuesWithoutAddingNewOnes(): void
             ],
             'sample/sample-file2.php' => [
                 new IssueData(
-                    'error',
+                    IssueData::SEVERITY_ERROR,
                     0,
                     0,
                     'TypeCoercion',