From b70d3e228e885ee873514d6c5255ac52c4514658 Mon Sep 17 00:00:00 2001
From: Barney Laurance <barney@redmagic.org.uk>
Date: Sat, 26 Nov 2022 22:31:12 +0000
Subject: [PATCH 01/18] WIP: Add new option --output-format=by-issue-severity
 to sort issues by level and type

---
 src/Psalm/IssueBuffer.php                  |   5 +
 src/Psalm/Report.php                       |   1 +
 src/Psalm/Report/ByIssueSeverityReport.php | 192 +++++++++++++++++++++
 3 files changed, 198 insertions(+)
 create mode 100644 src/Psalm/Report/ByIssueSeverityReport.php

diff --git a/src/Psalm/IssueBuffer.php b/src/Psalm/IssueBuffer.php
index b1750133ce6..515402feeeb 100644
--- a/src/Psalm/IssueBuffer.php
+++ b/src/Psalm/IssueBuffer.php
@@ -17,6 +17,7 @@
 use Psalm\Issue\UnusedPsalmSuppress;
 use Psalm\Plugin\EventHandler\Event\AfterAnalysisEvent;
 use Psalm\Plugin\EventHandler\Event\BeforeAddIssueEvent;
+use Psalm\Report\ByIssueSeverityReport;
 use Psalm\Report\CheckstyleReport;
 use Psalm\Report\CodeClimateReport;
 use Psalm\Report\CompactReport;
@@ -854,6 +855,10 @@ public static function getOutput(
                 $output = new JsonReport($normalized_data, self::$fixable_issue_counts, $report_options);
                 break;
 
+            case Report::TYPE_BY_ISSUE_SEVERITY:
+                $output = new ByIssueSeverityReport($normalized_data, self::$fixable_issue_counts, $report_options);
+                break;
+
             case Report::TYPE_JSON_SUMMARY:
                 $output = new JsonSummaryReport(
                     $normalized_data,
diff --git a/src/Psalm/Report.php b/src/Psalm/Report.php
index a56469af089..3d2c9a4633b 100644
--- a/src/Psalm/Report.php
+++ b/src/Psalm/Report.php
@@ -29,6 +29,7 @@ abstract class Report
     public const TYPE_SARIF = 'sarif';
     public const TYPE_CODECLIMATE = 'codeclimate';
     public const TYPE_COUNT = 'count';
+    const TYPE_BY_ISSUE_SEVERITY = 'by-issue-severity';
 
     /**
      * @var array<int, IssueData>
diff --git a/src/Psalm/Report/ByIssueSeverityReport.php b/src/Psalm/Report/ByIssueSeverityReport.php
new file mode 100644
index 00000000000..02116c32393
--- /dev/null
+++ b/src/Psalm/Report/ByIssueSeverityReport.php
@@ -0,0 +1,192 @@
+<?php
+
+namespace Psalm\Report;
+
+use Psalm\Config;
+use Psalm\Internal\Analyzer\DataFlowNodeData;
+use Psalm\Internal\Analyzer\IssueData;
+use Psalm\Report;
+
+use function basename;
+use function get_cfg_var;
+use function ini_get;
+use function strlen;
+use function strtr;
+use function substr;
+use function usort;
+
+final class ByIssueSeverityReport extends Report
+{
+    /** @var string|null */
+    private $link_format;
+
+    public function create(): string
+    {
+        $this->sortIssuesByLevelAndType();
+
+        $output = '';
+
+        foreach ($this->issues_data as $issue_data) {
+            $output .= $this->format($issue_data) . "\n" . "\n";
+        }
+
+        return $output;
+    }
+
+    private function format(IssueData $issue_data): string
+    {
+        $issue_string = '';
+
+        $is_error = $issue_data->severity === Config::REPORT_ERROR;
+
+        if ($is_error) {
+            $issue_string .= ($this->use_color ? "\e[0;31mERROR\e[0m" : 'ERROR');
+        } else {
+            $issue_string .= 'INFO';
+        }
+
+        $issue_reference = $issue_data->link ? ' (see ' . $issue_data->link . ')' : '';
+
+        $issue_string .= " ($issue_data->error_level): "
+            . $issue_data->type
+            . ' - ' . $this->getFileReference($issue_data)
+            . ' - ' . $issue_data->message . $issue_reference . "\n";
+
+
+        if ($issue_data->taint_trace) {
+            $issue_string .= $this->getTaintSnippets($issue_data->taint_trace);
+        } elseif ($this->show_snippet) {
+            $snippet = $issue_data->snippet;
+
+            if (!$this->use_color) {
+                $issue_string .= $snippet;
+            } else {
+                $selection_start = $issue_data->from - $issue_data->snippet_from;
+                $selection_length = $issue_data->to - $issue_data->from;
+
+                $issue_string .= substr($snippet, 0, $selection_start)
+                    . ($is_error ? "\e[97;41m" : "\e[30;47m") . substr($snippet, $selection_start, $selection_length)
+                    . "\e[0m" . substr($snippet, $selection_length + $selection_start) . "\n";
+            }
+        }
+
+        if ($issue_data->other_references) {
+            if ($this->show_snippet) {
+                $issue_string .= "\n";
+            }
+
+            $issue_string .= $this->getTaintSnippets($issue_data->other_references);
+        }
+
+        return $issue_string;
+    }
+
+    /**
+     * @param non-empty-list<DataFlowNodeData|array{label: string, entry_path_type: string}> $taint_trace
+     */
+    private function getTaintSnippets(array $taint_trace): string
+    {
+        $snippets = '';
+
+        foreach ($taint_trace as $node_data) {
+            if ($node_data instanceof DataFlowNodeData) {
+                $snippets .= '  ' . $node_data->label . ' - ' . $this->getFileReference($node_data) . "\n";
+
+                if ($this->show_snippet) {
+                    $snippet = $node_data->snippet;
+
+                    if (!$this->use_color) {
+                        $snippets .= $snippet . "\n\n";
+                    } else {
+                        $selection_start = $node_data->from - $node_data->snippet_from;
+                        $selection_length = $node_data->to - $node_data->from;
+
+                        $snippets .= substr($snippet, 0, $selection_start)
+                            . "\e[30;47m" . substr($snippet, $selection_start, $selection_length)
+                            . "\e[0m" . substr($snippet, $selection_length + $selection_start) . "\n\n";
+                    }
+                }
+            } else {
+                $snippets .= '  ' . $node_data['label'] . "\n";
+                $snippets .= '    <no known location>' . "\n\n";
+            }
+        }
+
+        return $snippets;
+    }
+
+    /**
+     * @param IssueData|DataFlowNodeData $data
+     */
+    private function getFileReference($data): string
+    {
+        $reference = $data->file_name . ':' . $data->line_from . ':' . $data->column_from;
+
+        if (!$this->use_color) {
+            return $reference;
+        }
+
+        $file_basename = basename($data->file_name);
+        $file_path = substr($data->file_name, 0, -strlen($file_basename));
+
+        $reference = $file_path
+            . "\033[1;31m"
+            . $file_basename . ':' . $data->line_from . ':' . $data->column_from
+            . "\033[0m"
+        ;
+
+        if ($this->in_ci) {
+            return $reference;
+        }
+
+        if (null === $this->link_format) {
+            // if xdebug is not enabled, use `get_cfg_var` to get the value directly from php.ini
+            $this->link_format = ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format')
+                ?: 'file://%f#L%l';
+        }
+
+        $link = strtr($this->link_format, ['%f' => $data->file_path, '%l' => $data->line_from]);
+        // $reference = $data->file_name . ':' . $data->line_from . ':' . $data->column_from;
+
+
+        return "\033]8;;" . $link . "\033\\" . $reference . "\033]8;;\033\\";
+    }
+
+    /**
+     * @param $severity
+     */
+    public function errorLevelMessage(int $severity): string
+    {
+        if ($severity < -1) {
+            return "Issues reported based on feature-specific config:";
+        }
+
+        if ($severity < 0) {
+            return "Issues always reported:";
+        }
+
+        return "Issues reported at error level $severity" .
+        ($severity === 1) ? ":" : " or less:";
+    }
+    public function sortIssuesByLevelAndType(): void
+    {
+        usort($this->issues_data, function (IssueData $left, IssueData $right): int {
+            $leftLevel = $left->error_level;
+            $rightLevel = $right->error_level;
+
+            if ($leftLevel != $rightLevel) {
+                if ($rightLevel > 0 && $leftLevel > 0) {
+                    return $rightLevel <=> $leftLevel;
+                }
+
+                if ($rightLevel > 0) {
+                    return -1;
+                }
+
+                return $leftLevel <=> $rightLevel;
+            }
+
+            return $left->type <=> $right->type;
+        });
+    }
+}

From 6bde0d3a68fee2c4ee23ac9dab6d803ab6d6e44e Mon Sep 17 00:00:00 2001
From: Barney Laurance <barney@redmagic.org.uk>
Date: Sat, 26 Nov 2022 22:33:18 +0000
Subject: [PATCH 02/18] Delete unused code

---
 src/Psalm/Report/ByIssueSeverityReport.php | 16 ----------------
 1 file changed, 16 deletions(-)

diff --git a/src/Psalm/Report/ByIssueSeverityReport.php b/src/Psalm/Report/ByIssueSeverityReport.php
index 02116c32393..4042307a638 100644
--- a/src/Psalm/Report/ByIssueSeverityReport.php
+++ b/src/Psalm/Report/ByIssueSeverityReport.php
@@ -152,22 +152,6 @@ private function getFileReference($data): string
         return "\033]8;;" . $link . "\033\\" . $reference . "\033]8;;\033\\";
     }
 
