Prepare PHPStan

.github/workflows/back-end.yml

@@ -135,9 +135,12 @@ jobs:
             name: "Search for $this->$this typo 🐌"
             run: |
                 ! git grep --line-number -e '\$this\s*->\s*\$this' -- ':!:*/back-end\.yml'
+        -
+            name: "Install orchestra/testbench"
+            run: "composer require --dev orchestra/testbench"
         -
             name: "Perform static analysis"
-            run: "true TODO || composer exec -- phpstan analyze --level=5 src/"
+            run: "composer exec -- phpstan || true 'Annotate only'"
 
     coding_standards:
         name: "4️⃣ Coding Standards"

phpstan.neon.dist

@@ -7,8 +7,28 @@ parameters:
     paths:
         - src/
         - config/
-        - database/
+# TODO
+#        - database/
         - routes/
     level: 5
+    checkAlwaysTrueCheckTypeFunctionCall: true
+    checkAlwaysTrueInstanceof: true
+    checkAlwaysTrueStrictComparison: true
+    checkAlwaysTrueLooseComparison: true
+    checkClassCaseSensitivity: false
+    checkDynamicProperties: true
+    checkExplicitMixed: false
+    checkImplicitMixed: false
+    checkExplicitMixedMissingReturn: true
+    checkFunctionNameCase: true
+    checkInternalClassCaseSensitivity: true
     ignoreErrors:
         - '#^Unsafe usage of new static#'
+        # --- TODO-s ---
+        # Tricky readonlys
+        - '#Assign it in the constructor\.$#'
+        - '#is assigned outside of the constructor\.$#'
+        # X vs. X contract
+        - '#but returns Illuminate\\Contracts\\#'
+        # SoftDeletes
+        - '#(\$forceDeleting|::withTrashed|::onlyTrashed|::trashed|::restore)#'

src/Fields/BelongsTo.php

@@ -6,6 +6,11 @@
 use Illuminate\Database\Eloquent\Relations\BelongsTo as EloquentRelation;
 use Illuminate\Http\Request;
 
