Merge pull request #94 from ans-group/add-phpmd

Add PHPMD design rules
ans-group · Jul 24, 2024 · d804ad3 · d804ad3
2 parents 81b3e79 + 98b5a6e
commit d804ad3
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 6 deletions.
diff --git a/.phpmd/ruleset.xml b/.phpmd/ruleset.xml
@@ -17,5 +17,7 @@
 
     <rule ref="rulesets/codesize.xml" />
 
+    <rule ref="rulesets/design.xml">
+        <exclude name="NumberOfChildren" />
+    </rule>
 </ruleset>
-
diff --git a/src/AppHealth.php b/src/AppHealth.php
@@ -10,17 +10,14 @@ class AppHealth
 {
     public function __construct(
         /**
-         * @var Collection<int, class-string>
+         * @var Collection<int, HealthCheck>
          */
         protected Collection $checks,
     ) {
     }
 
     public function passes($checkName)
     {
-        /**
-         * @var HealthCheck $check
-         */
         $check = $this->checks->filter(function ($check) use ($checkName) {
             return $check->name() == $checkName;
         })->first();
@@ -44,7 +41,7 @@ public function fails($checkName): bool
     /**
      * Returns a collection of all health checks
      *
-     * @return Collection<int, class-string>
+     * @return Collection<int, HealthCheck>
      */
     public function all(): Collection
     {

diff --git a/src/Facade/HealthCheck.php b/src/Facade/HealthCheck.php
@@ -2,8 +2,17 @@
 
 namespace UKFast\HealthCheck\Facade;
 
+use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Facade;
+use UKFast\HealthCheck\AppHealth;
+use UKFast\HealthCheck\HealthCheck as Check;
 
+/**
+ * @method static bool passes(string $checkName)
+ * @method static bool fails(string $checkName)
+ * @method static Collection<int, Check> all()
+ * @see AppHealth
+ */
 class HealthCheck extends Facade
 {
     public static function getFacadeAccessor(): string