feat: Add PHPStan type testing

.github/workflows/tests.yaml

@@ -82,6 +82,8 @@ jobs:
         run: composer update -o
       - name: Run Analyse
         run: composer analyse src
+      - name: Run Type Tests
+        run: composer type-testing
       - name: Setup Services
         run: ./.travis/setup.services.sh
       - name: Run Test Cases

composer.json

@@ -334,6 +334,7 @@
         ],
         "test:lint": "@php vendor/bin/php-cs-fixer fix --dry-run --diff --ansi",
         "test:types": "@php vendor/bin/pest --type-coverage",
-        "test:unit": "@php vendor/bin/pest"
+        "test:unit": "@php vendor/bin/pest",
+        "type-testing": "phpstan analyze --configuration=\"phpstan.types.neon.dist\" --memory-limit=-1"
     }
 }

phpstan.types.neon.dist

@@ -0,0 +1,12 @@
+parameters:
+    level: max
+    paths:
+        - types
+    scanFiles:
+        - src/macros/output/Hyperf/Collection/Arr.php
+        - src/macros/output/Hyperf/Collection/Collection.php
+        - src/macros/output/Hyperf/Collection/LazyCollection.php
+        - src/macros/output/Hyperf/HttpServer/Contract/RequestInterface.php
+        - src/macros/output/Hyperf/HttpServer/Request.php
+        - src/macros/output/Hyperf/Stringable/Str.php
+        - src/macros/output/Hyperf/Stringable/Stringable.php

src/macros/output/Hyperf/Collection/Collection.php

