PHP Insights

https://github.com/nunomaduro/phpinsights
Admin
PHP Insights was carefully crafted to simplify the analysis of your code directly from your...
Tokens:31,871
Snippets:364
Trust Score:10
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Install and run PHP Insights

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/readme.md

Install PHP Insights as a dev dependency using Composer, then run the analysis tool from the vendor bin directory.

```bash
# First, install:
composer require nunomaduro/phpinsights --dev

# Then, use it:
./vendor/bin/phpinsights
```

--------------------------------

### Install PHP Insights via Composer

Source: https://github.com/nunomaduro/phpinsights/blob/master/README.md

Install PHP Insights as a development dependency using Composer. This command is the first step in the quick start guide.

```bash
composer require nunomaduro/phpinsights --dev
```

--------------------------------

### Configure DeclareEqualNormalizeFixer

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/code.md

Configuration example for the DeclareEqualNormalizeFixer, setting the 'space' option to 'none'. Possible values are 'none' and 'single'.

```php
\PhpCsFixer\Fixer\LanguageConstruct\DeclareEqualNormalizeFixer::class => [
    'space' => 'none', // possible values ['none', 'single']
]
```

--------------------------------

### Configure LineLengthSniff limits in phpinsights

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/README.md

Use the 'config' section to override default insight settings. This example increases the line length limits for the LineLengthSniff.

```php
    'config' => [
        \PHP_CodeSniffer\Standards\Generic\Sniffs\Files\LineLengthSniff::class => [
            'lineLimit' => 120,
            'absoluteLineLimit' => 160
        ]
    ]
```

--------------------------------

### Run PHP Insights from the terminal

Source: https://github.com/nunomaduro/phpinsights/blob/master/README.md

Execute PHP Insights from the vendor bin directory to analyze your PHP project. This is the basic usage after installation.

```bash
./vendor/bin/phpinsights
```

--------------------------------

### Configure NoMixedEchoPrintFixer to use echo

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/code.md

Configuration for the NoMixedEchoPrintFixer insight, which enforces using either print or echo. The 'use' option accepts 'echo' or 'print'. This example sets it to 'echo'.

```php
\PhpCsFixer\Fixer\Alias\NoMixedEchoPrintFixer::class => [
    'use' => 'echo' // possibles values ['echo', 'print']
]
```

--------------------------------

### Configure UselessFunctionDocCommentSniff with traversableTypeHints

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/code.md

Configuration example for the UselessFunctionDocCommentSniff sniff. The 'traversableTypeHints' option can be set to enforce specific type hints. The example shows an empty array as the default value.

```php
SlevomatCodingStandard\Sniffs\Commenting\UselessFunctionDocCommentSniff::class => [
    'traversableTypeHints' => []
]
```

--------------------------------

### Avoid Composer conflicts with bamarni/composer-bin-plugin

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/get-started.md

Install PHP Insights in isolation using bamarni/composer-bin-plugin.

```bash
composer require --dev bamarni/composer-bin-plugin
composer bin phpinsights require nunomaduro/phpinsights
./vendor/bin/phpinsights
```

--------------------------------

### Exclude folders and files with the exclude key

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/README.md

Example of adding entries to the `exclude` key in `phpinsights.php` to skip specific folders, files matching a pattern, or individual files from analysis. Use `*` as a wildcard to match multiple files.

```php
    'exclude' => [
        'src/Migrations', // will exclude Migrations Folder in src
        '*Repository.php', // will exclude every php files that match pattern
        'src/Kernel.php' // will exclude this file only
    ],
```

--------------------------------

### Configure MethodArgumentSpaceFixer

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/architecture.md

Configuration example for the MethodArgumentSpaceFixer insight. Sets options for heredoc handling, multiline enforcement, and spacing after commas. The 'on_multiline' option accepts 'ignore', 'ensure_single_line', or 'ensure_fully_multiline'.

```php
\PhpCsFixer\Fixer\FunctionNotation\MethodArgumentSpaceFixer::class => [
    'after_heredoc' => false,
    'ensure_fully_multiline' => false,
    'keep_multiple_spaces_after_comma' => false,
    'on_multiline' => 'ignore' // possible values ['ignore', 'ensure_single_line', 'ensure_fully_multiline']
]
```

--------------------------------

### Configure indentation for PHP-CS-Fixer insights

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/README.md

For PHP-CS-Fixer insights implementing WhitespacesAwareFixerInterface (available in version ^2.0), use the 'configure' section to set the indentation. This example sets two spaces for the BracesFixer.

