thecodingmachine/phpstan-strict-rules

A set of additional rules for PHPStan based on best practices followed at TheCodingMachine

Installs: 161 021

Dependents: 90

Suggesters: 0

Stars: 182

Watchers: 19

Forks: 10

Open Issues: 5

Type:phpstan-extension

v0.11.2 2019-06-08 20:09 UTC

README

Latest Stable Version Total Downloads Latest Unstable Version License Scrutinizer Code Quality Build Status Coverage Status

TheCodingMachine's additional rules for PHPStan

This package contains a set of rules to be added to the wonderful PHPStan static analyzer.

Those rules come from TheCodingMachine best practices. They are more "strict" than the default PHPStan rules and some may be controversial. We use those at TheCodingMachine, have found them to help us in our daily work, and ask anyone working with us to follow them.

Rules list

Exception related rules

Type-hinting related rules

This is a PHP 7.1+ rule:

  • You should use type-hinting when possible
  • If not possible, you should use a Docblock to specify the type
  • If type-hinting against an array, you should use a Docblock to further explain the content of the array

More about type-hinting related rules...

Superglobal related rules

Condition related rules

Work-in-progress

// Never use public properties
// Never use globals

Installation

We assume that PHPStan is already installed in your project.

To use this extension, require it in Composer:

composer require --dev thecodingmachine/phpstan-strict-rules

If you also install phpstan/extension-installer then you're all set!

Manual installation

If you don't want to use phpstan/extension-installer, include phpstan-strict-rules.neon in your project's PHPStan config:

includes:
    - vendor/thecodingmachine/phpstan-strict-rules/phpstan-strict-rules.neon