From 298dd20842c73e41617901742c55dace4e1a0194 Mon Sep 17 00:00:00 2001 From: Piotr Markiewicz Date: Tue, 15 Apr 2025 13:25:52 +0200 Subject: [PATCH] Readme --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 19b0c20..e237fe1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,22 @@ # PHPStan Rules Set of additional PHPStan rules +*For legacy codebase* - check if property and constant shouldn't be set as protected (when is not inherited or class is not abstract) - check if property name starts with underscore -- check if constant name is uppercase \ No newline at end of file +- check if constant name is uppercase + +*PHPMD rules* +- check for boolean argument flag +- more coming soon ... + +## Installation + +Run `composer require --dev pmarki/phpstan-rules` + +Edit your phpstan configuration file and add + +``` +includes: + - vendor/pmarki/phpstan-rules/extension.neon +``` \ No newline at end of file