```php
    'configure' => [
        \PhpCsFixer\Fixer\Basic\BracesFixer::class => [
            'indent' => '  ',
		],
    ],
```

--------------------------------

### PHPInsights Unused Parameter Error Output

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/README.md

Example output from running vendor/bin/phpinsights showing an unused parameter error in src/YourClass.php at line 19.

```bash
• [Code] Unused parameter:
  src/YourClass.php:19: Unused parameter $thisIsUnusedParameter.
```

--------------------------------

### Configure ArrayIndentSniff indent option

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/code.md

Configuration example for the Array indent sniff, setting the indent to 4 spaces. This is used to customize the sniff's behavior.

```php
\PHP_CodeSniffer\Standards\Generic\Sniffs\Arrays\ArrayIndentSniff::class => [
    'indent' => 4,
]
```

--------------------------------

### Configure FunctionLengthSniff (v2.0)

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/architecture.md

Configuration example for the v2.0 FunctionLengthSniff insight, setting 'maxLinesLength' to 20. Use this in your PHP Insights configuration to limit function length.

```php
\SlevomatCodingStandard\Sniffs\Functions\FunctionLengthSniff::class => [
    'maxLinesLength' => 20,
]
```

--------------------------------

### Configure FunctionLengthSniff (v1.0)

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/architecture.md

Configuration example for the v1.0 FunctionLengthSniff insight, setting 'maxLength' to 20. Use this in your PHP Insights configuration to limit function length.

```php
\ObjectCalisthenics\Sniffs\Files\FunctionLengthSniff::class => [
    'maxLength' => 20,
]
```

--------------------------------

### Nullable type for null default value example

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/code.md

Shows a function with a parameter missing the nullable `?` symbol and a correct one. The sniff flags the missing `?` on `int $foo = null`.

```php
function foo(
    int $foo = null, // ? missing
    ?int $bar = null // correct
) {
    // ...
}
```

--------------------------------

### Exclude Insight with @phpcsSuppress Annotation

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/README.md

Example of using the @phpcsSuppress annotation with the SlevomatCodingStandard.Functions.UnusedParameter sniff name to exclude the insight for a specific method.

```php
final class YourClass
{
    /**
     * @phpcsSuppress SlevomatCodingStandard.Functions.UnusedParameter
     */
    public function yourMethod(array $thisIsUnusedParameter): void
    {
        // ...
    }
}
```

--------------------------------

### Exclude an insight for specific files in phpinsights

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/README.md

Configure the 'exclude' parameter on an insight to skip it for specific files. This example excludes the UnusedParameterSniff for two files.

```php
    'config' => [
        \SlevomatCodingStandard\Sniffs\Functions\UnusedParameterSniff::class => [
            'exclude' => [
                'src/Path/To/My/File.php',
                'src/Path/To/Other/File.php',
            ],
        ],
    ],
```

--------------------------------

### Create or improve a preset for Laravel

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/contribute.md

Example of a Laravel preset configuration that excludes directories and files, adds an insight, removes insights, and configures specific insights. This is used to customize PHP Insights for the Laravel framework.

```php
final class Preset implements PresetContract
{
    public static function getName(): string
    {
        return 'laravel';
    }

    public static function get(): array
    {
        return [
            'exclude' => [
                'config',
                'storage',
                'resources',
                'bootstrap',
                'nova',
                'database',
                'server.php',
                '_ide_helper.php',
                '_ide_helper_models.php',
                'public',
            ],
            'add' => [
                Classes::class => [
                    ForbiddenFinalClasses::class,
                ],
            ],

            'remove' => [
                AlphabeticallySortedUsesSniff::class,
                DeclareStrictTypesSniff::class,
                DisallowMixedTypeHintSniff::class,
                ForbiddenDefineFunctions::class,
                ForbiddenNormalClasses::class,
                ForbiddenTraits::class,
                TypeHintDeclarationSniff::class,
            ],

            'config' => [
                ForbiddenPrivateMethods::class => [
                    'title' => 'The usage of private methods is not idiomatic in Laravel.',
                ],
                ForbiddenDefineGlobalConstants::class => [
                    'ignore' => ['LARAVEL_START'],
                ],
                ForbiddenFunctionsSniff::class => [
                    'forbiddenFunctions' => [
                        'dd' => null,
                        'dump' => null,
                    ],
                ],
            ],
        ];
    }
}
```

--------------------------------

### Attach Insight to Metric: Classes

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/contribute.md

Example of attaching the ForbiddenFinalClasses insight to the Classes metric by adding it to the getInsights() method. This is the second step in creating a new Insight.