@@ -13,6 +13,15 @@
 
 class Collection
 {
+    /**
+     * Create a new collection.
+     *
+     * @param mixed $items
+     */
+    public function __construct($items = [])
+    {
+    }
+
     /**
      * Determine if the collection contains a single element.
      * @deprecated since v3.1, use `containsOneItem` instead, will be removed in v3.2.

src/macros/output/Hyperf/Collection/LazyCollection.php

@@ -13,6 +13,24 @@
 
 class LazyCollection
 {
+    /**
+     * Create a new lazy collection instance.
+     *
+     * @param mixed $items
+     * @return static
+     */
+    public static function make($items = [])
+    {
+    }
+
+    /**
+     * Determine if the collection contains a single element.
+     * @return bool
+     */
+    public function isSingle()
+    {
+    }
+
     /**
      * Collapse the collection of items into a single array while preserving its keys.
      *

src/macros/output/Hyperf/HttpServer/Request.php

@@ -0,0 +1,302 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of friendsofhyperf/components.
+ *
+ * @link     https://github.com/friendsofhyperf/components
+ * @document https://github.com/friendsofhyperf/components/blob/main/README.md
+ * @contact  huangdijia@gmail.com
+ */
+
+namespace Hyperf\HttpServer;
+
+use Closure;
+use Hyperf\Support\Fluent;
+use Psr\Http\Message\ServerRequestInterface;
+
+class Request
+{
+    /**
+     * Get an array of all of the files on the request.
+     */
+    public function allFiles(): array
+    {
+    }
+
+    /**
+     * Determine if the request contains a non-empty value for any of the given inputs.
+     *
+     * @param array|string $keys
+     */
+    public function anyFilled($keys): bool
+    {
+    }
+
+    /**
+     * Retrieve input as a boolean value.
+     *
+     * Returns true when value is "1", "true", "on", and "yes". Otherwise, returns false.
+     *
+     * @param null|string $key
+     * @param bool $default
+     */
+    public function boolean($key = null, $default = false): bool
+    {
+    }
+
+    /**
+     * Retrieve input from the request as a collection.
+     */
+    public function collect(null|array|string $key = null): \Hyperf\Collection\Collection
+    {
+    }
+
+    /**
+     * Retrieve input from the request as a Carbon instance.
+     */
+    public function date(string $key, ?string $format = null, ?string $tz = null): ?\Carbon\Carbon
+    {
+    }
+
+    /**
+     * Get all of the input except for a specified array of items.
+     *
+     * @param array|mixed $keys
+     */
+    public function except($keys): array
+    {
+    }
+
+    /**
+     * @param null|Closure(ServerRequestInterface):ServerRequestInterface $closure
+     */
+    public static function fake(?Closure $closure = null): ServerRequestInterface
+    {
+    }
+
+    /**
+     * Determine if the request contains a non-empty value for an input item.
+     */
+    public function filled(array|string $key): bool
+    {
+    }
+
+    public function float(string $key, $default = null): float
+    {
+    }
+
+    /**
+     * Retrieve input from the request as a Fluent object instance.
+     */
+    public function fluent(null|array|string $key = null): Fluent
+    {
+    }
+
+    /**
+     * Determine if the request contains any of the given inputs.
+     */
+    public function hasAny(array|string $keys): bool
+    {
+    }
+
+    /**
+     * Determine if the given input key is an empty string for "has".
+     */
+    public function isEmptyString(string $key): bool
+    {
+    }
+
+    /**
+     * Determine if the request contains an empty value for an input item.
+     */
+    public function isNotFilled(array|string $key): bool
+    {
+    }
+
+    /**
+     * Get the keys for all of the input and files.
+     */
+    public function keys(): array
+    {
+    }
+
+    /**
+     * Get the host name.
+     */
+    public function host(): string
+    {
+    }
+
+    public function getHost(): string
+    {
+    }
+
+    /**
+     * Get the HTTP host being requested.
+     */
+    public function httpHost(): string
+    {
+    }
+
+    public function getHttpHost(): string
+    {
+    }
+
+    public function getPort(): int
+    {
+    }
+
+    public function getPsrRequest(): ?ServerRequestInterface
+    {
+    }
+
+    public function getScheme(): string
+    {
+    }
+
+    public function isSecure(): bool
+    {
+    }
+
+    public function getSchemeAndHttpHost(): string
+    {
+    }
+
+    /**
+     * Get the scheme and HTTP host.
+     */
+    public function schemeAndHttpHost(): string
+    {
+    }
+
+    /**
+     * Merge new input into the current request's input array.
+     *
+     * @return $this
+     */
+    public function merge(array $input): self
+    {
+    }
+
+    /**
+     * Merge new input into the request's input, but only when that key is missing from the request.
+     *
+     * @return $this
+     */
+    public function mergeIfMissing(array $input): self
+    {
+    }
+
+    /**
+     * Determine if the request is missing a given input item key.
+     *
+     * @param array|string $key
+     */
+    public function missing($key): bool
+    {
+    }
+
+    /**
+     * Get a subset containing the provided keys with values from the input data.
+     *
+     * @param array|mixed $keys
+     */
+    public function only($keys): array
+    {
+    }
+
+    /**
+     * Determine if the current request is asking for JSON.
+     */
+    public function wantsJson(): bool
+    {
+    }
+
+    /**
+     * Apply the callback if the request contains a non-empty value for the given input item key.
+     *
+     * @return $this|mixed
+     */
+    public function whenFilled(string $key, callable $callback, ?callable $default = null)
+    {
+    }
+
+    /**
+     * Apply the callback if the request contains the given input item key.
+     *
+     * @return $this|mixed
+     */
+    public function whenHas(string $key, callable $callback, ?callable $default = null)
+    {
+    }
+
+    /**
+     * Determine if the request is sending JSON.
+     */
+    public function isJson(): bool
+    {
+    }
+
+    /**
+     * Retrieve input from the request as an enum.
+     *
+     * @template TEnum
+     *
+     * @param string $key
+     * @param class-string<TEnum> $enumClass
+     * @return null|TEnum
+     */
+    public function enum($key, $enumClass)
+    {
+    }
+
+    /**
+     * Determine if the request contains a given input item key.
+     *
+     * @param array|string $key
+     */
+    public function exists($key): bool
+    {
+    }
+
+    /**
+     * Retrieve input from the request as a Stringable instance.
+     *
+     * @param string $key
+     * @param mixed $default
+     * @return \Hyperf\Stringable\Stringable
+     */
+    public function str($key, $default = null)
+    {
+    }
+
+    /**
+     * Retrieve input from the request as a Stringable instance.
+     *
+     * @param string $key
+     * @param mixed $default
+     * @return \Hyperf\Stringable\Stringable
+     */
+    public function string($key, $default = null)
+    {
+    }
+
+    /**
+     * Retrieve input as an integer value.
+     *
+     * @param string $key
+     * @param int $default
+     */
+    public function integer($key, $default = 0): int
+    {
+    }
+
+    public function validate(array $rules, array $messages = [], array $customAttributes = []): array
+    {
+    }
+
+    public function validateWithBag(string $errorBag, array $rules, array $messages = [], array $customAttributes = []): array
+    {
+    }
+}