Skip to content

Commit 6b72761

Browse files
author
Florian Krämer
committed
Updating documentation
1 parent c55b015 commit 6b72761

15 files changed

+465
-412
lines changed

README.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,26 @@ composer require phauthentic/phpstan-rules --dev
1414

1515
## Rules
1616

17-
See [Rules documentation](docs/Rules.md) for a list of available rules and configuration examples.
18-
19-
- Architecture Rules:
20-
- [Dependency Constraints Rule](docs/Rules.md#dependency-constraints-rule)
21-
- [Forbidden Namespaces Rule](docs/Rules.md#forbidden-namespaces-rule)
22-
- [Readonly Class Rule](docs/Rules.md#readonly-class-rule)
23-
- [Final Class Rule](docs/Rules.md#final-class-rule)
24-
- [Namespace Class Pattern Rule](docs/Rules.md#namespace-class-pattern-rule)
25-
- [Catch Exception of Type Not Allowed Rule](docs/Rules.md#catch-exception-of-type-not-allowed-rule)
26-
- [Methods Returning Bool Must Follow Naming Convention Rule](docs/Rules.md#methods-returning-bool-must-follow-naming-convention-rule)
27-
- [Method Signature Must Match Rule](docs/Rules.md#method-signature-must-match-rule)
28-
- [Method Must Return Type Rule](docs/Rules.md#method-must-return-type-rule)
29-
- Clean Code Rules:
30-
- [Control Structure Nesting Rule](docs/Rules.md#control-structure-nesting-rule)
31-
- [Too Many Arguments Rule](docs/Rules.md#too-many-arguments-rule)
32-
- [Max Line Length Rule](docs/Rules.md#max-line-length-rule)
17+
See individual rule documentation for detailed configuration examples. A [full configuration example](docs/Rules.md) is also available.
18+
19+
### Architecture Rules
20+
21+
- [Dependency Constraints Rule](docs/rules/Dependency-Constraints-Rule.md)
22+
- [Forbidden Namespaces Rule](docs/rules/Forbidden-Namespaces-Rule.md)
23+
- [Class Must Be Readonly Rule](docs/rules/Class-Must-Be-Readonly-Rule.md)
24+
- [Class Must Be Final Rule](docs/rules/Class-Must-Be-Final-Rule.md)
25+
- [Classname Must Match Pattern Rule](docs/rules/Classname-Must-Match-Pattern-Rule.md)
26+
- [Catch Exception Of Type Not Allowed Rule](docs/rules/Catch-Exception-Of-Type-Not-Allowed-Rule.md)
27+
- [Class Must Have Specification Docblock Rule](docs/rules/Class-Must-Have-Specification-Docblock-Rule.md)
28+
- [Methods Returning Bool Must Follow Naming Convention Rule](docs/rules/Methods-Returning-Bool-Must-Follow-Naming-Convention-Rule.md)
29+
- [Method Signature Must Match Rule](docs/rules/Method-Signature-Must-Match-Rule.md)
30+
- [Method Must Return Type Rule](docs/rules/Method-Must-Return-Type-Rule.md)
31+
32+
### Clean Code Rules
33+
34+
- [Control Structure Nesting Rule](docs/rules/Control-Structure-Nesting-Rule.md)
35+
- [Too Many Arguments Rule](docs/rules/Too-Many-Arguments-Rule.md)
36+
- [Max Line Length Rule](docs/rules/Max-Line-Length-Rule.md)
3337

3438
### Using Regex in Rules
3539

0 commit comments

Comments
 (0)