```php
final class Classes implements HasInsights
{
    // ...

    public function getInsights(): array
    {
        return [
            ForbiddenFinalClasses::class,
        ];
    }
}
```

--------------------------------

### Run PHP Insights with minimum quality thresholds

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/continuous-integration.md

Use these commands to run PHP Insights in CI with minimum quality, complexity, architecture, and style scores. The --no-interaction flag is mandatory in CI to avoid prompts. If the minimum levels are not reached, the console returns an exit error code. The first command is for a standard installation, the second for Laravel.

```bash
./vendor/bin/phpinsights --no-interaction --min-quality=80 --min-complexity=90 --min-architecture=75 --min-style=95

# Within Laravel
php artisan insights --no-interaction --min-quality=80 --min-complexity=90 --min-architecture=75 --min-style=95
```

--------------------------------

### GitHub Action workflow for PHP Insights

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/continuous-integration.md

This GitHub Actions workflow runs PHP Insights with the --format=github-action option to add annotations with issues to pull requests. It sets up PHP 8.0, installs dependencies, and runs the insights command.

```yaml
#.github/workflows/pr.yml
name: CI
on:
    - pull_request

jobs:
    phpinsights:
        runs-on: ubuntu-latest
        name: PHP Insights checks
        steps:
            - uses: actions/checkout@v2
            - uses: shivammathur/setup-php@v2
              with:
                  php-version: 8.0
            - run: composer install --prefer-dist --no-progress --no-suggest
            - run: vendor/bin/phpinsights -n --ansi --format=github-action
```

--------------------------------

### Add PHPCS Sniff to Metric: Classes

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/contribute.md

Example of adding a PHPCS sniff (UnusedPropertySniff) to the Classes metric by adding it to the getInsights() method. This is the way to add a new insight from a PHPCS sniff.

```php
final class Classes implements HasInsights
{
    // ...

    public function getInsights(): array
    {
        return [
            UnusedPropertySniff::class,
        ];
    }
}
```

--------------------------------

### Dead catch example: unreachable catch block

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/code.md

Shows a try-catch block where the second catch for \InvalidArgumentException is unreachable because the first catch for \Throwable already catches all exceptions. This triggers the DeadCatchSniff.

```php
try {
    doStuff();
} catch (\Throwable $e) {
    log($e);
} catch (\InvalidArgumentException $e) {
    // unreachable!
}
```

--------------------------------

### Create a new Insight: ForbiddenFinalClasses

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/contribute.md

Example of a new Insight class that prohibits final classes. It checks for concrete final classes and returns a title message. This is the first step in creating a new Insight.

```php
final class ForbiddenFinalClasses extends Insight
{
    public function hasIssue(): bool
    {
        return (bool) count($this->collector->getConcreteFinalClasses());
    }

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

--------------------------------

### Copy default config stub

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/configuration.md

Creates the phpinsights.php configuration file from the default stub.

```bash
cp vendor/nunomaduro/phpinsights/stubs/config.php phpinsights.php
```

--------------------------------

### Configure IDE in phpinsights.php

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/ide.md

Add the 'ide' key to your phpinsights.php config file. Set it to a supported IDE value like 'vscode'.

```php
<?php

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

--------------------------------

### Run PHP Insights binary

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/get-started.md

Run the phpinsights binary on Mac/Linux or Windows.

```bash
# Mac & Linux
./vendor/bin/phpinsights

# Windows
.\vendor\bin\phpinsights.bat
```

--------------------------------

### Configure LineLengthSniff

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the LineLengthSniff, setting line limits and comment handling.

```php
\PHP_CodeSniffer\Standards\Generic\Sniffs\Files\LineLengthSniff::class => [
    'lineLimit' => 80,
    'absoluteLineLimit' => 100,
    'ignoreComments' => false,
]
```

--------------------------------

### Run PHP Insights via Docker

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/get-started.md

Run PHP Insights using Docker, mounting the current directory.

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

--------------------------------

### Configure UseSpacingSniff

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the UseSpacingSniff, setting lines before first use, between use types, and after last use.

```php
\SlevomatCodingStandard\Sniffs\Namespaces\UseSpacingSniff::class => [
    'linesCountBeforeFirstUse' => 1,
    'linesCountBetweenUseTypes' => 0,
    'linesCountAfterLastUse' => 1,
]
```

--------------------------------

### Configure ClassDefinitionFixer

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration array for the ClassDefinitionFixer, setting multi_line_extends_each_single_line, single_item_single_line, and single_line to false.

