Skip to content

fix: apply final before the class keyword, obey the suppressions #11542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 6.x
Choose a base branch
from
Open

fix: apply final before the class keyword, obey the suppressions #11542

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 18 additions & 13 deletions src/Psalm/Internal/Codebase/ClassLikes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,14 @@
use function preg_quote;
use function preg_replace;
use function strlen;
use function strpos;
use function strrpos;
use function strtolower;
use function substr;

use const PHP_EOL;
use const PREG_OFFSET_CAPTURE;

const NEW_LINE_LENGTH = 1;
/**
* @internal
*
Expand Down Expand Up @@ -868,27 +869,31 @@ public function consolidateAnalyzedData(Methods $methods, ?Progress $progress, b
&& !$classlike_storage->is_enum
&& !$classlike_storage->is_interface
) {
$codeIssue = new ClassMustBeFinal(
'Class ' . $classlike_storage->name
. ' is never extended and is not part of the public API, and thus must be made final.',
$classlike_storage->location,
$classlike_storage->name,
);
IssueBuffer::maybeAdd(
new ClassMustBeFinal(
'Class ' . $classlike_storage->name
. ' is never extended and is not part of the public API, and thus must be made final.',
$classlike_storage->location,
$classlike_storage->name,
),
$codeIssue,
$classlike_storage->suppressed_issues,
true,
);

if ($codebase->alter_code
&& $classlike_storage->stmt_location !== null
&& !IssueBuffer::isSuppressed($codeIssue, $classlike_storage->suppressed_issues)
&& isset($project_analyzer->getIssuesToFix()['ClassMustBeFinal'])
) {
$selection = $classlike_storage->stmt_location->getSnippet();
$insert_pos = strpos($selection, "class");

if ($insert_pos === false) {
$insert_pos = $classlike_storage->stmt_location->getSelectionBounds()[0];
}
$bounds = $classlike_storage->stmt_location->getSnippetBounds();

preg_match("/\n(?:readonly\s)?class\s/", $selection, $matches, PREG_OFFSET_CAPTURE);
$insert_pos = match (true) {
!empty($matches) && isset($matches[0][1]) => $matches[0][1] + $bounds[0] + NEW_LINE_LENGTH,
default => $classlike_storage->stmt_location->getSelectionBounds()[0]
};

FileManipulationBuffer::add($classlike_storage->stmt_location->file_path, [
new FileManipulation($insert_pos, $insert_pos, 'final ', true),
Expand Down
Loading