Skip to content

A Psalm plugin to ensure your classes are marked final!

Notifications You must be signed in to change notification settings

cspray/phinal

Repository files navigation

Phinal

Do you like final? Really like it? Then enforce it on all your classes! When you have to fallback to inheritance you can do so by explicitly marking your class with an Attribute and explaining why it should be inherited.

Installation

Running Psalm 5

composer require --dev cspray/phinal
vendor/bin/psalm-plugin enable cspray/phinal

Running Psalm 4

composer require --dev cspray/phinal:1.0.0
vendor/bin/psalm-plugin enable cspray/phinal

Code Examples

Good! 👍

<?php declare(strict_types=1);

use Cspray\Phinal\AllowInheritance;

final class ProperlyMarkedFinal {}

#[AllowInheritance('Explain why you would need to inherit this.')]
class YouCanInheritThis {}

Bad! 👎

<?php declare(strict_types=1);

class NotMarkedFinal {}

Why do you need to inherit this? You probably don't need to and should mark it final!