Initial commit

Author: floriankraemer

.gitignore

@@ -0,0 +1,3 @@
+/bin/
+/vendor/
+.idea

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Florian Krämer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,80 @@
+# PHPStan Rules
+
+Additional rules for PHPStan. Mostly focused on clean code and architecture.
+
+## Usage
+
+```bash
+composer require/phauthentic/phpstan-rules --dev
+```
+
+## Rules
+
+Add them to your `phpstan.neon` configuration file under the section `services`.
+
+### Control Structure Nesting Rule
+
+Ensures that the nesting level of `if` and `try-catch` statements does not exceed a specified limit.
+
+**Configuration Example:**
+```neon
+    -
+        class: Phauthentic\PhpstanRules\ControlStructureNestingRule
+        arguments:
+            maxNestingLevel: 2
+        tags:
+            - phpstan.rules.rule
+```
+
+### Too Many Arguments Rule
+
+Checks that methods do not have more than a specified number of arguments.
+
+**Configuration Example:**
+```neon
+    -
+        class: Phauthentic\PhpstanRules\TooManyArgumentsRule
+        arguments:
+            maxArguments: 3
+        tags:
+            - phpstan.rules.rule
+```
+### Readonly Class Rule
+
+Ensures that classes matching specified patterns are declared as `readonly`.
+
+**Configuration Example:**
+```neon
+    -
+        class: Phauthentic\PhpstanRules\ReadonlyClassRule
+        arguments:
+            patterns: ['/^App\\Controller\\/']
+        tags:
+            - phpstan.rules.rule
+```
+
+### Dependency Constraints Rule
+
+Enforces dependency constraints between namespaces by checking `use` statements.
+
+The constructor takes an array of namespace dependencies. The key is the namespace that should not depend on the namespaces in the array of values.
+
+In the example below nothing from `App\Domain` can depend on anything from `App\Controller`.
+
+**Configuration Example:**
+```neon
+    -
+        class: Phauthentic\PhpstanRules\DependencyConstraintsRule
+        arguments:
+            namespaceDependencies: [
+                'App\\Domain\\': ['/^App\\Controller\\/']
+            ]
+        tags:
+            - phpstan.rules.rule
+```
+
+## License
+
+This library is under the MIT license.
+
+Copyright Florian Krämer

composer.json

@@ -0,0 +1,22 @@
+{
+    "name": "phauthentic/phpstan-rules",
+    "type": "library",
+    "require-dev": {
+        "phpstan/phpstan": "^2.1",
+        "phpunit/phpunit": "^12.0",
+        "squizlabs/php_codesniffer": "^3.12"
+    },
+    "autoload": {
+        "psr-4": {
+            "Phauthentic\\PhpstanRules\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "Florian Krämer"
+        }
+    ],
+    "config": {
+        "bin-dir": "bin"
+    }
+}