```php
\PhpCsFixer\Fixer\ClassNotation\ClassDefinitionFixer::class => [
    'multi_line_extends_each_single_line' => false,
    'single_item_single_line' => false,
    'single_line' => false,
]
```

--------------------------------

### Copy Symfony config stub

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/configuration.md

Creates the phpinsights.php configuration file from the Symfony stub.

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

--------------------------------

### Push and tag release

Source: https://github.com/nunomaduro/phpinsights/blob/master/RELEASE.md

Pushes the changes and creates a tag for the new version, then pushes the tags.

```bash
git push
```

```bash
git tag {new_version}
```

```bash
git push --tags
```

--------------------------------

### Specify composer file

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/get-started.md

Specify a custom composer file using the --composer flag.

```bash
./vendor/bin/phpinsights analyse --composer=/var/www/composer.json
```

--------------------------------

### Configure NamespaceSpacingSniff lines count

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for SlevomatCodingStandard\Sniffs\Namespaces\NamespaceSpacingSniff to set the number of lines before and after the namespace declaration. Both keys default to 1.

```php
\SlevomatCodingStandard\Sniffs\Namespaces\NamespaceSpacingSniff::class => [
    'linesCountBeforeNamespace' => 1,
    'linesCountAfterNamespace' => 1,
]
```

--------------------------------

### Display all issues with -v

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/get-started.md

Use the -v option to display all issues instead of only the first 3 per Insight.

```bash
./vendor/bin/phpinsights -v
```

--------------------------------

### Copy Magento2 config stub

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/configuration.md

Creates the phpinsights.php configuration file from the Magento2 stub.

```bash
cp vendor/nunomaduro/phpinsights/stubs/magento2.php phpinsights.php
```

--------------------------------

### Configure OrderedImportsFixer

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the OrderedImportsFixer insight, setting the import order and sort algorithm. The sort_algorithm can be 'alpha', 'length', or 'none'.

```php
\PhpCsFixer\Fixer\Import\OrderedImportsFixer::class => [
    'imports_order' => ['class', 'const', 'function'],
    'sort_algorithm' => 'alpha', // possible values ['alpha', 'length', 'none']
]
```

--------------------------------

### Create phpinsights.php configuration file

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/README.md

Base configuration file structure for PHP Insights. Create this file as `phpinsights.php` in your project root. The `preset` key is set to 'default' by default; you can customize the `exclude`, `add`, `remove`, and `config` arrays as needed.

```php
<?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',
        //  ],
    ],
];
```

--------------------------------

### Configure MethodCyclomaticComplexityIsHigh Insight

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/complexity.md

Configuration for the MethodCyclomaticComplexityIsHigh insight. Sets the maximum method complexity to 5. This insight raises an issue when a method's cyclomatic complexity exceeds this value.

```php
\NunoMaduro\PhpInsights\Domain\Insights\MethodCyclomaticComplexityIsHigh::class => [
     'maxMethodComplexity' => 5,
]
```

--------------------------------

### Configure BinaryOperatorSpacesFixer alignment and spacing

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the BinaryOperatorSpacesFixer insight. Allows setting alignment for double arrows and equals, and a default fix strategy. Possible values are documented in comments.

```php
\PhpCsFixer\Fixer\Operator\BinaryOperatorSpacesFixer::class => [
    'align_double_arrow' => false, // Whether to apply, remove or ignore double arrows alignment: possibles values [true, false, null]
    'align_equals' => false, // Whether to apply, remove or ignore equals alignment: possibles values [true, false, null]
    'default' => 'single_space', // default fix strategy: possibles values ['align', 'align_single_space', 'align_single_space_minimal', 'single_space', 'no_space', null]
]
```

--------------------------------

### Custom IDE URL template in phpinsights.php

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/ide.md

For unsupported editors, set 'ide' to a URL template with %f for file path and %l for line number.

```php
<?php

return [
    // ...
    'ide' => 'myide://open?url=file://%f&line=%l',
    // ...
];
```

--------------------------------

### Analyse multiple paths in Laravel

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/get-started.md

Run the insights command with multiple paths in Laravel.

```bash
php artisan insights path/to/dir path/to/file.php
```

--------------------------------

### Configure ScopeClosingBraceSniff

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the ScopeClosingBraceSniff, setting the indent to 4 spaces.

```php
\PHP_CodeSniffer\Standards\PEAR\Sniffs\WhiteSpace\ScopeClosingBraceSniff::class => [
    'indent' => 4,
]
```

--------------------------------

### Save output to file

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/get-started.md

Pipe the JSON output to a file. Remember to add the -n flag to avoid interaction.

