Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sidz/phpstan-rules
Additional rules for phpstan/phpstan.
https://github.com/sidz/phpstan-rules
Last synced: 30 days ago
JSON representation
Additional rules for phpstan/phpstan.
- Host: GitHub
- URL: https://github.com/sidz/phpstan-rules
- Owner: sidz
- License: mit
- Created: 2023-04-09T18:21:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-24T08:18:46.000Z (8 months ago)
- Last Synced: 2024-04-24T16:04:43.801Z (7 months ago)
- Language: PHP
- Size: 43.9 KB
- Stars: 25
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# phpstan-rules
[](https://github.com/sidz/phpstan-rules/actions)
Provides additional rules for [`phpstan/phpstan`](https://github.com/phpstan/phpstan).
## Installation
Run
```sh
composer require --dev sidz/phpstan-rules
```
If you use [PHPStan extension installer](https://github.com/phpstan/extension-installer), you're all set. If not, you need to manually register all the rules in your `phpstan.neon`:
```neon
includes:
- vendor/sidz/phpstan-rules/rules.neon
```
Each rule by default ignores the following numbers: `0` and `1`. This can be configured by adding the following parameter to your `phpstan.neon`:
```neon
parameters:
sidzIgnoreMagicNumbers: [0, 1, 100]
```
Each rule by default detects numeric strings like `'12'` in source code. This behavior could be disabled via parameter:
```neon
parameters:
sidzIgnoreNumericStrings: true
```
## Ignoring particular rules
If you need to ignore particular rule, for example `NoMagicNumberInComparisonOperatorRule`, you can do so by using built-in `ignoreErrors` parameter:
```neon
parameters:
ignoreErrors:
- '#^Do not use magic number in comparison operations\. Move to constant with a suitable name\.$#'
```
If you need to ignore this rule only for particular file or folder, this also can be done by using `ignoreErrors` parameter:
```neon
parameters:
ignoreErrors:
-
message: '#^Do not use magic number in comparison operations\. Move to constant with a suitable name\.$#'
path: src/SomeFolder/*
```
And finally, if you want to ignore all the rules from this package for particular files or folders, add this to `phpstan.neon`:
```neon
parameters:
ignoreErrors:
-
message: '#Do not (use|return|assign) magic number (.)#'
paths:
- src/DataFixtures/*
- tests/*
```
## Rules
This package provides the following rules for use with [`phpstan/phpstan`](https://github.com/phpstan/phpstan):
- [`Sid\PHPStan\Rules\MagicNumber\NoMagicNumberAsFunctionArgumentRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberasfunctionargumentrule)
- [`Sid\PHPStan\Rules\MagicNumber\NoMagicNumberAssignedToPropertyRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberassignedtopropertyrule)
- [`Sid\PHPStan\Rules\MagicNumber\NoMagicNumberInArithmeticOperatorRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberinarithmeticoperatorrule)
- [`Sid\PHPStan\Rules\MagicNumber\NoMagicNumberInBitwiseOperatorRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberinbitwiseoperatorrule)
- [`Sid\PHPStan\Rules\MagicNumber\NoMagicNumberInComparisonOperatorRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberincomparisonoperatorrule)
- [`Sid\PHPStan\Rules\MagicNumber\NoMagicNumberInDefaultParameterRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberindefaultparameterrule)
- [`Sid\PHPStan\Rules\MagicNumber\NoMagicNumberInLogicalOperatorRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberinlogicaloperatorrule)
- [`Sid\PHPStan\Rules\MagicNumber\NoMagicNumberInMatchRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberinmatchrule)
- [`Sid\PHPStan\Rules\MagicNumber\NoMagicNumberInReturnStatementRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberinreturnstatementrule)
- [`Sid\PHPStan\Rules\MagicNumber\NoMagicNumberInSwitchCaseRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberinswitchcaserule)
- [`Sid\PHPStan\Rules\MagicNumber\NoMagicNumberInTernaryOperatorRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberinternaryoperatorrule)
- [`Sid\PHPStan\Rules\MagicNumber\NoMagicNumberVariableAssignmentRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumbervariableassignmentrule)
### Classes
#### `MagicNumber\NoMagicNumberAsFunctionArgumentRule`
This rule reports an error when magic number is used as function argument:
```php
> 5;
1 & $a;
2 | $b;
3 ^ $c;
4 << $a;
5 >> $b;
6 >> 7;
```
#### `MagicNumber\NoMagicNumberInComparisonOperatorRule`
This rule reports an error when magic number is used in comparison operator:
```php
.8;
$var9 >= 9;
$var10 <=> 0.1;
$var11 === 11;
```
#### `MagicNumber\NoMagicNumberInDefaultParameterRule`
This rule reports an error when magic number is used as default parameter:
```php
'Hi',
2, 4 => 'There',
default => throw new LogicException(),
};
```
#### `MagicNumber\NoMagicNumberInReturnStatementRule`
This rule reports an error when magic number is used in `return` statement:
```php