stevebauman / unfinalize
Permanently remove final keywords from vendor packages.
Installs: 8 759
Dependents: 1
Suggesters: 0
Security: 0
Stars: 136
Watchers: 4
Forks: 5
Open Issues: 0
Type:project
Requires
- php: ^8.1
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.16
- laravel-zero/framework: ^10.0.2
- laravel/pint: ^1.8
- mockery/mockery: ^1.5.1
- nunomaduro/termwind: ^1.15.1
- pestphp/pest: ^2.5
- spatie/ray: ^1.39
README
Unleash the freedom lost with open source PHP packages marking classes and methods as final
.
Unfinalize uses PHP CS Fixer to permanently remove final
keywords from composer vendor packages:
- final class Foo + class Foo { - final public function bar() + public function bar() { // ... } }
- Updates to PHP files are done safely, quickly, and performant.
- Changes are stored permanently. There is no performance impact using Unfinalize.
- No additional dependencies to your application. Unfinalize and its dependencies are compiled into a single phar file.
Installation
composer require stevebauman/unfinalize
Usage
You may unfinalize files using two different methods: file paths, or package paths.
File Paths
Using files paths allow you to unfinalize specific files or directories by specifying them in the command:
php vendor/bin/unfinalize run vendor/package/src/File.php
You may unfinalize multiple files or directories by separating them by a space:
php vendor/bin/unfinalize run vendor/package/src/Foo/ vendor/package/src/Bar/File.php
To make sure this is always done on your project's dependencies, add the command to your composer.json
file in the scripts
property:
{ "scripts": { "post-update-cmd": [ "@php vendor/bin/unfinalize run vendor/package/src/Foo/ vendor/package/src/Bar/File.php" ] } }
Then run composer update
.
Package Paths
Using package paths allow you to unfinalize entire packages by specifying them in your composer.json
file.
Add the vendor packages you want to remove the final keywords from inside an unfinalize
property:
{ "unfinalize": [ "vendor/package" ] }
Add the unfinalize command to your composer.json
so it runs on composer update
:
{ "scripts": { "post-update-cmd": [ "@php vendor/bin/unfinalize run" ] } }
Then, run composer update
.
Options
--annotate={annotation}
If you would like final classes and methods to be marked with an annotation (@{annotation}
) doc
block after unfinalizing, you may add the --annotate
option to the unfinalize command:
If an annotation already exists in a doc block then it will be left untouched.
{ "scripts": { "post-update-cmd": [ "@php vendor/bin/unfinalize run --annotate=internal" ] } }
Which will produce:
Before:
final class Foo { final public function bar() { // ... } }
After:
/** * @internal */ class Foo { /** * @internal */ public function bar() { // ... } }
--properties={protected/public}
If you would like to change the visibility of private
properties to
protected
or public
, you may add the --properties
option to
the unfinalize command with the new visibility to assign:
{ "scripts": { "post-update-cmd": [ "@php vendor/bin/unfinalize run --properties=protected" ] } }
Which will produce:
Before:
class Foo { private $bar; }
After:
class Foo { protected $bar; }
--methods={protected/public}
If you would like to change the visibility of private
methods to
protected
or public
, you may add the --methods
option
to the unfinalize command with the new visibility to assign:
{ "scripts": { "post-update-cmd": [ "@php vendor/bin/unfinalize run --methods=public" ] } }
Which will produce:
Before:
class Foo { private function bar() { } }
After:
class Foo { public function bar() { } }
--dry
Execute a dry run to see what files will be modified by Unfinalize:
vendor/bin/unfinalize run --dry