```bash
./vendor/bin/phpinsights analyse --format=json > test.json
```

--------------------------------

### Configure NoWhitespaceBeforeCommaInArrayFixer

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the NoWhitespaceBeforeCommaInArrayFixer insight. The 'after_heredoc' option controls whether whitespace between a heredoc end and a comma should be removed.

```php
\PhpCsFixer\Fixer\ArrayNotation\NoWhitespaceBeforeCommaInArrayFixer::class => [
    'after_heredoc' => false, // Whether the whitespace between heredoc end and comma should be removed.
]
```

--------------------------------

### Configure NoExtraBlankLinesFixer tokens

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the NoExtraBlankLinesFixer insight, which removes extra blank lines. The 'tokens' option accepts an array of possible values including 'break', 'case', 'continue', 'curly_brace_block', 'default', 'extra', 'parenthesis_brace_block', 'return', 'square_brace_block', 'switch', 'throw', 'use', 'use_trait'.

```php
\PhpCsFixer\Fixer\Whitespace\NoExtraBlankLinesFixer::class => [
    'tokens' => ['extra'], // possibles values ['break', 'case', 'continue', 'curly_brace_block', 'default', 'extra', 'parenthesis_brace_block', 'return', 'square_brace_block', 'switch', 'throw', 'use', 'use_trait']
]
```

--------------------------------

### Configure ReturnTypeHintSpacingSniff

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the ReturnTypeHintSpacingSniff to set the number of spaces before the colon in return type hints. Set 'spacesCountBeforeColon' to 0 for no space.

```php
\SlevomatCodingStandard\Sniffs\TypeHints\ReturnTypeHintSpacingSniff::class => [
    'spacesCountBeforeColon' => 0,
]
```

--------------------------------

### Configure ElementNameMinimalLengthSniff

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/code.md

Configuration for the ElementNameMinimalLengthSniff, setting a minimum length of 3 and allowing short names like 'i', 'id', 'to', 'up'.

```php
\ObjectCalisthenics\Sniffs\NamingConventions\ElementNameMinimalLengthSniff::class => [
    'minLength' => 3,
    'allowedShortNames' => ['i', 'id', 'to', 'up'],
]
```

--------------------------------

### Analyse a path in Laravel

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/get-started.md

Run the insights command with a path in Laravel.

```bash
php artisan insights path/to/analyse
```

--------------------------------

### Configure SingleClassElementPerStatementFixer

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the SingleClassElementPerStatementFixer insight, allowing specification of which elements (const, property) must be declared individually.

```php
\PhpCsFixer\Fixer\ClassNotation\SingleClassElementPerStatementFixer::class => [
    'elements' => [
        'const',
        'property',
    ],
]
```

--------------------------------

### Configure CyclomaticComplexityIsHigh Insight

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/complexity.md

Configuration for the CyclomaticComplexityIsHigh insight. Sets the maximum complexity threshold to 5. This insight raises an issue when class cyclomatic complexity exceeds this value.

```php
\NunoMaduro\PhpInsights\Domain\Insights\CyclomaticComplexityIsHigh::class => [
     'maxComplexity' => 5,
]
```

--------------------------------

### Analyse multiple paths

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/get-started.md

Analyse multiple directories, files, or a combination by providing multiple paths.

```bash
# For multiple directories
./vendor/bin/phpinsights analyse path/to/dir1 path/to/dir2

# For multiple files
./vendor/bin/phpinsights analyse path/to/file1.php path/to/file2.php

# Combined
./vendor/bin/phpinsights analyse path/to/dir path/to/file.php
```

--------------------------------

### Configure SuperfluousWhitespaceSniff

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the SuperfluousWhitespaceSniff to control whether blank lines are ignored. Set 'ignoreBlankLines' to false to flag superfluous whitespace on blank lines.

```php
\PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace\SuperfluousWhitespaceSniff::class => [
    'ignoreBlankLines' => false,
]
```

--------------------------------

### Configure ClassMethodAverageCyclomaticComplexityIsHigh Insight

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/complexity.md

Configuration for the ClassMethodAverageCyclomaticComplexityIsHigh insight. Sets the maximum average method complexity to 5.0. This insight raises an issue when the average class method cyclomatic complexity exceeds this value.

```php
\NunoMaduro\PhpInsights\Domain\Insights\ClassMethodAverageCyclomaticComplexityIsHigh::class => [
     'maxClassMethodAverageComplexity' => 5.0,
]
```

--------------------------------

### Configure NoSpacesAroundOffsetFixer positions

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the NoSpacesAroundOffsetFixer insight, which enforces no spaces around offset braces. The 'positions' option accepts an array with values 'inside' and 'outside'.

