PHP Insights

PHP Insights organizes its code analysis into several distinct metric domains. When reviewing reports or configuring specific rules, you can categorize them by these domains:

• NunoMaduro\PhpInsights\Domain\Metrics\Code\Classes: Rules related to class structure and properties.
• NunoMaduro\PhpInsights\Domain\Metrics\Code\Code: Rules related to general code syntax, logic, and formatting.
• NunoMaduro\PhpInsights\Domain\Metrics\Code\Comments: Rules related to documentation and comments.
• NunoMaduro\PhpInsights\Domain\Metrics\Code\Functions: Rules related to function and method usage.
• NunoMaduro\PhpInsights\Domain\Metrics\Code\Globally: Rules applied globally across the codebase.

Before configuring PHP Insights, create a phpinsights.php file in your project root. The file should return an array with the following structure:

<?php

declare(strict_types=1);

return [
    'preset' => 'default',
    'exclude' => [
        // 'path/to/directory-or-file'
    ],
    'add' => [
        // ExampleMetric::class => [
        //     ExampleInsight::class,
        // ]
    ],
    'remove' => [
        // ExampleInsight::class,
    ],
    'config' => [
        // ExampleInsight::class => [
        //     'key' => 'value',
        // ],
    ],
];

After installation, you can execute the analysis tool by running the binary located in your vendor directory.

./vendor/bin/phpinsights

To use PHP Insights with GitLab Code Quality, use the --format=codeclimate option and redirect the output to a JSON file. You must then define this file as a codequality report artifact in your .gitlab-ci.yml.

#.gitlab-ci.yml
insights:
  script:
    - vendor/bin/phpinsights -n --ansi --format=codeclimate > codeclimate-report.json
  artifacts:
    reports:
      codequality: codeclimate-report.json

To customize PHP Insights in a Symfony project, create a configuration file by copying the Symfony stub to your project root as phpinsights.php.

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

Execute the phpinsights binary directly from your vendor directory. Use the appropriate path for your operating system.

# Mac & Linux
./vendor/bin/phpinsights

# Windows
.\vendor\bin\phpinsights.bat

Since version 1.10, PhpInsights can include clickable file links in its output. To enable this, add the ide key to your phpinsights.php configuration file with the name of your editor or a custom URL template.

Supported IDE values:

• phpstorm
• sublime
• textmate
• macvim
• emacs
• atom
• vscode

<?php

return [
    // ...
    'ide' => 'vscode',
    // ...
];

To include an existing PHP CS Sniff as an insight, identify the appropriate metric class in src/Domain/Metrics and add the sniff's class name to its getInsights() array.

final class Classes implements HasInsights
{
    public function getInsights(): array
    {
        return [
            UnusedPropertySniff::class,
        ];
    }
}

Run PHP Insights using a Docker container by mounting your current working directory to /app.

docker run -it --rm -v "$(pwd):/app" nunomaduro/phpinsights