-    /**
-     * @param $severity
-     */
-    public function errorLevelMessage(int $severity): string
-    {
-        if ($severity < -1) {
-            return "Issues reported based on feature-specific config:";
-        }
-
-        if ($severity < 0) {
-            return "Issues always reported:";
-        }
-
-        return "Issues reported at error level $severity" .
-        ($severity === 1) ? ":" : " or less:";
-    }
     public function sortIssuesByLevelAndType(): void
     {
         usort($this->issues_data, function (IssueData $left, IssueData $right): int {

From 32881a3c655d0a9a58edefc2d17e2fb50bd5d231 Mon Sep 17 00:00:00 2001
From: Barney Laurance <barney@redmagic.org.uk>
Date: Sat, 26 Nov 2022 22:36:04 +0000
Subject: [PATCH 03/18] Add comments

---
 src/Psalm/Report/ByIssueSeverityReport.php | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/Psalm/Report/ByIssueSeverityReport.php b/src/Psalm/Report/ByIssueSeverityReport.php
index 4042307a638..d1d6e2122ce 100644
--- a/src/Psalm/Report/ByIssueSeverityReport.php
+++ b/src/Psalm/Report/ByIssueSeverityReport.php
@@ -33,6 +33,9 @@ public function create(): string
         return $output;
     }
 
+    /**
+     * Copied from ConsoleReport with only very minor changes. Todo consider reducing code duplication
+     */
     private function format(IssueData $issue_data): string
     {
         $issue_string = '';
@@ -82,6 +85,7 @@ private function format(IssueData $issue_data): string
     }
 
     /**
+     * Copied from ConsoleReport unchanged. Todo consider reducing code duplication
      * @param non-empty-list<DataFlowNodeData|array{label: string, entry_path_type: string}> $taint_trace
      */
     private function getTaintSnippets(array $taint_trace): string

From aea1c5603d5b68543fd8f6410faf1416ba86445b Mon Sep 17 00:00:00 2001
From: Barney Laurance <barney@redmagic.org.uk>
Date: Sun, 27 Nov 2022 12:18:34 +0000
Subject: [PATCH 04/18] Reduce function visibility

Co-authored-by: Bruce Weirdan <weirdan@gmail.com>
---
 src/Psalm/Report/ByIssueSeverityReport.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/Psalm/Report/ByIssueSeverityReport.php b/src/Psalm/Report/ByIssueSeverityReport.php
index d1d6e2122ce..c9eb684ef3e 100644
--- a/src/Psalm/Report/ByIssueSeverityReport.php
+++ b/src/Psalm/Report/ByIssueSeverityReport.php
@@ -156,7 +156,7 @@ private function getFileReference($data): string
         return "\033]8;;" . $link . "\033\\" . $reference . "\033]8;;\033\\";
     }
 
-    public function sortIssuesByLevelAndType(): void
+    private function sortIssuesByLevelAndType(): void
     {
         usort($this->issues_data, function (IssueData $left, IssueData $right): int {
             $leftLevel = $left->error_level;

From 4fde49313ea29223dbef4e9ddd42b635f6e525df Mon Sep 17 00:00:00 2001
From: Barney Laurance <barney@redmagic.org.uk>
Date: Thu, 1 Dec 2022 22:05:27 +0000
Subject: [PATCH 05/18] Fix implicit constant visibility

---
 src/Psalm/Report.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/Psalm/Report.php b/src/Psalm/Report.php
index 3d2c9a4633b..0ca186bdfd4 100644
--- a/src/Psalm/Report.php
+++ b/src/Psalm/Report.php
@@ -29,7 +29,7 @@ abstract class Report
     public const TYPE_SARIF = 'sarif';
     public const TYPE_CODECLIMATE = 'codeclimate';
     public const TYPE_COUNT = 'count';
-    const TYPE_BY_ISSUE_SEVERITY = 'by-issue-severity';
+    public const TYPE_BY_ISSUE_SEVERITY = 'by-issue-severity';
 
     /**
      * @var array<int, IssueData>

From 3bc3f1c273fd423e2375068cad8c2185035820ce Mon Sep 17 00:00:00 2001
From: Barney Laurance <barney@redmagic.org.uk>
Date: Thu, 1 Dec 2022 22:07:13 +0000
Subject: [PATCH 06/18] Fix report name: Issue level, not issue severity

---
 src/Psalm/IssueBuffer.php                                   | 6 +++---
 src/Psalm/Report.php                                        | 2 +-
 ...ssueSeverityReport.php => ByIssueLevelAndTypeReport.php} | 2 +-
 3 files changed, 5 insertions(+), 5 deletions(-)
 rename src/Psalm/Report/{ByIssueSeverityReport.php => ByIssueLevelAndTypeReport.php} (99%)

diff --git a/src/Psalm/IssueBuffer.php b/src/Psalm/IssueBuffer.php
index 515402feeeb..369f6a7629d 100644
--- a/src/Psalm/IssueBuffer.php
+++ b/src/Psalm/IssueBuffer.php
@@ -17,7 +17,7 @@
 use Psalm\Issue\UnusedPsalmSuppress;
 use Psalm\Plugin\EventHandler\Event\AfterAnalysisEvent;
 use Psalm\Plugin\EventHandler\Event\BeforeAddIssueEvent;
-use Psalm\Report\ByIssueSeverityReport;
+use Psalm\Report\ByIssueLevelAndTypeReport;
 use Psalm\Report\CheckstyleReport;
 use Psalm\Report\CodeClimateReport;
 use Psalm\Report\CompactReport;
@@ -855,8 +855,8 @@ public static function getOutput(
                 $output = new JsonReport($normalized_data, self::$fixable_issue_counts, $report_options);
                 break;
 
-            case Report::TYPE_BY_ISSUE_SEVERITY:
-                $output = new ByIssueSeverityReport($normalized_data, self::$fixable_issue_counts, $report_options);
+            case Report::TYPE_BY_ISSUE_LEVEL:
+                $output = new ByIssueLevelAndTypeReport($normalized_data, self::$fixable_issue_counts, $report_options);
                 break;
 
             case Report::TYPE_JSON_SUMMARY:
diff --git a/src/Psalm/Report.php b/src/Psalm/Report.php
index 0ca186bdfd4..98350d1e1de 100644
--- a/src/Psalm/Report.php
+++ b/src/Psalm/Report.php
@@ -29,7 +29,7 @@ abstract class Report
     public const TYPE_SARIF = 'sarif';
     public const TYPE_CODECLIMATE = 'codeclimate';
     public const TYPE_COUNT = 'count';
-    public const TYPE_BY_ISSUE_SEVERITY = 'by-issue-severity';
+    public const TYPE_BY_ISSUE_LEVEL = 'by-issue-level';
 
     /**
      * @var array<int, IssueData>
diff --git a/src/Psalm/Report/ByIssueSeverityReport.php b/src/Psalm/Report/ByIssueLevelAndTypeReport.php
similarity index 99%
rename from src/Psalm/Report/ByIssueSeverityReport.php
rename to src/Psalm/Report/ByIssueLevelAndTypeReport.php
index c9eb684ef3e..8268da501c4 100644
--- a/src/Psalm/Report/ByIssueSeverityReport.php
+++ b/src/Psalm/Report/ByIssueLevelAndTypeReport.php
@@ -15,7 +15,7 @@
 use function substr;
 use function usort;
 
-final class ByIssueSeverityReport extends Report
+final class ByIssueLevelAndTypeReport extends Report
 {
     /** @var string|null */
     private $link_format;

From 386aa27f4c0d54919528145833e7d460ec4dac84 Mon Sep 17 00:00:00 2001
From: Barney Laurance <barney@redmagic.org.uk>
Date: Thu, 1 Dec 2022 23:00:48 +0000
Subject: [PATCH 07/18] Improve issue level and type report

---
 src/Psalm/Internal/Cli/Psalm.php              |  2 +-
 .../Report/ByIssueLevelAndTypeReport.php      | 40 +++++++++++--------
 2 files changed, 24 insertions(+), 18 deletions(-)

diff --git a/src/Psalm/Internal/Cli/Psalm.php b/src/Psalm/Internal/Cli/Psalm.php
index b9f754d7ffe..383ea361914 100644
--- a/src/Psalm/Internal/Cli/Psalm.php
+++ b/src/Psalm/Internal/Cli/Psalm.php
@@ -1262,7 +1262,7 @@ 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
+                                   github, phpstorm, codeclimate, by-issue-level
 
             --no-progress
                 Disable the progress indicator
diff --git a/src/Psalm/Report/ByIssueLevelAndTypeReport.php b/src/Psalm/Report/ByIssueLevelAndTypeReport.php
index 8268da501c4..fd6ce8d870b 100644
--- a/src/Psalm/Report/ByIssueLevelAndTypeReport.php
+++ b/src/Psalm/Report/ByIssueLevelAndTypeReport.php
@@ -24,7 +24,25 @@ public function create(): string
     {
         $this->sortIssuesByLevelAndType();
 
-        $output = '';
+        $output = <<<HEADING
+        |----------------------------------------------------------------------------------------|
+        |    Issues have been sorted by level and type. Feature-specific issues and the          |
+        |    most serious issues that will always be reported are listed first, with             |
+        |    remaining issues in level order. Issues near the top are usually the most serious.  |
+        |    Reducing the errorLevel in psalm.xml will suppress output of issues further down    |
+        |    this report.                                                                        |
+        |                                                                                        |
+        |    The level at which issue is reported as an error is given in brackets - e.g.        |
+        |    `ERROR (2): MissingReturnType` indicates that MissingReturnType is only reported    |
+        |    as an error when Psalm's level is set to 4 or below.                                |
+        |                                                                                        |
+        |    Issues are shown or hidden in this report according to current settings. For        |
+        |    the most complete report set Psalm's error level to 0 or use --show-info=true       |
+        |    See https://psalm.dev/docs/running_psalm/error_levels/                              |
+        |----------------------------------------------------------------------------------------|
+HEADING;
+
+        ;
 
         foreach ($this->issues_data as $issue_data) {
             $output .= $this->format($issue_data) . "\n" . "\n";
@@ -50,7 +68,8 @@ private function format(IssueData $issue_data): string
 
         $issue_reference = $issue_data->link ? ' (see ' . $issue_data->link . ')' : '';
 
-        $issue_string .= " ($issue_data->error_level): "
+        $level = $issue_data->error_level;
+        $issue_string .= ($level > 0 ? " ($level): " : ": ")
             . $issue_data->type
             . ' - ' . $this->getFileReference($issue_data)
             . ' - ' . $issue_data->message . $issue_reference . "\n";
@@ -159,22 +178,9 @@ private function getFileReference($data): string
     private function sortIssuesByLevelAndType(): void
     {
         usort($this->issues_data, function (IssueData $left, IssueData $right): int {
-            $leftLevel = $left->error_level;
-            $rightLevel = $right->error_level;
-
-            if ($leftLevel != $rightLevel) {
-                if ($rightLevel > 0 && $leftLevel > 0) {
-                    return $rightLevel <=> $leftLevel;
-                }
-
-                if ($rightLevel > 0) {
-                    return -1;
-                }
-
-                return $leftLevel <=> $rightLevel;
-            }
 
-            return $left->type <=> $right->type;
+            return [$left->error_level > 0, -$left->error_level, $left->type] <=>
+                [$right->error_level > 0, -$right->error_level, $right->type];
         });
     }
 }

From 3f5616672a04e827911eb1d6d7c880c551798ed9 Mon Sep 17 00:00:00 2001
From: Barney Laurance <barney@redmagic.org.uk>
Date: Thu, 1 Dec 2022 23:27:53 +0000
Subject: [PATCH 08/18] Add test for ByIsueLevelAndTypeReport

---
 .../Report/ByIssueLevelAndTypeReport.php      | 32 +++---
 tests/ByIssueLevelAndTypeReportTest.php       | 97 +++++++++++++++++++
 2 files changed, 114 insertions(+), 15 deletions(-)
 create mode 100644 tests/ByIssueLevelAndTypeReportTest.php

diff --git a/src/Psalm/Report/ByIssueLevelAndTypeReport.php b/src/Psalm/Report/ByIssueLevelAndTypeReport.php
index fd6ce8d870b..6b3f66e6de4 100644
--- a/src/Psalm/Report/ByIssueLevelAndTypeReport.php
+++ b/src/Psalm/Report/ByIssueLevelAndTypeReport.php
@@ -25,21 +25,23 @@ public function create(): string
         $this->sortIssuesByLevelAndType();
 
         $output = <<<HEADING
-        |----------------------------------------------------------------------------------------|
-        |    Issues have been sorted by level and type. Feature-specific issues and the          |
-        |    most serious issues that will always be reported are listed first, with             |
-        |    remaining issues in level order. Issues near the top are usually the most serious.  |
-        |    Reducing the errorLevel in psalm.xml will suppress output of issues further down    |
-        |    this report.                                                                        |
-        |                                                                                        |
-        |    The level at which issue is reported as an error is given in brackets - e.g.        |
-        |    `ERROR (2): MissingReturnType` indicates that MissingReturnType is only reported    |
-        |    as an error when Psalm's level is set to 4 or below.                                |
-        |                                                                                        |
-        |    Issues are shown or hidden in this report according to current settings. For        |
-        |    the most complete report set Psalm's error level to 0 or use --show-info=true       |
-        |    See https://psalm.dev/docs/running_psalm/error_levels/                              |
-        |----------------------------------------------------------------------------------------|
+|----------------------------------------------------------------------------------------|
+|    Issues have been sorted by level and type. Feature-specific issues and the          |
+|    most serious issues that will always be reported are listed first, with             |
+|    remaining issues in level order. Issues near the top are usually the most serious.  |
+|    Reducing the errorLevel in psalm.xml will suppress output of issues further down    |
+|    this report.                                                                        |
+|                                                                                        |
+|    The level at which issue is reported as an error is given in brackets - e.g.        |
+|    `ERROR (2): MissingReturnType` indicates that MissingReturnType is only reported    |
+|    as an error when Psalm's level is set to 4 or below.                                |
+|                                                                                        |
+|    Issues are shown or hidden in this report according to current settings. For        |
+|    the most complete report set Psalm's error level to 0 or use --show-info=true       |
+|    See https://psalm.dev/docs/running_psalm/error_levels/                              |
+|----------------------------------------------------------------------------------------|
+
+
 HEADING;
 
         ;
diff --git a/tests/ByIssueLevelAndTypeReportTest.php b/tests/ByIssueLevelAndTypeReportTest.php
new file mode 100644
index 00000000000..afc14f6b096
--- /dev/null
+++ b/tests/ByIssueLevelAndTypeReportTest.php
@@ -0,0 +1,97 @@
+<?php
+
+namespace Psalm\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Psalm\Internal\Analyzer\IssueData;
+use Psalm\Report\ByIssueLevelAndTypeReport;
+use Psalm\Report\ReportOptions;
+
+class ByIssueLevelAndTypeReportTest extends TestCase
+{
+    public function testItGeneratesReport(): void
+    {
+        $issuesData = [
+            $this->issueData(2, 'SomeLevel2IssueType'),
+            $this->issueData(-1, 'SomeAlwaysReportedIssueType'),
+            $this->issueData(4, 'SomeLevel4IssueType'),
+            $this->issueData(7, 'SomeLevel7IssueType'),
+            $this->issueData(4, 'AnotherLevel4IssueType'),
+            $this->issueData(4, 'SomeLevel4IssueType'), // same issue type as above, will be sorted together
+            $this->issueData(1, 'SomeIssueType'),
+            $this->issueData(-2, 'SomeFeatureSpecificIssueType'),
+        ];
+
+        $reportOptions = new ReportOptions();
+        $reportOptions->use_color = false;
+
+        $report = new ByIssueLevelAndTypeReport($issuesData, [], $reportOptions);
+
+        $this->assertSame(<<<EXPECTED
+|----------------------------------------------------------------------------------------|
+|    Issues have been sorted by level and type. Feature-specific issues and the          |
+|    most serious issues that will always be reported are listed first, with             |
+|    remaining issues in level order. Issues near the top are usually the most serious.  |
+|    Reducing the errorLevel in psalm.xml will suppress output of issues further down    |
+|    this report.                                                                        |
+|                                                                                        |
+|    The level at which issue is reported as an error is given in brackets - e.g.        |
+|    `ERROR (2): MissingReturnType` indicates that MissingReturnType is only reported    |
+|    as an error when Psalm's level is set to 4 or below.                                |
+|                                                                                        |
+|    Issues are shown or hidden in this report according to current settings. For        |
+|    the most complete report set Psalm's error level to 0 or use --show-info=true       |
+|    See https://psalm.dev/docs/running_psalm/error_levels/                              |
+|----------------------------------------------------------------------------------------|
+
+ERROR: SomeAlwaysReportedIssueType - file.php:1:1 - message
+
+
+ERROR: SomeFeatureSpecificIssueType - file.php:1:1 - message
+
+
+ERROR (7): SomeLevel7IssueType - file.php:1:1 - message
+
+
+ERROR (4): AnotherLevel4IssueType - file.php:1:1 - message
+
+
+ERROR (4): SomeLevel4IssueType - file.php:1:1 - message
+
+
+ERROR (4): SomeLevel4IssueType - file.php:1:1 - message
+
+
+ERROR (2): SomeLevel2IssueType - file.php:1:1 - message
+
+
+ERROR (1): SomeIssueType - file.php:1:1 - message
+
+
+
+EXPECTED, $report->create());
+    }
+
+    public function issueData(int $errorLevel, string $type): IssueData
+    {
+        return new IssueData(
+            'error',
+            1,
+            1,
+            $type,
+            'message',
+            'file.php',
+            '/',
+            '',
+            '',
+            1,
+            1,
+            1,
+            1,
+            1,
+            1,
+            0,
+            $errorLevel
+        );
+    }
+}

From c1d2e5618af1819f496cedb49a57150417e9bb4a Mon Sep 17 00:00:00 2001
From: Bruce Weirdan <weirdan@gmail.com>
Date: Thu, 1 Dec 2022 19:59:51 -0400
Subject: [PATCH 09/18] Set vimeo/psalm version explicitly

---
 .circleci/config.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.circleci/config.yml b/.circleci/config.yml
index f70557a8be3..927ce985152 100644
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@@ -22,7 +22,7 @@ jobs:
           keys:
             - composer-v4
 
-      - run: composer update
+      - run: COMPOSER_ROOT_VERSION=dev-master composer update
 
       - save_cache:
           key: composer-v4

From 9e63bf6a4dffeba991a9da1c48e6d646209188fa Mon Sep 17 00:00:00 2001
From: Barney Laurance <barney@redmagic.org.uk>
Date: Thu, 1 Dec 2022 23:33:43 +0000
Subject: [PATCH 10/18] Minor code edits in ByIssueLevelAndType

---
 src/Psalm/Report/ByIssueLevelAndTypeReport.php | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/src/Psalm/Report/ByIssueLevelAndTypeReport.php b/src/Psalm/Report/ByIssueLevelAndTypeReport.php
index 6b3f66e6de4..d89a3112f34 100644
--- a/src/Psalm/Report/ByIssueLevelAndTypeReport.php
+++ b/src/Psalm/Report/ByIssueLevelAndTypeReport.php
@@ -44,8 +44,6 @@ public function create(): string
 
 HEADING;
 
-        ;
-
         foreach ($this->issues_data as $issue_data) {
             $output .= $this->format($issue_data) . "\n" . "\n";
         }
@@ -54,7 +52,7 @@ public function create(): string
     }
 
     /**
-     * Copied from ConsoleReport with only very minor changes. Todo consider reducing code duplication
+     * Copied from ConsoleReport with only very minor changes.
      */
     private function format(IssueData $issue_data): string
     {
@@ -106,7 +104,7 @@ private function format(IssueData $issue_data): string
     }
 
     /**
-     * Copied from ConsoleReport unchanged. Todo consider reducing code duplication
+     * Copied from ConsoleReport unchanged. We could consider moving to another class to reduce duplication.
      * @param non-empty-list<DataFlowNodeData|array{label: string, entry_path_type: string}> $taint_trace
      */
     private function getTaintSnippets(array $taint_trace): string
@@ -141,6 +139,7 @@ private function getTaintSnippets(array $taint_trace): string
     }
 
     /**
+     * Copied from ConsoleReport unchanged. We could consider moving to another class to reduce duplication.
      * @param IssueData|DataFlowNodeData $data
      */
     private function getFileReference($data): string
@@ -180,7 +179,7 @@ private function getFileReference($data): string
     private function sortIssuesByLevelAndType(): void
     {
         usort($this->issues_data, function (IssueData $left, IssueData $right): int {
-
+            // negative error levels go to the top, followed by large positive levels, with level 1 at the bottom.
             return [$left->error_level > 0, -$left->error_level, $left->type] <=>
                 [$right->error_level > 0, -$right->error_level, $right->type];
         });

From cd18cdc5548492f51c57654fa351c90345bafb92 Mon Sep 17 00:00:00 2001
From: Barney Laurance <barney@redmagic.org.uk>
Date: Thu, 1 Dec 2022 23:57:52 +0000
Subject: [PATCH 11/18] Re-order list of errors in docs

I think it makes more sense to have the errors that almost always appear
(level 7 errors) next to the errors that always appear, instead of
the level 1, least likely to appear errors being next to the ones that
always appear.

This also makes the order more similar to that output by the new
--by-issue-level format report.

Some time it might be nice to see if there's a way to auto generate most
of this docs page from the actual issue class definitions, or have
a test that checks the list of issues for each level is accurate and
complete.
---
 docs/running_psalm/error_levels.md | 339 ++++++++++++++---------------
 1 file changed, 169 insertions(+), 170 deletions(-)

diff --git a/docs/running_psalm/error_levels.md b/docs/running_psalm/error_levels.md
index f209921b170..630b1e90365 100644
--- a/docs/running_psalm/error_levels.md
+++ b/docs/running_psalm/error_levels.md
@@ -6,9 +6,9 @@ Level 1 is the most strict, level 8 is the most lenient.
 
 When no level is explicitly defined, psalm defaults to level 2.
 
-Some issues are [always treated as errors](#always-treated-as-errors). These are issues with a very low probability of false-positives.
+Some issues are always treated as errors. These are issues with a very low probability of false-positives.
 
-At [level 1](#errors-that-only-appear-at-level-1) all issues (except those emitted for opt-in features) that Psalm can find are treated as errors. Those issues include any situation where Psalm cannot infer the type of a given expression.
+At level 1 all issues (except those emitted for opt-in features) that Psalm can find are treated as errors. Those issues include any situation where Psalm cannot infer the type of a given expression.
 
 At level 2 Psalm ignores those `Mixed*` issues, but treats most other issues as errors.
 
@@ -89,6 +89,173 @@ Level 5 and above allows a more non-verifiable code, and higher levels are even
  - [UnusedFunctionCall](issues/UnusedFunctionCall.md)
  - [UnusedMethodCall](issues/UnusedMethodCall.md)
 
+## Errors that appear at level 7 and below
+
+These issues are treated as errors at level 7 and below.
+
+- [AbstractInstantiation](issues/AbstractInstantiation.md)
+- [AssignmentToVoid](issues/AssignmentToVoid.md)
+- [CircularReference](issues/CircularReference.md)
+- [ConflictingReferenceConstraint](issues/ConflictingReferenceConstraint.md)
+- [ContinueOutsideLoop](issues/ContinueOutsideLoop.md)
+- [InvalidTypeImport](issues/InvalidTypeImport.md)
+- [MethodSignatureMismatch](issues/MethodSignatureMismatch.md)
+- [OverriddenMethodAccess](issues/OverriddenMethodAccess.md)
+- [ParamNameMismatch](issues/ParamNameMismatch.md)
+- [ReservedWord](issues/ReservedWord.md)
+- [UnhandledMatchCondition](issues/UnhandledMatchCondition.md)
+- [UninitializedProperty](issues/UninitializedProperty.md)
+
+## Errors that appear at level 6 and below
+
+These issues are treated as errors at level 6 and below.
+
+- [InvalidArgument](issues/InvalidArgument.md)
+- [InvalidArrayAccess](issues/InvalidArrayAccess.md)
+- [InvalidArrayAssignment](issues/InvalidArrayAssignment.md)
+- [InvalidArrayOffset](issues/InvalidArrayOffset.md)
+- [InvalidCast](issues/InvalidCast.md)
+- [InvalidCatch](issues/InvalidCatch.md)
+- [InvalidClass](issues/InvalidClass.md)
+- [InvalidClone](issues/InvalidClone.md)
+- [InvalidFunctionCall](issues/InvalidFunctionCall.md)
+- [InvalidIterator](issues/InvalidIterator.md)
+- [InvalidMethodCall](issues/InvalidMethodCall.md)
+- [InvalidNamedArgument](issues/InvalidNamedArgument.md)
+- [InvalidPropertyAssignment](issues/InvalidPropertyAssignment.md)
+- [InvalidPropertyAssignmentValue](issues/InvalidPropertyAssignmentValue.md)
+- [InvalidPropertyFetch](issues/InvalidPropertyFetch.md)
+- [InvalidReturnStatement](issues/InvalidReturnStatement.md)
+- [InvalidReturnType](issues/InvalidReturnType.md)
+- [InvalidTemplateParam](issues/InvalidTemplateParam.md)
+- [NullArgument](issues/NullArgument.md)
+- [NullArrayOffset](issues/NullArrayOffset.md)
+- [TooManyTemplateParams](issues/TooManyTemplateParams.md)
+- [TraitMethodSignatureMismatch](issues/TraitMethodSignatureMismatch.md)
+- [UndefinedMethod](issues/UndefinedMethod.md)
+- [UndefinedPropertyAssignment](issues/UndefinedPropertyAssignment.md)
+- [UndefinedPropertyFetch](issues/UndefinedPropertyFetch.md)
+- [UndefinedThisPropertyFetch](issues/UndefinedThisPropertyFetch.md)
+
+## Errors that appear at level 5 and below
+
+These issues are treated as errors at level 5 and below.
+
+- [ConstructorSignatureMismatch](issues/ConstructorSignatureMismatch.md)
+- [FalsableReturnStatement](issues/FalsableReturnStatement.md)
+- [InvalidNullableReturnType](issues/InvalidNullableReturnType.md)
+- [LessSpecificImplementedReturnType](issues/LessSpecificImplementedReturnType.md)
+- [MoreSpecificImplementedParamType](issues/MoreSpecificImplementedParamType.md)
+- [NullableReturnStatement](issues/NullableReturnStatement.md)
+- [UndefinedInterfaceMethod](issues/UndefinedInterfaceMethod.md)
+- [UndefinedThisPropertyAssignment](issues/UndefinedThisPropertyAssignment.md)
+
+## Errors that appear at level 4 and below
+
+These issues are treated as errors at level 4 and below.
+
+- [FalseOperand](issues/FalseOperand.md)
+- [ForbiddenCode](issues/ForbiddenCode.md)
+- [ImplementedParamTypeMismatch](issues/ImplementedParamTypeMismatch.md)
+- [ImplementedReturnTypeMismatch](issues/ImplementedReturnTypeMismatch.md)
+- [ImplicitToStringCast](issues/ImplicitToStringCast.md)
+- [InternalClass](issues/InternalClass.md)
+- [InternalMethod](issues/InternalMethod.md)
+- [InternalProperty](issues/InternalProperty.md)
+- [InvalidDocblock](issues/InvalidDocblock.md)
+- [InvalidLiteralArgument](issues/InvalidLiteralArgument.md)
+- [InvalidOperand](issues/InvalidOperand.md)
+- [InvalidScalarArgument](issues/InvalidScalarArgument.md)
+- [InvalidToString](issues/InvalidToString.md)
+- [MismatchingDocblockParamType](issues/MismatchingDocblockParamType.md)
+- [MismatchingDocblockReturnType](issues/MismatchingDocblockReturnType.md)
+- [MissingDocblockType](issues/MissingDocblockType.md)
+- [NoInterfaceProperties](issues/NoInterfaceProperties.md)
+- [PossibleRawObjectIteration](issues/PossibleRawObjectIteration.md)
+- [RedundantCondition](issues/RedundantCondition.md)
+- [RedundantFunctionCall](issues/RedundantFunctionCall.md)
+- [RedundantPropertyInitializationCheck](issues/RedundantPropertyInitializationCheck.md)
+- [StringIncrement](issues/StringIncrement.md)
+- [TooManyArguments](issues/TooManyArguments.md)
+- [TypeDoesNotContainNull](issues/TypeDoesNotContainNull.md)
+- [TypeDoesNotContainType](issues/TypeDoesNotContainType.md)
+- [UndefinedMagicMethod](issues/UndefinedMagicMethod.md)
+- [UndefinedMagicPropertyAssignment](issues/UndefinedMagicPropertyAssignment.md)
+- [UndefinedMagicPropertyFetch](issues/UndefinedMagicPropertyFetch.md)
+
+## Errors that appear at level 3 and below
+
+These issues are treated as errors at level 3 and below.
+
+- [ArgumentTypeCoercion](issues/ArgumentTypeCoercion.md)
+- [LessSpecificReturnStatement](issues/LessSpecificReturnStatement.md)
+- [MoreSpecificReturnType](issues/MoreSpecificReturnType.md)
+- [PossiblyFalseArgument](issues/PossiblyFalseArgument.md)
+- [PossiblyFalseIterator](issues/PossiblyFalseIterator.md)
+- [PossiblyFalseOperand](issues/PossiblyFalseOperand.md)
+- [PossiblyFalsePropertyAssignmentValue](issues/PossiblyFalsePropertyAssignmentValue.md)
+- [PossiblyFalseReference](issues/PossiblyFalseReference.md)
+- [PossiblyInvalidArgument](issues/PossiblyInvalidArgument.md)
+- [PossiblyInvalidArrayAccess](issues/PossiblyInvalidArrayAccess.md)
+- [PossiblyInvalidArrayAssignment](issues/PossiblyInvalidArrayAssignment.md)
+- [PossiblyInvalidArrayOffset](issues/PossiblyInvalidArrayOffset.md)
+- [PossiblyInvalidCast](issues/PossiblyInvalidCast.md)
+- [PossiblyInvalidClone](issues/PossiblyInvalidClone.md)
+- [PossiblyInvalidFunctionCall](issues/PossiblyInvalidFunctionCall.md)
+- [PossiblyInvalidIterator](issues/PossiblyInvalidIterator.md)
+- [PossiblyInvalidMethodCall](issues/PossiblyInvalidMethodCall.md)
+- [PossiblyInvalidOperand](issues/PossiblyInvalidOperand.md)
+- [PossiblyInvalidPropertyAssignment](issues/PossiblyInvalidPropertyAssignment.md)
+- [PossiblyInvalidPropertyAssignmentValue](issues/PossiblyInvalidPropertyAssignmentValue.md)
+- [PossiblyInvalidPropertyFetch](issues/PossiblyInvalidPropertyFetch.md)
+- [PossiblyNullArgument](issues/PossiblyNullArgument.md)
+- [PossiblyNullArrayAccess](issues/PossiblyNullArrayAccess.md)
+- [PossiblyNullArrayAssignment](issues/PossiblyNullArrayAssignment.md)
+- [PossiblyNullArrayOffset](issues/PossiblyNullArrayOffset.md)
+- [PossiblyNullFunctionCall](issues/PossiblyNullFunctionCall.md)
+- [PossiblyNullIterator](issues/PossiblyNullIterator.md)
+- [PossiblyNullPropertyAssignment](issues/PossiblyNullPropertyAssignment.md)
+- [PossiblyNullPropertyAssignmentValue](issues/PossiblyNullPropertyAssignmentValue.md)
+- [PossiblyNullPropertyFetch](issues/PossiblyNullPropertyFetch.md)
+- [PossiblyNullReference](issues/PossiblyNullReference.md)
+- [PossiblyUndefinedArrayOffset](issues/PossiblyUndefinedArrayOffset.md)
+- [PossiblyUndefinedGlobalVariable](issues/PossiblyUndefinedGlobalVariable.md)
+- [PossiblyUndefinedMethod](issues/PossiblyUndefinedMethod.md)
+- [PossiblyUndefinedVariable](issues/PossiblyUndefinedVariable.md)
+- [PropertyTypeCoercion](issues/PropertyTypeCoercion.md)
+- [RiskyCast](issues/RiskyCast.md)
+
+## Errors that appear at level 2 and below
+
+These issues are treated as errors at level 2 and below.
+
+- [DeprecatedClass](issues/DeprecatedClass.md)
+- [DeprecatedConstant](issues/DeprecatedConstant.md)
+- [DeprecatedFunction](issues/DeprecatedFunction.md)
+- [DeprecatedInterface](issues/DeprecatedInterface.md)
+- [DeprecatedMethod](issues/DeprecatedMethod.md)
+- [DeprecatedProperty](issues/DeprecatedProperty.md)
+- [DeprecatedTrait](issues/DeprecatedTrait.md)
+- [DocblockTypeContradiction](issues/DocblockTypeContradiction.md)
+- [InvalidDocblockParamName](issues/InvalidDocblockParamName.md)
+- [InvalidFalsableReturnType](issues/InvalidFalsableReturnType.md)
+- [InvalidStringClass](issues/InvalidStringClass.md)
+- [MissingClosureParamType](issues/MissingClosureParamType.md)
+- [MissingClosureReturnType](issues/MissingClosureReturnType.md)
+- [MissingConstructor](issues/MissingConstructor.md)
+- [MissingParamType](issues/MissingParamType.md)
+- [MissingPropertyType](issues/MissingPropertyType.md)
+- [MissingReturnType](issues/MissingReturnType.md)
+- [NullOperand](issues/NullOperand.md)
+- [PropertyNotSetInConstructor](issues/PropertyNotSetInConstructor.md)
+- [RawObjectIteration](issues/RawObjectIteration.md)
+- [RedundantConditionGivenDocblockType](issues/RedundantConditionGivenDocblockType.md)
+- [RedundantFunctionCallGivenDocblockType](issues/RedundantFunctionCallGivenDocblockType.md)
+- [ReferenceConstraintViolation](issues/ReferenceConstraintViolation.md)
+- [UndefinedTrace](issues/UndefinedTrace.md)
+- [UnresolvableInclude](issues/UnresolvableInclude.md)
+- [UnsafeInstantiation](issues/UnsafeInstantiation.md)
+
 ## Errors that only appear at level 1
 
  - [LessSpecificReturnType](issues/LessSpecificReturnType.md)
@@ -115,174 +282,6 @@ Level 5 and above allows a more non-verifiable code, and higher levels are even
  - [RedundantIdentityWithTrue](issues/RedundantIdentityWithTrue.md)
  - [Trace](issues/Trace.md)
 
-## Errors ignored at level 3 and higher
-
-These issues are treated as errors at level 2 and below.
-
- - [DeprecatedClass](issues/DeprecatedClass.md)
- - [DeprecatedConstant](issues/DeprecatedConstant.md)
- - [DeprecatedFunction](issues/DeprecatedFunction.md)
- - [DeprecatedInterface](issues/DeprecatedInterface.md)
- - [DeprecatedMethod](issues/DeprecatedMethod.md)
- - [DeprecatedProperty](issues/DeprecatedProperty.md)
- - [DeprecatedTrait](issues/DeprecatedTrait.md)
- - [DocblockTypeContradiction](issues/DocblockTypeContradiction.md)
- - [InvalidDocblockParamName](issues/InvalidDocblockParamName.md)
- - [InvalidFalsableReturnType](issues/InvalidFalsableReturnType.md)
- - [InvalidStringClass](issues/InvalidStringClass.md)
- - [MissingClosureParamType](issues/MissingClosureParamType.md)
- - [MissingClosureReturnType](issues/MissingClosureReturnType.md)
- - [MissingConstructor](issues/MissingConstructor.md)
- - [MissingParamType](issues/MissingParamType.md)
- - [MissingPropertyType](issues/MissingPropertyType.md)
- - [MissingReturnType](issues/MissingReturnType.md)
- - [NullOperand](issues/NullOperand.md)
- - [PropertyNotSetInConstructor](issues/PropertyNotSetInConstructor.md)
- - [RawObjectIteration](issues/RawObjectIteration.md)
- - [RedundantConditionGivenDocblockType](issues/RedundantConditionGivenDocblockType.md)
- - [RedundantFunctionCallGivenDocblockType](issues/RedundantFunctionCallGivenDocblockType.md)
- - [ReferenceConstraintViolation](issues/ReferenceConstraintViolation.md)
- - [UndefinedTrace](issues/UndefinedTrace.md)
- - [UnresolvableInclude](issues/UnresolvableInclude.md)
- - [UnsafeInstantiation](issues/UnsafeInstantiation.md)
-
-## Errors ignored at level 4 and higher
-
-These issues are treated as errors at level 3 and below.
-
- - [ArgumentTypeCoercion](issues/ArgumentTypeCoercion.md)
- - [LessSpecificReturnStatement](issues/LessSpecificReturnStatement.md)
- - [MoreSpecificReturnType](issues/MoreSpecificReturnType.md)
- - [PossiblyFalseArgument](issues/PossiblyFalseArgument.md)
- - [PossiblyFalseIterator](issues/PossiblyFalseIterator.md)
- - [PossiblyFalseOperand](issues/PossiblyFalseOperand.md)
- - [PossiblyFalsePropertyAssignmentValue](issues/PossiblyFalsePropertyAssignmentValue.md)
- - [PossiblyFalseReference](issues/PossiblyFalseReference.md)
- - [PossiblyInvalidArgument](issues/PossiblyInvalidArgument.md)
- - [PossiblyInvalidArrayAccess](issues/PossiblyInvalidArrayAccess.md)
- - [PossiblyInvalidArrayAssignment](issues/PossiblyInvalidArrayAssignment.md)
- - [PossiblyInvalidArrayOffset](issues/PossiblyInvalidArrayOffset.md)
- - [PossiblyInvalidCast](issues/PossiblyInvalidCast.md)
- - [PossiblyInvalidClone](issues/PossiblyInvalidClone.md)
- - [PossiblyInvalidFunctionCall](issues/PossiblyInvalidFunctionCall.md)
- - [PossiblyInvalidIterator](issues/PossiblyInvalidIterator.md)
- - [PossiblyInvalidMethodCall](issues/PossiblyInvalidMethodCall.md)
- - [PossiblyInvalidOperand](issues/PossiblyInvalidOperand.md)
- - [PossiblyInvalidPropertyAssignment](issues/PossiblyInvalidPropertyAssignment.md)
- - [PossiblyInvalidPropertyAssignmentValue](issues/PossiblyInvalidPropertyAssignmentValue.md)
- - [PossiblyInvalidPropertyFetch](issues/PossiblyInvalidPropertyFetch.md)
- - [PossiblyNullArgument](issues/PossiblyNullArgument.md)
- - [PossiblyNullArrayAccess](issues/PossiblyNullArrayAccess.md)
- - [PossiblyNullArrayAssignment](issues/PossiblyNullArrayAssignment.md)
- - [PossiblyNullArrayOffset](issues/PossiblyNullArrayOffset.md)
- - [PossiblyNullFunctionCall](issues/PossiblyNullFunctionCall.md)
- - [PossiblyNullIterator](issues/PossiblyNullIterator.md)
- - [PossiblyNullPropertyAssignment](issues/PossiblyNullPropertyAssignment.md)
- - [PossiblyNullPropertyAssignmentValue](issues/PossiblyNullPropertyAssignmentValue.md)
- - [PossiblyNullPropertyFetch](issues/PossiblyNullPropertyFetch.md)
- - [PossiblyNullReference](issues/PossiblyNullReference.md)
- - [PossiblyUndefinedArrayOffset](issues/PossiblyUndefinedArrayOffset.md)
- - [PossiblyUndefinedGlobalVariable](issues/PossiblyUndefinedGlobalVariable.md)
- - [PossiblyUndefinedMethod](issues/PossiblyUndefinedMethod.md)
- - [PossiblyUndefinedVariable](issues/PossiblyUndefinedVariable.md)
- - [PropertyTypeCoercion](issues/PropertyTypeCoercion.md)
- - [RiskyCast](issues/RiskyCast.md)
-
-## Errors ignored at level 5 and higher
-
-These issues are treated as errors at level 4 and below.
-
- - [FalseOperand](issues/FalseOperand.md)
- - [ForbiddenCode](issues/ForbiddenCode.md)
- - [ImplementedParamTypeMismatch](issues/ImplementedParamTypeMismatch.md)
- - [ImplementedReturnTypeMismatch](issues/ImplementedReturnTypeMismatch.md)
- - [ImplicitToStringCast](issues/ImplicitToStringCast.md)
- - [InternalClass](issues/InternalClass.md)
- - [InternalMethod](issues/InternalMethod.md)
- - [InternalProperty](issues/InternalProperty.md)
- - [InvalidDocblock](issues/InvalidDocblock.md)
- - [InvalidLiteralArgument](issues/InvalidLiteralArgument.md)
- - [InvalidOperand](issues/InvalidOperand.md)
- - [InvalidScalarArgument](issues/InvalidScalarArgument.md)
- - [InvalidToString](issues/InvalidToString.md)
- - [MismatchingDocblockParamType](issues/MismatchingDocblockParamType.md)
- - [MismatchingDocblockReturnType](issues/MismatchingDocblockReturnType.md)
- - [MissingDocblockType](issues/MissingDocblockType.md)
- - [NoInterfaceProperties](issues/NoInterfaceProperties.md)
- - [PossibleRawObjectIteration](issues/PossibleRawObjectIteration.md)
- - [RedundantCondition](issues/RedundantCondition.md)
- - [RedundantFunctionCall](issues/RedundantFunctionCall.md)
- - [RedundantPropertyInitializationCheck](issues/RedundantPropertyInitializationCheck.md)
- - [StringIncrement](issues/StringIncrement.md)
- - [TooManyArguments](issues/TooManyArguments.md)
- - [TypeDoesNotContainNull](issues/TypeDoesNotContainNull.md)
- - [TypeDoesNotContainType](issues/TypeDoesNotContainType.md)
- - [UndefinedMagicMethod](issues/UndefinedMagicMethod.md)
- - [UndefinedMagicPropertyAssignment](issues/UndefinedMagicPropertyAssignment.md)
- - [UndefinedMagicPropertyFetch](issues/UndefinedMagicPropertyFetch.md)
-
-## Errors ignored at level 6 and higher
-
-These issues are treated as errors at level 5 and below.
-
- - [ConstructorSignatureMismatch](issues/ConstructorSignatureMismatch.md)
- - [FalsableReturnStatement](issues/FalsableReturnStatement.md)
- - [InvalidNullableReturnType](issues/InvalidNullableReturnType.md)
- - [LessSpecificImplementedReturnType](issues/LessSpecificImplementedReturnType.md)
- - [MoreSpecificImplementedParamType](issues/MoreSpecificImplementedParamType.md)
- - [NullableReturnStatement](issues/NullableReturnStatement.md)
- - [UndefinedInterfaceMethod](issues/UndefinedInterfaceMethod.md)
- - [UndefinedThisPropertyAssignment](issues/UndefinedThisPropertyAssignment.md)
-
-## Errors ignored at level 7 and higher
-
-These issues are treated as errors at level 6 and below.
-
- - [InvalidArgument](issues/InvalidArgument.md)
- - [InvalidArrayAccess](issues/InvalidArrayAccess.md)
- - [InvalidArrayAssignment](issues/InvalidArrayAssignment.md)
- - [InvalidArrayOffset](issues/InvalidArrayOffset.md)
- - [InvalidCast](issues/InvalidCast.md)
- - [InvalidCatch](issues/InvalidCatch.md)
- - [InvalidClass](issues/InvalidClass.md)
- - [InvalidClone](issues/InvalidClone.md)
- - [InvalidFunctionCall](issues/InvalidFunctionCall.md)
- - [InvalidIterator](issues/InvalidIterator.md)
- - [InvalidMethodCall](issues/InvalidMethodCall.md)
- - [InvalidNamedArgument](issues/InvalidNamedArgument.md)
- - [InvalidPropertyAssignment](issues/InvalidPropertyAssignment.md)
- - [InvalidPropertyAssignmentValue](issues/InvalidPropertyAssignmentValue.md)
- - [InvalidPropertyFetch](issues/InvalidPropertyFetch.md)
- - [InvalidReturnStatement](issues/InvalidReturnStatement.md)
- - [InvalidReturnType](issues/InvalidReturnType.md)
- - [InvalidTemplateParam](issues/InvalidTemplateParam.md)
- - [NullArgument](issues/NullArgument.md)
- - [NullArrayOffset](issues/NullArrayOffset.md)
- - [TooManyTemplateParams](issues/TooManyTemplateParams.md)
- - [TraitMethodSignatureMismatch](issues/TraitMethodSignatureMismatch.md)
- - [UndefinedMethod](issues/UndefinedMethod.md)
- - [UndefinedPropertyAssignment](issues/UndefinedPropertyAssignment.md)
- - [UndefinedPropertyFetch](issues/UndefinedPropertyFetch.md)
- - [UndefinedThisPropertyFetch](issues/UndefinedThisPropertyFetch.md)
-
-## Errors ignored at level 8
-
-These issues are treated as errors at level 7 and below.
-
- - [AbstractInstantiation](issues/AbstractInstantiation.md)
- - [AssignmentToVoid](issues/AssignmentToVoid.md)
- - [CircularReference](issues/CircularReference.md)
- - [ConflictingReferenceConstraint](issues/ConflictingReferenceConstraint.md)
- - [ContinueOutsideLoop](issues/ContinueOutsideLoop.md)
- - [InvalidTypeImport](issues/InvalidTypeImport.md)
- - [MethodSignatureMismatch](issues/MethodSignatureMismatch.md)
- - [OverriddenMethodAccess](issues/OverriddenMethodAccess.md)
- - [ParamNameMismatch](issues/ParamNameMismatch.md)
- - [ReservedWord](issues/ReservedWord.md)
- - [UnhandledMatchCondition](issues/UnhandledMatchCondition.md)
- - [UninitializedProperty](issues/UninitializedProperty.md)
-
-
 ## Feature-specific errors
 
  - [PossiblyUndefinedIntArrayOffset](issues/PossiblyUndefinedIntArrayOffset.md)

From d6c7c863625d3fd0771ce7d0fad2285c36cc7472 Mon Sep 17 00:00:00 2001
From: Barney Laurance <barney@redmagic.org.uk>
Date: Fri, 2 Dec 2022 00:07:37 +0000
Subject: [PATCH 12/18] Remove unecassary subheadings in error levels
 documentation

---
 docs/running_psalm/error_levels.md | 12 ------------
 1 file changed, 12 deletions(-)

diff --git a/docs/running_psalm/error_levels.md b/docs/running_psalm/error_levels.md
index 630b1e90365..9eeb12e7f72 100644
--- a/docs/running_psalm/error_levels.md
+++ b/docs/running_psalm/error_levels.md
@@ -91,8 +91,6 @@ Level 5 and above allows a more non-verifiable code, and higher levels are even
 
 ## Errors that appear at level 7 and below
 
-These issues are treated as errors at level 7 and below.
-
 - [AbstractInstantiation](issues/AbstractInstantiation.md)
 - [AssignmentToVoid](issues/AssignmentToVoid.md)
 - [CircularReference](issues/CircularReference.md)
@@ -108,8 +106,6 @@ These issues are treated as errors at level 7 and below.
 
 ## Errors that appear at level 6 and below
 
-These issues are treated as errors at level 6 and below.
-
 - [InvalidArgument](issues/InvalidArgument.md)
 - [InvalidArrayAccess](issues/InvalidArrayAccess.md)
 - [InvalidArrayAssignment](issues/InvalidArrayAssignment.md)
@@ -139,8 +135,6 @@ These issues are treated as errors at level 6 and below.
 
 ## Errors that appear at level 5 and below
 
-These issues are treated as errors at level 5 and below.
-
 - [ConstructorSignatureMismatch](issues/ConstructorSignatureMismatch.md)
 - [FalsableReturnStatement](issues/FalsableReturnStatement.md)
 - [InvalidNullableReturnType](issues/InvalidNullableReturnType.md)
@@ -152,8 +146,6 @@ These issues are treated as errors at level 5 and below.
 
 ## Errors that appear at level 4 and below
 
-These issues are treated as errors at level 4 and below.
-
 - [FalseOperand](issues/FalseOperand.md)
 - [ForbiddenCode](issues/ForbiddenCode.md)
 - [ImplementedParamTypeMismatch](issues/ImplementedParamTypeMismatch.md)
@@ -185,8 +177,6 @@ These issues are treated as errors at level 4 and below.
 
 ## Errors that appear at level 3 and below
 
-These issues are treated as errors at level 3 and below.
-
 - [ArgumentTypeCoercion](issues/ArgumentTypeCoercion.md)
 - [LessSpecificReturnStatement](issues/LessSpecificReturnStatement.md)
 - [MoreSpecificReturnType](issues/MoreSpecificReturnType.md)
@@ -227,8 +217,6 @@ These issues are treated as errors at level 3 and below.
 
 ## Errors that appear at level 2 and below
 
-These issues are treated as errors at level 2 and below.
-
 - [DeprecatedClass](issues/DeprecatedClass.md)
 - [DeprecatedConstant](issues/DeprecatedConstant.md)
 - [DeprecatedFunction](issues/DeprecatedFunction.md)

From 699ee344d4adaf38ec847d691ff67859d593e872 Mon Sep 17 00:00:00 2001
From: Barney Laurance <barney@redmagic.org.uk>
Date: Fri, 2 Dec 2022 00:14:43 +0000
Subject: [PATCH 13/18] Indent heredoc in test

---
 tests/ByIssueLevelAndTypeReportTest.php | 48 ++++++++++++-------------
 1 file changed, 24 insertions(+), 24 deletions(-)

diff --git a/tests/ByIssueLevelAndTypeReportTest.php b/tests/ByIssueLevelAndTypeReportTest.php
index afc14f6b096..d6a741476c8 100644
--- a/tests/ByIssueLevelAndTypeReportTest.php
+++ b/tests/ByIssueLevelAndTypeReportTest.php
@@ -28,48 +28,48 @@ public function testItGeneratesReport(): void
         $report = new ByIssueLevelAndTypeReport($issuesData, [], $reportOptions);
 
         $this->assertSame(<<<EXPECTED
-|----------------------------------------------------------------------------------------|
-|    Issues have been sorted by level and type. Feature-specific issues and the          |
-|    most serious issues that will always be reported are listed first, with             |
-|    remaining issues in level order. Issues near the top are usually the most serious.  |
-|    Reducing the errorLevel in psalm.xml will suppress output of issues further down    |
-|    this report.                                                                        |
-|                                                                                        |
-|    The level at which issue is reported as an error is given in brackets - e.g.        |
-|    `ERROR (2): MissingReturnType` indicates that MissingReturnType is only reported    |
-|    as an error when Psalm's level is set to 4 or below.                                |
-|                                                                                        |
-|    Issues are shown or hidden in this report according to current settings. For        |
-|    the most complete report set Psalm's error level to 0 or use --show-info=true       |
-|    See https://psalm.dev/docs/running_psalm/error_levels/                              |
-|----------------------------------------------------------------------------------------|
+        |----------------------------------------------------------------------------------------|
+        |    Issues have been sorted by level and type. Feature-specific issues and the          |
+        |    most serious issues that will always be reported are listed first, with             |
+        |    remaining issues in level order. Issues near the top are usually the most serious.  |
+        |    Reducing the errorLevel in psalm.xml will suppress output of issues further down    |
+        |    this report.                                                                        |
+        |                                                                                        |
+        |    The level at which issue is reported as an error is given in brackets - e.g.        |
+        |    `ERROR (2): MissingReturnType` indicates that MissingReturnType is only reported    |
+        |    as an error when Psalm's level is set to 4 or below.                                |
+        |                                                                                        |
+        |    Issues are shown or hidden in this report according to current settings. For        |
+        |    the most complete report set Psalm's error level to 0 or use --show-info=true       |
+        |    See https://psalm.dev/docs/running_psalm/error_levels/                              |
+        |----------------------------------------------------------------------------------------|
 
-ERROR: SomeAlwaysReportedIssueType - file.php:1:1 - message
+        ERROR: SomeAlwaysReportedIssueType - file.php:1:1 - message
 
 
-ERROR: SomeFeatureSpecificIssueType - file.php:1:1 - message
+        ERROR: SomeFeatureSpecificIssueType - file.php:1:1 - message
 
 
-ERROR (7): SomeLevel7IssueType - file.php:1:1 - message
+        ERROR (7): SomeLevel7IssueType - file.php:1:1 - message
 
 
-ERROR (4): AnotherLevel4IssueType - file.php:1:1 - message
+        ERROR (4): AnotherLevel4IssueType - file.php:1:1 - message
 
 
-ERROR (4): SomeLevel4IssueType - file.php:1:1 - message
+        ERROR (4): SomeLevel4IssueType - file.php:1:1 - message
 
 
-ERROR (4): SomeLevel4IssueType - file.php:1:1 - message
+        ERROR (4): SomeLevel4IssueType - file.php:1:1 - message
 
 
-ERROR (2): SomeLevel2IssueType - file.php:1:1 - message
+        ERROR (2): SomeLevel2IssueType - file.php:1:1 - message
 
 
-ERROR (1): SomeIssueType - file.php:1:1 - message
+        ERROR (1): SomeIssueType - file.php:1:1 - message
 
 
 
-EXPECTED, $report->create());
+        EXPECTED,$report->create());
     }
 
     public function issueData(int $errorLevel, string $type): IssueData

From 54239838fe0ab74128dbb8f89805f48fc4e81d17 Mon Sep 17 00:00:00 2001
From: Barney Laurance <barney@redmagic.org.uk>
Date: Fri, 2 Dec 2022 00:17:27 +0000
Subject: [PATCH 14/18] Fix error in ByIssueLvelAndTypeReport heading

---
 src/Psalm/Report/ByIssueLevelAndTypeReport.php | 2 +-
 tests/ByIssueLevelAndTypeReportTest.php        | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/Psalm/Report/ByIssueLevelAndTypeReport.php b/src/Psalm/Report/ByIssueLevelAndTypeReport.php
index d89a3112f34..90fc5b08d74 100644
--- a/src/Psalm/Report/ByIssueLevelAndTypeReport.php
+++ b/src/Psalm/Report/ByIssueLevelAndTypeReport.php
@@ -34,7 +34,7 @@ public function create(): string
 |                                                                                        |
 |    The level at which issue is reported as an error is given in brackets - e.g.        |
 |    `ERROR (2): MissingReturnType` indicates that MissingReturnType is only reported    |
-|    as an error when Psalm's level is set to 4 or below.                                |
+|    as an error when Psalm's level is set to 2 or below.                                |
 |                                                                                        |
 |    Issues are shown or hidden in this report according to current settings. For        |
 |    the most complete report set Psalm's error level to 0 or use --show-info=true       |
diff --git a/tests/ByIssueLevelAndTypeReportTest.php b/tests/ByIssueLevelAndTypeReportTest.php
index d6a741476c8..88a7feec282 100644
--- a/tests/ByIssueLevelAndTypeReportTest.php
+++ b/tests/ByIssueLevelAndTypeReportTest.php
@@ -37,7 +37,7 @@ public function testItGeneratesReport(): void
         |                                                                                        |
         |    The level at which issue is reported as an error is given in brackets - e.g.        |
         |    `ERROR (2): MissingReturnType` indicates that MissingReturnType is only reported    |
-        |    as an error when Psalm's level is set to 4 or below.                                |
+        |    as an error when Psalm's level is set to 2 or below.                                |
         |                                                                                        |
         |    Issues are shown or hidden in this report according to current settings. For        |
         |    the most complete report set Psalm's error level to 0 or use --show-info=true       |

From 6693421379c09d8c8e0d1621d926c08b70973bd6 Mon Sep 17 00:00:00 2001
From: Barney Laurance <barney@redmagic.org.uk>
Date: Fri, 2 Dec 2022 00:24:05 +0000
Subject: [PATCH 15/18] Code style fix

---
 tests/ByIssueLevelAndTypeReportTest.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tests/ByIssueLevelAndTypeReportTest.php b/tests/ByIssueLevelAndTypeReportTest.php
index 88a7feec282..023aa9936d8 100644
--- a/tests/ByIssueLevelAndTypeReportTest.php
+++ b/tests/ByIssueLevelAndTypeReportTest.php
@@ -69,7 +69,7 @@ public function testItGeneratesReport(): void
 
 
 
-        EXPECTED,$report->create());
+        EXPECTED, $report->create());
     }
 
     public function issueData(int $errorLevel, string $type): IssueData

From a29f65ecfe659da4412f42092985099b398f5ba7 Mon Sep 17 00:00:00 2001
From: Barney Laurance <barney@redmagic.org.uk>
Date: Fri, 2 Dec 2022 00:24:44 +0000
Subject: [PATCH 16/18] Fix too lax function visibility in test

---
 tests/ByIssueLevelAndTypeReportTest.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tests/ByIssueLevelAndTypeReportTest.php b/tests/ByIssueLevelAndTypeReportTest.php
index 023aa9936d8..671e63f4419 100644
--- a/tests/ByIssueLevelAndTypeReportTest.php
+++ b/tests/ByIssueLevelAndTypeReportTest.php
@@ -72,7 +72,7 @@ public function testItGeneratesReport(): void
         EXPECTED, $report->create());
     }
 