```php
\PhpCsFixer\Fixer\Whitespace\NoSpacesAroundOffsetFixer::class => [
    'positions' => ['inside', 'outside'],
]
```

--------------------------------

### Run PHP Insights via Laravel artisan

Source: https://github.com/nunomaduro/phpinsights/blob/master/README.md

Run PHP Insights using the Laravel artisan command after publishing the configuration file. This is the Laravel-specific usage.

```bash
php artisan insights
```

--------------------------------

### Configure BracesFixer

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the BracesFixer insight. Options control whether single-line closures are allowed, and the position of braces relative to anonymous constructs, control structures, and functions/OOP constructs.

```php
\PhpCsFixer\Fixer\Basic\BracesFixer::class => [
    'allow_single_line_closure' => false,
    'position_after_anonymous_constructs' => 'same', // possible values ['same', 'next']
    'position_after_control_structures' => 'same', // possible values ['same', 'next']
    'position_after_functions_and_oop_constructs' => 'same', // possible values ['same', 'next']
]
```

--------------------------------

### Configure MaxNestingLevelSniff

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/code.md

Configuration for the MaxNestingLevelSniff, setting a maximum nesting level of 2.

```php
\ObjectCalisthenics\Sniffs\Metrics\MaxNestingLevelSniff::class => [
    'maxNestingLevel' => 2,
]
```

--------------------------------

### Configure UnusedUsesSniff annotation handling

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for SlevomatCodingStandard\Sniffs\Namespaces\UnusedUsesSniff to control annotation searching and ignoring. 'searchAnnotations' enables searching for uses in annotations, 'ignoredAnnotationNames' ignores only annotation names, and 'ignoredAnnotations' ignores both name and content.

```php
\SlevomatCodingStandard\Sniffs\Namespaces\UnusedUsesSniff::class => [
    'searchAnnotations' => false,
    'ignoredAnnotationNames' => [], // case sensitive list of annotation names that the sniff should ignore (only the name is ignored, annotation content is still searched). Useful for name collisions like @testCase annotation and TestCase class.
    'ignoredAnnotations' => [], // case sensitive list of annotation names that the sniff ignore completely (both name and content are ignored). Useful for name collisions like @group Cache annotation and Cache class
]
```

--------------------------------

### Configure OrderedClassElementsFixer order and sort algorithm

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the OrderedClassElementsFixer insight. The 'order' array defines the sequence of class elements, and 'sort_algorithm' accepts 'none' or 'alpha'. This is shown in a collapsible 'Configuration' section.

```php
\PhpCsFixer\Fixer\ClassNotation\OrderedClassElementsFixer::class => [
    'order' => [ // List of strings defining order of elements.
        'use_trait',
        'constant_public',
        'constant_protected',
        'constant_private',
        'property_public',
        'property_protected',
        'property_private',
        'construct',
        'destruct',
        'magic',
        'phpunit',
        'method_public',
        'method_protected',
        'method_private',  
    ],
    'sort_algorithm' => 'none' // possible values ['none', 'alpha']
]
```

--------------------------------

### Format output as JSON

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/get-started.md

Change the output format to JSON using the --format flag.

```bash
./vendor/bin/phpinsights analyse --format=json
```

--------------------------------

### Configure SwitchDeclarationSniff indent

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the Switch declaration sniff, setting the indent to 4. Place this in the PHP Insights configuration file.

```php
\PHP_CodeSniffer\Standards\PSR2\Sniffs\ControlStructures\SwitchDeclarationSniff::class => [
    'indent' => 4,
]
```

--------------------------------

### Configure ObjectOperatorIndentSniff

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the ObjectOperatorIndentSniff, setting the indent to 4 spaces.

```php
\PHP_CodeSniffer\Standards\PEAR\Sniffs\WhiteSpace\ObjectOperatorIndentSniff::class => [
    'indent' => 4,
]
```

--------------------------------

### Configure SpreadOperatorSpacingSniff

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the SpreadOperatorSpacingSniff, setting the number of spaces after the spread operator.

```php
\SlevomatCodingStandard\Sniffs\Operators\SpreadOperatorSpacingSniff::class => [
    'spacesCountAfterOperator' => 0,
]
```

--------------------------------

### Configure diff context

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/get-started.md

Set the diff_context option in the phpinsights.php config file to control diff output context.

```php
<?php

return [
    // ...
    'diff_context' => 3,
    // ...
];
```

--------------------------------

