tomasvotruba/type-coverage

Measure type coverage of your project

0.2.1 2023-08-27 10:33 UTC

Requires

• php: ^7.2 || ^8.0
• nette/utils: ^3.2 || ^4.0
• phpstan/phpstan: ^1.9.3

MIT

• static analysis
• phpstan-extension

README

PHPStan uses type declarations to determine the type of variables, properties and other expression. Sometimes it's hard to see what PHPStan errors are the important ones among thousands of others.

Instead of fixing all PHPStan errors at once, we can start with minimal require type coverage.

What is the type coverage you ask? We have 3 type possible declarations in total here:

final class ConferenceFactory
{
    private $talkFactory;

    public function createConference(array $data)
    {
        $talks = $this->talkFactory->create($data);

        return new Conference($talks);
    }
}

The param type is defined, but property and return types are missing.

• 1 out of 3 = 33 % coverage

How do we get to the 100 %?

 final class ConferenceFactory
 {
-    private $talkFactory;
+    private TalkFactory $talkFactory;

-    public function createConference(array $data)
+    public function createConference(array $data): Conference
     {
         $talks = $this->talkFactory->create($data);

         return new Conference($talks);
     }
 }

This technique is very simple and useful to start with even on legacy project. You also know, how high coverage your project has right now.

Install

composer require tomasvotruba/type-coverage --dev

The package is available on PHP 7.2-8.1 versions in tagged releases.

Usage

With PHPStan extension installer, everything is ready to run.

Enable each item on their own with simple configuration:

# phpstan.neon
parameters:
    type_coverage:
        return_type: 50
        param_type: 30
        property_type: 70