+/**
+ * @template TRelation of \Illuminate\Database\Eloquent\Relations\BelongsTo
+ *
+ * @extends \Cone\Root\Fields\Relation<TRelation>
+ */
 class BelongsTo extends Relation
 {
     /**

src/Fields/BelongsToMany.php

@@ -9,6 +9,11 @@
 use Illuminate\Http\Request;
 use Illuminate\Support\Arr;
 
+/**
+ * @template TRelation of \Illuminate\Database\Eloquent\Relations\BelongsToMany
+ *
+ * @extends \Cone\Root\Fields\Relation<TRelation>
+ */
 class BelongsToMany extends Relation
 {
     use ResolvesFields;

src/Fields/HasMany.php

@@ -6,6 +6,9 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany as EloquentRelation;
 
+/**
+ * @extends \Cone\Root\Fields\HasOneOrMany<\Illuminate\Database\Eloquent\Relations\HasMany>
+ */
 class HasMany extends HasOneOrMany
 {
     /**

src/Fields/HasOne.php

@@ -5,6 +5,9 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasOne as EloquentRelation;
 
+/**
+ * @extends \Cone\Root\Fields\HasOneOrMany<\Illuminate\Database\Eloquent\Relations\HasOne>
+ */
 class HasOne extends HasOneOrMany
 {
     /**

src/Fields/HasOneOrMany.php

@@ -7,6 +7,11 @@
 use Illuminate\Http\Request;
 use Illuminate\Support\Arr;
 
+/**
+ * @template TRelation of \Illuminate\Database\Eloquent\Relations\HasOneOrMany
+ *
+ * @extends \Cone\Root\Fields\Relation<TRelation>
+ */
 abstract class HasOneOrMany extends Relation
 {
     /**

src/Fields/Meta.php

@@ -9,6 +9,9 @@
 use Illuminate\Database\Eloquent\Relations\MorphOne as EloquentRelation;
 use Illuminate\Http\Request;
 
+/**
+ * @extends \Cone\Root\Fields\MorphOne<\Illuminate\Database\Eloquent\Relations\MorphOne>
+ */
 class Meta extends MorphOne
 {
     /**

src/Fields/MorphMany.php

@@ -5,6 +5,9 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphMany as EloquentRelation;
 
+/**
+ * @extends \Cone\Root\Fields\MorphOneOrMany<\Illuminate\Database\Eloquent\Relations\MorphMany>
+ */
 class MorphMany extends MorphOneOrMany
 {
     /**

src/Fields/MorphOne.php

@@ -5,6 +5,11 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphOne as EloquentRelation;
 
+/**
+ * @template TRelation of \Illuminate\Database\Eloquent\Relations\MorphOne
+ *
+ * @extends \Cone\Root\Fields\MorphOneOrMany<TRelation>
+ */
 class MorphOne extends MorphOneOrMany
 {
     /**

src/Fields/MorphOneOrMany.php

@@ -5,6 +5,11 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphOneOrMany as EloquentRelation;
 
+/**
+ * @template TRelation of \Illuminate\Database\Eloquent\Relations\MorphOneOrMany
+ *
+ * @extends \Cone\Root\Fields\HasOneOrMany<TRelation>
+ */
 abstract class MorphOneOrMany extends HasOneOrMany
 {
     /**

src/Fields/MorphTo.php

@@ -5,6 +5,9 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphTo as EloquentRelation;
 
+/**
+ * @extends \Cone\Root\Fields\BelongsTo<\Illuminate\Database\Eloquent\Relations\MorphTo>
+ */
 class MorphTo extends BelongsTo
 {
     /**

src/Fields/MorphToMany.php

@@ -5,6 +5,9 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphToMany as EloquentRelation;
 
+/**
+ * @extends \Cone\Root\Fields\BelongsToMany<\Illuminate\Database\Eloquent\Relations\MorphToMany>
+ */
 class MorphToMany extends BelongsToMany
 {
     /**

src/Fields/Relation.php

@@ -10,6 +10,9 @@
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 
+/**
+ * @template TRelation of \Illuminate\Database\Eloquent\Relations\Relation
+ */
 abstract class Relation extends Field
 {
     /**
@@ -72,6 +75,8 @@ public static function scopeQuery(Closure $callback): void
 
     /**
      * Get the relation instance.
+     *
+     * @phpstan-return TRelation
      */
     public function getRelation(Model $model): EloquentRelation
     {

src/Models/Medium.php

@@ -152,6 +152,8 @@ public function user(): BelongsTo
 
     /**
      * Determine if the file is image.
+     *
+     * @return \Illuminate\Database\Eloquent\Casts\Attribute<bool, never>
      */
     protected function isImage(): Attribute
     {

src/Navigation/Item.php

@@ -6,6 +6,12 @@
 use Cone\Root\Traits\Makeable;
 use Illuminate\Support\Facades\URL;
 
+/**
+ * @property string $url
+ * @property string $label
+ * @property string $icon
+ * @property string $group
+ */
 class Item
 {
     use HasAttributes;

src/Support/Slug.php

@@ -152,7 +152,7 @@ static function (Builder $query): Builder {
         $value = is_null($match) ? $value : preg_replace_callback(
             sprintf('/%s([\d]+)?$/', preg_quote($this->separator)),
             static function (array $match): string {
-                return str_replace($match[1], ((int) $match[1]) + 1, $match[0]);
+                return str_replace($match[1], (string) (((int) $match[1]) + 1), $match[0]);
             },
             $match
         );

src/Widgets/Widgets.php

@@ -6,6 +6,9 @@
 use Illuminate\Support\Collection;
 use Illuminate\Support\Traits\ForwardsCalls;
 
+/**
+ * @mixin \Illuminate\Support\Collection
+ */
 class Widgets
 {
     use ForwardsCalls;