Skip to content

Commit a0b3ee4

Browse files
authored
Readme (#5)
1 parent 0b5965b commit a0b3ee4

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,22 @@
11
# PHPStan Rules
22
Set of additional PHPStan rules
33

4+
*For legacy codebase*
45
- check if property and constant shouldn't be set as protected (when is not inherited or class is not abstract)
56
- check if property name starts with underscore
6-
- check if constant name is uppercase
7+
- check if constant name is uppercase
8+
9+
*PHPMD rules*
10+
- check for boolean argument flag
11+
- more coming soon ...
12+
13+
## Installation
14+
15+
Run `composer require --dev pmarki/phpstan-rules`
16+
17+
Edit your phpstan configuration file and add
18+
19+
```
20+
includes:
21+
- vendor/pmarki/phpstan-rules/extension.neon
22+
```

0 commit comments

Comments
 (0)