### Configure AlignMultilineCommentFixer

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the AlignMultilineCommentFixer, which aligns asterisks in multi-line DocComments. The 'comment_type' option accepts 'phpdocs_only', 'phpdocs_like', or 'all_multiline'.

```php
\PhpCsFixer\Fixer\Phpdoc\AlignMultilineCommentFixer::class => [
    'comment_type' => 'phpdocs_only' // possible values ['phpdocs_only', 'phpdocs_like', 'all_multiline']
]
```

--------------------------------

### Enable Insight in 'add' Section

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/README.md

Configuration snippet to enable the Fully Qualified ClassName In Annotation insight in the 'add' section of the PHPInsights configuration.

```php
'add' => [
    \NunoMaduro\PhpInsights\Domain\Metrics\Code\Comments::class => [
        \SlevomatCodingStandard\Sniffs\Namespaces\FullyQualifiedClassNameInAnnotationSniff::class
    ]
]
```

--------------------------------

### Configure MethodPerClassLimitSniff maxCount

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/architecture.md

Configuration for the MethodPerClassLimitSniff to set the maximum number of methods per class. The default is 10. Place this in your PHP_CodeSniffer configuration file.

```php
\ObjectCalisthenics\Sniffs\Metrics\MethodPerClassLimitSniff::class => [
    'maxCount' => 10,
]
```

--------------------------------

### Configure PropertyPerClassLimitSniff maxCount

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/architecture.md

Configuration for the PropertyPerClassLimitSniff to set the maximum number of properties per class. The default is 10. Place this in your PHP_CodeSniffer configuration file.

```php
\ObjectCalisthenics\Sniffs\Metrics\PropertyPerClassLimitSniff::class => [
    'maxCount' => 10,
]
```

--------------------------------

### Configure LineEndingsSniff eolChar

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the LineEndingsSniff insight. Set 'eolChar' to the desired end-of-line character, such as '\n' for Unix line endings.

```php
\PHP_CodeSniffer\Standards\Generic\Sniffs\Files\LineEndingsSniff::class => [
    'eolChar' => '\n',
]
```

--------------------------------

### Publish Laravel configuration for PHP Insights

Source: https://github.com/nunomaduro/phpinsights/blob/master/README.md

Publish the PHP Insights configuration file for Laravel projects using the artisan vendor:publish command with the InsightsServiceProvider. This is required before using the Laravel-specific artisan command.

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

--------------------------------

### Configure NoBreakCommentFixer comment_text

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/code.md

Configuration for the NoBreakCommentFixer insight, setting the comment text to 'no break'.

```php
\PhpCsFixer\Fixer\ControlStructure\NoBreakCommentFixer::class => [
    'comment_text' => 'no break',
]
```

--------------------------------

### Analyse a sub-directory or specific file

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/get-started.md

Analyse a directory or a specific file by providing a path with the analyse command.

```bash
# For a directory
./vendor/bin/phpinsights analyse path/to/analyse

# For a file
./vendor/bin/phpinsights analyse path/to/analyse.php
```

--------------------------------

### Configure VisibilityRequiredFixer elements

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/code.md

Configuration for the VisibilityRequiredFixer insight, specifying which elements (property, method) require visibility declarations. This is a configurable insight, and the configuration is provided as a PHP array.

```php
\PhpCsFixer\Fixer\ClassNotation\VisibilityRequiredFixer::class => [
    'elements' => [
        'property',
        'method',
    ],
]
```

--------------------------------

### Increase memory limit

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/get-started.md

Workaround for 'Allowed memory size exhausted' error by increasing memory limit.

```bash
php -d memory_limit=2000M ./vendor/bin/phpinsights
```

--------------------------------

### Configure PhpdocScalarFixer types

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/code.md

Configuration for the PhpdocScalarFixer insight, specifying the scalar types to be normalized.

```php
\PhpCsFixer\Fixer\Phpdoc\PhpdocScalarFixer::class => [
    'types' => [ 
        'boolean',
        'double',
        'integer',
        'real',
        'str',
    ]    
]
```

--------------------------------

### Configure ClassTraitAndInterfaceLengthSniff maxLength

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/architecture.md

Configuration for the ClassTraitAndInterfaceLengthSniff to set the maximum length of classes, traits, and interfaces. The default is 200 lines. Place this in your PHP_CodeSniffer configuration file.

```php
\ObjectCalisthenics\Sniffs\Files\ClassTraitAndInterfaceLengthSniff::class => [
    'maxLength' => 200,
]
```

--------------------------------

