README.md

PHP Insights was created by, and is maintained by Nuno Maduro, and is the perfect starting point to analyze the code quality of your PHP projects. Carefully crafted to simplify the analysis of your code directly from your terminal.

✨ Features

• Analysis of code quality and coding style
• Beautiful overview of code architecture and it's complexity
• Contains built-in checks for making code reliable, loosely coupled, simple, and clean
• Friendly console interface build on top of PHPCS, PHPLOC, and EasyCodingStandard

?? Installation & Usage

Requires:

• PHP 7.2+

First, install PHP Insights via the Composer package manager:

composer require nunomaduro/phpinsights --dev

Then, use the phpinsights binary:

php ./vendor/bin/phpinsights

Within Laravel

First, you should publish the config-file with:

php artisan vendor:publish --provider="NunoMaduro\PhpInsights\Application\Adapters\Laravel\InsightsServiceProvider"

Then, use the insights Artisan command:

php artisan insights

Within Symfony

First, you should create the config-file with:

cp vendor/nunomaduro/phpinsights/stubs/symfony.php phpinsights.php

Then, use the phpinsights binary:

php ./vendor/bin/phpinsights

Display issues omitted

PHP Insights console command have different verbosity levels, which determine the quantity of issues displayed. By default, commands display only the 3 first issues per Insight, but you can display them all with the -v option:

php ./vendor/bin/phpinsights -v

? How to contribute

The project is under development. As such, any help is welcome!

1. Create a new insight from scratch
2. Add a new insight from PHP CS Sniff
3. Create or improve create a preset for your favorite framework
4. Create the test suite

Create a new Insight

Imagine that you want to create a new Insight that doesn't allow the usage of final classes:

1. Create a new file under src/Domain/Insights with the content:

final class ForbiddenFinalClasses extends Insight
{
    /**
     * {@inheritdoc}
     */
    public function hasIssue(): bool
    {
        return (bool) count($this->collector->getConcreteFinalClasses());
    }

    /**
     * {@inheritdoc}
     */
    public function getTitle(): string
    {
        return 'The use of `final` classes is prohibited';
    }
}

1. Attach the Insight to a specific inside src/Domain/Metrics:

final class Classes implements HasInsights
{
    // ...

    /**
     * {@inheritdoc}
     */
    public function getInsights(): array
    {
        return [
            ForbiddenFinalClasses::class,
        ];
    }
}

Add a new insight from PHP CS Sniff

Are you aware of a PHPCS sniff that you would like to add to PHP Insights? You can add it in the following way:

1. Identify the related metric, and add it to the list of insights:

final class Classes implements HasInsights
{
    // ...

    /**
     * {@inheritdoc}
     */
    public function getInsights(): array
    {
        return [
            UnusedPropertySniff::class,
        ];
    }
}

Create or improve create a preset for your favorite framework

Would you like to exclude a directory or remove an Insight for your favorite framework? You can add it in the following way:

In this example we are going to use the Laravel Framework.

1. Open the file src/Application/Adapters/Laravel/Preset.php and update the config file:

/**
 * @internal
 */
final class Preset implements PresetContract
{
    /**
     * {@inheritDoc}
     */
    public static function getName(): string
    {
        return 'laravel';
    }

    /**
     * {@inheritDoc}
     */
    public static function get(): array
    {
        return [
            'exclude' => [
                'storage',
                'resources',
                'bootstrap',
                'database',
                'server.php',
            ],
            'add' => [
                // ...
            ],
            'remove' => [
                // ...
            ],
            'config' => [
                ForbiddenDefineGlobalConstants::class => [
                    'ignore' => ['LARAVEL_START'],
                ],
            ],
        ];
    }
}

Create the test suite

At the moment, this package doesn't have any test. Would you like to contribute? This is the perfect task.

? Contributors

Thank you to all the people who have already contributed to PHP Insights!

Nuno Maduro

Caneco

Quynh Xuan Nguyen

Mike Erickson

Viktor Szépe

Owen Voke

? License

PHP Insights is open-sourced software licensed under the MIT license.