-    public function issueData(int $errorLevel, string $type): IssueData
+    private function issueData(int $errorLevel, string $type): IssueData
     {
         return new IssueData(
             'error',

From ad5772759334171b53f521642feae4941317aa28 Mon Sep 17 00:00:00 2001
From: Barney Laurance <barney@redmagic.org.uk>
Date: Fri, 2 Dec 2022 00:27:51 +0000
Subject: [PATCH 17/18] Sort issue by position in codebase in
 ByIssueLevelAndTypeReport if level & type equal

PHP sorting only became stable in 8.0. For previous versions we would
still like duplicate issues to be sorted into a logical order.
---
 src/Psalm/Report/ByIssueLevelAndTypeReport.php | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/Psalm/Report/ByIssueLevelAndTypeReport.php b/src/Psalm/Report/ByIssueLevelAndTypeReport.php
index 90fc5b08d74..6863d487fe2 100644
--- a/src/Psalm/Report/ByIssueLevelAndTypeReport.php
+++ b/src/Psalm/Report/ByIssueLevelAndTypeReport.php
@@ -180,8 +180,8 @@ private function sortIssuesByLevelAndType(): void
     {
         usort($this->issues_data, function (IssueData $left, IssueData $right): int {
             // negative error levels go to the top, followed by large positive levels, with level 1 at the bottom.
-            return [$left->error_level > 0, -$left->error_level, $left->type] <=>
-                [$right->error_level > 0, -$right->error_level, $right->type];
+            return [$left->error_level > 0, -$left->error_level, $left->type, $left->file_path, $left->file_name, $left->line_from] <=>
+                [$right->error_level > 0, -$right->error_level, $right->type, $right->file_path, $right->file_name, $right->line_from];
         });
     }
 }

From 1dbdf7882c196513bc9bee3acf8ca3b003ca72cd Mon Sep 17 00:00:00 2001
From: Barney Laurance <barney@redmagic.org.uk>
Date: Fri, 2 Dec 2022 00:40:01 +0000
Subject: [PATCH 18/18] Code style fix

---
 src/Psalm/Report/ByIssueLevelAndTypeReport.php | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/src/Psalm/Report/ByIssueLevelAndTypeReport.php b/src/Psalm/Report/ByIssueLevelAndTypeReport.php
index 6863d487fe2..85169c8121f 100644
--- a/src/Psalm/Report/ByIssueLevelAndTypeReport.php
+++ b/src/Psalm/Report/ByIssueLevelAndTypeReport.php
@@ -180,8 +180,11 @@ private function sortIssuesByLevelAndType(): void
     {
         usort($this->issues_data, function (IssueData $left, IssueData $right): int {
             // negative error levels go to the top, followed by large positive levels, with level 1 at the bottom.
-            return [$left->error_level > 0, -$left->error_level, $left->type, $left->file_path, $left->file_name, $left->line_from] <=>
-                [$right->error_level > 0, -$right->error_level, $right->type, $right->file_path, $right->file_name, $right->line_from];
+            return [$left->error_level > 0, -$left->error_level, $left->type,
+                    $left->file_path, $left->file_name, $left->line_from]
+                <=>
+                [$right->error_level > 0, -$right->error_level, $right->type,
+                    $right->file_path, $right->file_name, $right->line_from];
         });
     }
 }