Skip to content

Commit a87e03e

Browse files
authored
Readme: minor improvements
1 parent 6d9548d commit a87e03e

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

Diff for: README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ShipMonk PHPStan rules
1+
# ShipMonk PHPStan strict rules
22
About **40 super-strict rules** we found useful in ShipMonk.
33
We tend to have PHPStan set up [as strict as possible](#native-phpstan-extra-strictness), but that still was not strict enough for us.
44
This set of rules should fill the missing gaps we found.
@@ -13,6 +13,7 @@ composer require --dev shipmonk/phpstan-rules
1313

1414
Use [official extension-installer](https://phpstan.org/user-guide/extension-library#installing-extensions) or enable all rules manually by:
1515
```neon
16+
# phpstan.neon
1617
includes:
1718
- vendor/shipmonk/phpstan-rules/rules.neon
1819
```
@@ -39,8 +40,6 @@ parameters:
3940
enabled: true
4041
```
4142

42-
Few rules are enabled, but do nothing unless configured, those are marked with `*`.
43-
4443
When you try to configure any default array, PHPStan config is **merged by default**,
4544
so if you want to enforce only your values and not to include our defaults, use [exclamation mark](https://doc.nette.org/en/dependency-injection/configuration#toc-merging):
4645

@@ -52,6 +51,8 @@ parameters:
5251
blacklist!: ['(unset)'] # force the blacklist to be only (unset)
5352
```
5453

54+
Few rules are enabled, but do nothing unless configured, those are marked with `*`.
55+
5556
## Rules:
5657

5758
### allowComparingOnlyComparableTypes

0 commit comments

Comments
 (0)