stevebauman/unfinalize

Permanently remove final keywords from vendor packages.

Installs: 2 359

Dependents: 0

Suggesters: 0

Security: 0

Stars: 127

Watchers: 4

Forks: 6

Open Issues: 0

Type:project

v2.1.0 2023-12-26 12:35 UTC

This package is auto-updated.

Last update: 2024-02-04 18:10:36 UTC


README

Unleash the freedom lost with open source PHP packages marking classes and methods as final.

68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f73746576656261756d616e2f756e66696e616c697a652f72756e2d74657374732e796d6c3f6272616e63683d6d6173746572267374796c653d666c61742d737175617265 68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f73746576656261756d616e2f756e66696e616c697a652e7376673f7374796c653d666c61742d737175617265 68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f73746576656261756d616e2f756e66696e616c697a652e7376673f7374796c653d666c61742d737175617265 68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f73746576656261756d616e2f756e66696e616c697a652e7376673f7374796c653d666c61742d737175617265

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 space separating them:

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