1
0
mirror of https://github.com/danog/psalm.git synced 2024-11-27 04:45:20 +01:00
psalm/bin/generate_levels_doc.php
2020-02-17 22:05:58 -05:00

60 lines
1.5 KiB
PHP

<?php
require_once(dirname(__DIR__) . '/vendor/autoload.php');
$issue_types = \Psalm\Config\IssueHandler::getAllIssueTypes();
$grouped_issues = [];
foreach ($issue_types as $issue_type) {
$issue_class = 'Psalm\\Issue\\' . $issue_type;
if (!class_exists($issue_class) || !is_a($issue_class, \Psalm\Issue\CodeIssue::class, true)) {
throw new Exception($issue_class . ' is not a Codeissue');
}
/** @var int */
$issue_level = $issue_class::ERROR_LEVEL;
$grouped_issues[$issue_level][] = $issue_type;
}
?>
## Always treated as errors
<?php
foreach ($grouped_issues[-1] as $issue_type) {
echo ' - [' . $issue_type . '](issues.md#' . strtolower($issue_type) . ')' . "\n";
}
?>
## Errors that only appear at level 1
<?php
foreach ($grouped_issues[1] as $issue_type) {
echo ' - [' . $issue_type . '](issues.md#' . strtolower($issue_type) . ')' . "\n";
}
?>
<?php
foreach ([2, 3, 4, 5, 6, 7] as $level) {
echo '## Errors ignored at level ' . ($level + 1) . ($level < 7 ? ' and higher' : '') . "\n\n";
echo 'These issues are treated as errors at level ' . $level . ' and below.' . "\n\n";
foreach ($grouped_issues[$level] as $issue_type) {
echo ' - [' . $issue_type . '](issues.md#' . strtolower($issue_type) . ')' . "\n";
}
echo "\n";
}
?>
## Feature-specific errors
<?php
foreach ($grouped_issues[-2] as $issue_type) {
echo ' - [' . $issue_type . '](issues.md#' . strtolower($issue_type) . ')' . "\n";
}
?>