danog/psalm-plugin-laravel
1
0
Fork 0
mirror of https://github.com/danog/psalm-plugin-laravel.git synced 2025-01-22 13:21:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat: suppress well-known unused classes/methods

Browse Source
This commit is contained in:
Claas Augner 2021-07-13 11:43:26 +02:00
parent c8a20f0cce
commit 74b363449f
1 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
src/Handlers/SuppressHandler.php
View File

@ -7,10 +7,29 @@ use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Notifications\Notification;
use Psalm\Plugin\EventHandler\AfterClassLikeVisitInterface;
use Psalm\Plugin\EventHandler\Event\AfterClassLikeVisitEvent;
use Psalm\Storage\MethodStorage;
use function array_key_exists;
use function in_array;
class SuppressHandler implements AfterClassLikeVisitInterface
{
private const UNUSED_CLASSES = [
"App\Console\Kernel",
"App\Exceptions\Handler",
"App\Http\Controllers\Controller",
"App\Http\Kernel",
"App\Http\Middleware\Authenticate",
"App\Http\Middleware\TrustHosts",
"App\Providers\AppServiceProvider",
"App\Providers\AuthServiceProvider",
"App\Providers\BroadcastServiceProvider",
"App\Providers\EventServiceProvider",
];
private const UNUSED_METHODS = [
"App\Http\Middleware\RedirectIfAuthenticated" => ["handle"],
];
public static function afterClassLikeVisit(AfterClassLikeVisitEvent $event)
{
$storage = $event->getStorage();
@ -36,5 +55,20 @@ class SuppressHandler implements AfterClassLikeVisitInterface
if (in_array(Notification::class, $storage->parent_classes) && !in_array('PropertyNotSetInConstructor', $storage->suppressed_issues)) {
$storage->suppressed_issues[] = 'PropertyNotSetInConstructor';
}
// Suppress UnusedClass on well-known classes.
if (in_array($storage->name, self::UNUSED_CLASSES)) {
$storage->suppressed_issues[] = 'UnusedClass';
}
// Suppress PossiblyUnusedMethod on well-known methods.
if (array_key_exists($storage->name, self::UNUSED_METHODS)) {
foreach (self::UNUSED_METHODS[$storage->name] as $method_name) {
$method = $storage->methods[$method_name] ?? null;
if ($method instanceof MethodStorage) {
$method->suppressed_issues[] = 'PossiblyUnusedMethod';
}
}
}
}
}