### Configure DocCommentSpacingSniff

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the DocCommentSpacingSniff to set line counts between doc comment elements and annotation groups. Adjust these values to enforce desired spacing.

```php
\SlevomatCodingStandard\Sniffs\Commenting\DocCommentSpacingSniff::class => [
    'linesCountBeforeFirstContent' => 0,
    'linesCountBetweenDescriptionAndAnnotations' => 1,
    'linesCountBetweenDifferentAnnotationsTypes' => 0,
    'linesCountBetweenAnnotationsGroups' => 1,
    'linesCountAfterLastContent' => 0,
    'annotationsGroups' => [],
]
```

--------------------------------

### Configure CastSpacesFixer for cast spacing

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configures the CastSpacesFixer to require a single space between a cast and variable. The 'space' option accepts 'single' or 'none'.

```php
\PhpCsFixer\Fixer\CastNotation\CastSpacesFixer::class => [
    'space' => 'single' // possible values ['single', 'none']
]
```

--------------------------------

### Configure SingleQuoteFixer

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the SingleQuoteFixer, which converts double quotes to single quotes for simple strings. The 'strings_containing_single_quote_chars' option is set to false.

```php
\PhpCsFixer\Fixer\StringNotation\SingleQuoteFixer::class => [
    'strings_containing_single_quote_chars' => false,
]
```

--------------------------------

### Configure FunctionDeclarationFixer closure_function_spacing

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/style.md

Configuration for the FunctionDeclarationFixer insight. Sets 'closure_function_spacing' to 'one' (possible values: 'one', 'none').

```php
\PhpCsFixer\Fixer\FunctionNotation\FunctionDeclarationFixer::class => [
    'closure_function_spacing' => 'one' // possible values ['one', 'none']
]
```

--------------------------------

### Configure NoUnneededControlParenthesesFixer statements

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/code.md

Configuration for the NoUnneededControlParenthesesFixer insight, which removes unneeded parentheses around control statements. The 'statements' option lists which control structures to target.

```php
\PhpCsFixer\Fixer\ControlStructure\NoUnneededControlParenthesesFixer::class => [
    'statements' => [
        'break',
        'clone',
        'continue',
        'echo_print',
        'return',
        'switch_case',
        'yield',
    ],
]
```

--------------------------------

### GitLab CI job for Code Quality report

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/continuous-integration.md

This GitLab CI job runs PHP Insights with the --format=codeclimate option and saves the output to a codeclimate-report.json artifact. This enables Code Quality annotations in merge requests.

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

--------------------------------

### Configure ForbiddenCommentsSniff with forbiddenCommentPatterns

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/code.md

Configuration for the ForbiddenCommentsSniff insight. The 'forbiddenCommentPatterns' array is empty by default, meaning nothing is forbidden unless configured. Use this to specify patterns for comments that should be reported.

```php
SlevomatCodingStandard\Sniffs\Commenting\ForbiddenCommentsSniff::class => [
    'forbiddenCommentPatterns' => []
]
```

--------------------------------

### Fix errors automatically

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/get-started.md

Automatically fix issues using the --fix option or the fix command.

```bash
# Classical command with --fix option
vendor/bin/phpinsights analyse path/to/analyse --fix

# In laravel
php artisan insights path/to/analyse --fix

# Just fix
vendor/bin/phpinsights fix path/to/analyse
```

--------------------------------

### Clear local repository

Source: https://github.com/nunomaduro/phpinsights/blob/master/RELEASE.md

Resets the local repository to the master branch, discarding any local changes.

```bash
git add . && git reset --hard && git checkout master
```

--------------------------------

### Disable security check with --disable-security-check

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/continuous-integration.md

Use this command to disable the security check when running PHP Insights in CI. This is useful for libraries or plugins that need to test with a range of dependency versions using --prefer-lower. Note that this option should never be used for project inspections to keep the project safe.

```bash
./vendor/bin/phpinsights --no-interaction --disable-security-check
```

--------------------------------

### Commit version bump

Source: https://github.com/nunomaduro/phpinsights/blob/master/RELEASE.md

Commits the version bump changes with a message indicating the new version.

```bash
git commit -m "Bump version to {new_version}"
```

--------------------------------

### Remove an insight in phpinsights config

Source: https://github.com/nunomaduro/phpinsights/blob/master/docs/insights/README.md

Add the fully qualified class name of an insight to the 'remove' section of the configuration to disable it. Use the -v option with phpinsights to find the class name.

```php
    'remove' => [
        \PHP_CodeSniffer\Standards\Generic\Sniffs\Formatting\SpaceAfterNotSniff::class,
    ]
```
Tokens:
Raw