Merge pull request #16 from ismaail/feature/phpstan

Feature/phpstan

Author: kayedspace

composer.json

@@ -49,7 +49,8 @@
     "pestphp/pest": "^3.8",
     "pestphp/pest-plugin-laravel": "^3.2",
     "orchestra/testbench": "^10.4",
-    "laravel/pint": "^1.23"
+    "laravel/pint": "^1.23",
+    "larastan/larastan": "^3.5"
   },
   "config": {
     "allow-plugins": {

phpstan.neon

@@ -0,0 +1,24 @@
+includes:
+	- vendor/larastan/larastan/extension.neon
+
+parameters:
+	phpVersion:
+		min: 80200
+		max: 80400
+
+	paths:
+		- src
+
+	excludePaths:
+		analyseAndScan:
+			- tests/*
+
+	# Level 9 is the highest level
+	level: 6
+
+	ignoreErrors:
+		- '#no value type specified in iterable type array#'
+		- '#return type with generic class#'
+		- '#uses generic trait#'
+
+	reportUnmatchedIgnoredErrors: false

src/Client/Api/AbstractApi.php

@@ -12,8 +12,9 @@ abstract class AbstractApi
 {
     public function __construct(protected PendingRequest $httpClient)
     {
-        $baseUrl = Config::get('n8n.api.base_url');
-        $key = Config::get('n8n.api.key');
+        $baseUrl = Config::string('n8n.api.base_url');
+        $key = Config::string('n8n.api.key');
+
         $this->httpClient = $httpClient->baseUrl($baseUrl)->withHeaders([
             'X-N8N-API-KEY' => $key,
             'Accept' => 'application/json',

src/Client/Api/Users.php

@@ -41,7 +41,7 @@ public function get(string $idOrEmail, bool $includeRole = false): array
      * @throws ConnectionException
      * @throws RequestException
      */
-    public function delete(string $idOrEmail)
+    public function delete(string $idOrEmail): array
     {
         return $this->request(RequestMethod::Delete, "/users/{$idOrEmail}");
     }

src/Client/N8nClient.php

@@ -32,7 +32,7 @@ public function __construct()
             ->when($retry, fn ($request) => $request->retry($retry));
     }
 
-    public function webhooks($method = RequestMethod::Post): Webhooks
+    public function webhooks(RequestMethod $method = RequestMethod::Post): Webhooks
     {
         return new Webhooks($this->httpClient, $method);
     }

src/Client/Webhook/Webhooks.php

@@ -34,7 +34,7 @@ public function __construct(
      * @throws ConnectionException
      * @throws RequestException
      */
-    public function request($path, array $data = []): ?array
+    public function request(string $path, array $data = []): ?array
     {
         return $this->httpClient
             ->when($this->basicAuth,

src/Enums/RequestMethod.php

@@ -14,7 +14,6 @@ enum RequestMethod: string
     case Delete = 'delete';
     case Patch = 'patch';
     case Head = 'head';
-    case Options = 'options';
 
     /**
      * True when the given value refers to **this** method.