Merge pull request #403 from hydephp/improve-types

Improve types
hydephp · Aug 11, 2022 · 77a1251 · 77a1251
2 parents d6f8f45 + 2b9f0c0
commit 77a1251
Show file tree

Hide file tree

Showing 20 changed files with 45 additions and 25 deletions.
diff --git a/packages/framework/src/Actions/BladeMatterParser.php b/packages/framework/src/Actions/BladeMatterParser.php
@@ -111,7 +111,7 @@ public static function extractValue(string $line): string
     }
 
     /** @internal Return the proper type for the string */
-    public static function normalizeValue($value): mixed
+    public static function normalizeValue(string $value): mixed
     {
         $value = trim($value);
 

diff --git a/packages/framework/src/Actions/SourceFileParser.php b/packages/framework/src/Actions/SourceFileParser.php
@@ -37,7 +37,8 @@ public function __construct(string $pageClass, string $identifier)
 
     protected function parseBladePage(): BladePage
     {
-        return new BladePage($this->identifier,
+        return new BladePage(
+            $this->identifier,
             (BladeMatterParser::parseFile(BladePage::qualifyBasename($this->identifier)))
         );
     }

diff --git a/packages/framework/src/Commands/HydeMakePostCommand.php b/packages/framework/src/Commands/HydeMakePostCommand.php
@@ -84,7 +84,7 @@ public function handle(): int
                 $this->comment('If you want to overwrite the file supply the --force flag.');
             }
 
-            return $exception->getCode();
+            return (int) $exception->getCode();
         }
     }
 }
diff --git a/packages/framework/src/Commands/HydePackageDiscoverCommand.php b/packages/framework/src/Commands/HydePackageDiscoverCommand.php
@@ -11,6 +11,7 @@
  */
 class HydePackageDiscoverCommand extends BaseCommand
 {
+    /** @var true */
     protected $hidden = true;
 
     public function handle(PackageManifest $manifest)

diff --git a/packages/framework/src/Commands/HydePublishViewsCommand.php b/packages/framework/src/Commands/HydePublishViewsCommand.php
@@ -32,7 +32,7 @@ public function handle(): int
         return 0;
     }
 
-    protected function publishOption($selected): void
+    protected function publishOption(string $selected): void
     {
         (new PublishesHydeViews($selected))->execute();
 

diff --git a/packages/framework/src/Commands/HydeRebuildStaticSiteCommand.php b/packages/framework/src/Commands/HydeRebuildStaticSiteCommand.php
@@ -122,7 +122,7 @@ public function handleException(Exception $exception): int
         $this->error('Something went wrong!');
         $this->warn($exception->getMessage());
 
-        return $exception->getCode();
+        return (int) $exception->getCode();
     }
 
     /**

diff --git a/packages/framework/src/Concerns/FrontMatter/Schemas/BlogPostSchema.php b/packages/framework/src/Concerns/FrontMatter/Schemas/BlogPostSchema.php
@@ -66,7 +66,7 @@ protected function makeDescription(): string
             return substr($this->markdown, 0, 125).'...';
         }
 
-        return $this->markdown;
+        return (string) $this->markdown;
     }
 
     protected function getAuthor(): ?Author

diff --git a/packages/framework/src/Contracts/RouteFacadeContract.php b/packages/framework/src/Contracts/RouteFacadeContract.php
@@ -56,7 +56,7 @@ public static function getFromModel(PageContract $page): RouteContract;
     /**
      * Get all routes from the Router index.
      *
-     * @return \Illuminate\Support\Collection<\Hyde\Framework\Contracts\RouteContract>
+     * @return \Hyde\Framework\RouteCollection<\Hyde\Framework\Contracts\RouteContract>
      */
     public static function all(): Collection;
 

diff --git a/packages/framework/src/HydeKernel.php b/packages/framework/src/HydeKernel.php
@@ -74,7 +74,7 @@ public function getBasePath(): string
         return $this->basePath;
     }
 
-    public function setBasePath(string $basePath)
+    public function setBasePath(string $basePath): void
     {
         $this->basePath = rtrim($basePath, '/\\');
     }

diff --git a/packages/framework/src/Models/Pages/MarkdownPost.php b/packages/framework/src/Models/Pages/MarkdownPost.php
@@ -38,11 +38,14 @@ public function getCanonicalLink(): string
     }
 
     /** @deprecated v0.58.x-beta (pull description instead) */
-    public function getPostDescription(): string
+    public function getPostDescription(): string|null
     {
         return $this->description;
     }
 
+    /**
+     * @return \Illuminate\Support\Collection<\Hyde\Framework\Models\Pages\MarkdownPost>
+     */
     public static function getLatestPosts(): Collection
     {
         return static::all()->sortByDesc('matter.date');

diff --git a/packages/framework/src/Models/Route.php b/packages/framework/src/Models/Route.php
@@ -10,7 +10,6 @@
 use Hyde\Framework\Hyde;
 use Hyde\Framework\Services\RoutingService;
 use Illuminate\Contracts\Support\Arrayable;
-use Illuminate\Support\Collection;
 
 /**
  * @see \Hyde\Framework\Testing\Feature\RouteTest
@@ -131,7 +130,7 @@ public static function getFromModel(PageContract $page): RouteContract
     }
 
     /** @inheritDoc */
-    public static function all(): Collection
+    public static function all(): \Hyde\Framework\RouteCollection
     {
         return RoutingService::getInstance()->getRoutes();
     }

diff --git a/packages/framework/src/Models/ValidationResult.php b/packages/framework/src/Models/ValidationResult.php
@@ -19,7 +19,7 @@ public function __construct(string $defaultMessage = 'Generic check')
         $this->message = $defaultMessage;
     }
 
-    public function pass(?string $withMessage = null): self
+    public function pass(?string $withMessage = null): static
     {
         $this->passed = true;
         if ($withMessage) {
@@ -29,7 +29,7 @@ public function pass(?string $withMessage = null): self
         return $this;
     }
 
-    public function fail(?string $withMessage = null): self
+    public function fail(?string $withMessage = null): static
     {
         $this->passed = false;
         if ($withMessage) {
@@ -39,7 +39,7 @@ public function fail(?string $withMessage = null): self
         return $this;
     }
 
-    public function skip(?string $withMessage = null): self
+    public function skip(?string $withMessage = null): static
     {
         $this->skipped = true;
         if ($withMessage) {
@@ -49,7 +49,7 @@ public function skip(?string $withMessage = null): self
         return $this;
     }
 
-    public function withTip(string $withTip): self
+    public function withTip(string $withTip): static
     {
         $this->tip = $withTip;
 

diff --git a/packages/framework/src/Modules/DataCollections/DataCollection.php b/packages/framework/src/Modules/DataCollections/DataCollection.php
@@ -51,7 +51,7 @@ public function getMarkdownFiles(): array
      * @param  string  $key  for a subdirectory of the _data directory
      * @return DataCollection<\Hyde\Framework\Models\MarkdownDocument>
      */
-    public static function markdown(string $key): DataCollection
+    public static function markdown(string $key): static
     {
         $collection = new DataCollection($key);
         foreach ($collection->getMarkdownFiles() as $file) {

diff --git a/packages/framework/src/Modules/Markdown/CodeblockFilepathProcessor.php b/packages/framework/src/Modules/Markdown/CodeblockFilepathProcessor.php
@@ -36,6 +36,7 @@ public static function process(string $html): string
     {
         $lines = explode("\n", $html);
 
+        /** @var int $index */
         foreach ($lines as $index => $line) {
             if (str_starts_with($line, '<!-- HYDE[Filepath]')) {
                 $path = static::trimHydeDirective($line);
@@ -90,7 +91,7 @@ protected static function resolveTemplate(string $path): string
         return sprintf('<small class="filepath"><span class="sr-only">Filepath: </span>%s</small>', $path);
     }
 
-    protected static function resolveTorchlightCodeLine(string $label, $lines): string|array
+    protected static function resolveTorchlightCodeLine(string $label, string $lines): string
     {
         return str_replace(
             static::$torchlightKey,
@@ -99,7 +100,7 @@ protected static function resolveTorchlightCodeLine(string $label, $lines): stri
         );
     }
 
-    protected static function resolveCodeLine(string $label, $lines): string|array|null
+    protected static function resolveCodeLine(string $label, string $lines): string
     {
         return preg_replace(
             '/<pre><code class="language-(.*?)">/',

diff --git a/packages/framework/src/Modules/Markdown/Shortcodes/AbstractColoredBlockquote.php b/packages/framework/src/Modules/Markdown/Shortcodes/AbstractColoredBlockquote.php
@@ -37,6 +37,9 @@ protected static function getClassNameFromSignature(string $signature): string
         return str_replace('>', '', $signature);
     }
 
+    /**
+     * @return array (AbstractColoredBlockquote)[]
+     */
     public static function get(): array
     {
         return [

diff --git a/packages/framework/src/PageCollection.php b/packages/framework/src/PageCollection.php
@@ -32,7 +32,7 @@ public function getPage(string $sourcePath): PageContract
         return $this->items[$sourcePath] ?? throw new FileNotFoundException($sourcePath.' in page collection');
     }
 
-    public function getPages(?string $pageClass = null): Collection
+    public function getPages(?string $pageClass = null): self
     {
         return ! $pageClass ? $this : $this->filter(function (PageContract $page) use ($pageClass): bool {
             return $page instanceof $pageClass;
@@ -67,6 +67,10 @@ protected function discoverPagesFor(string $pageClass): void
         });
     }
 
+    /**
+     * @param  string<\Hyde\Framework\Contracts\PageContract>  $pageClass
+     * @return \Illuminate\Support\Collection<\Hyde\Framework\Contracts\PageContract>
+     */
     protected function parsePagesFor(string $pageClass): Collection
     {
         $collection = new Collection();

diff --git a/packages/framework/src/Services/BuildService.php b/packages/framework/src/Services/BuildService.php
@@ -5,10 +5,10 @@
 use Hyde\Framework\Concerns\InteractsWithDirectories;
 use Hyde\Framework\Contracts\RouteContract as Route;
 use Hyde\Framework\Hyde;
+use Hyde\Framework\RouteCollection;
 use Hyde\Framework\StaticPageBuilder;
 use Illuminate\Console\Concerns\InteractsWithIO;
 use Illuminate\Console\OutputStyle;
-use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\File;
 
 /**
@@ -67,7 +67,10 @@ function ($filepath) {
         $this->newLine(2);
     }
 
-    protected function getDiscoveredModels(): Collection
+    /**
+     * @return \Hyde\Framework\RouteCollection<array-key, class-string<\Hyde\Framework\Contracts\PageContract>>
+     */
+    protected function getDiscoveredModels(): RouteCollection
     {
         return $this->router->getRoutes()->map(function (Route $route) {
             return $route->getPageType();
@@ -88,6 +91,9 @@ protected function compilePagesForClass(string $pageClass): void
         $this->newLine(2);
     }
 
+    /**
+     * @return \Closure(Route):string
+     */
     protected function compileRoute(): \Closure
     {
         return function (Route $route) {

diff --git a/packages/framework/src/Services/MarkdownService.php b/packages/framework/src/Services/MarkdownService.php
@@ -216,8 +216,8 @@ protected function determineIfTorchlightAttributionShouldBeInjected(): bool
     protected function injectTorchlightAttribution(): string
     {
         return '<br>'.$this->converter->convert(config(
-                'torchlight.attribution.markdown',
-                'Syntax highlighted by torchlight.dev'
-            ));
+            'torchlight.attribution.markdown',
+            'Syntax highlighted by torchlight.dev'
+        ));
     }
 }
diff --git a/packages/framework/src/Services/ValidationService.php b/packages/framework/src/Services/ValidationService.php
@@ -12,6 +12,7 @@
  */
 class ValidationService
 {
+    /** @return string[] */
     public static function checks(): array
     {
         $service = new self();

diff --git a/packages/framework/src/Views/Components/LinkComponent.php b/packages/framework/src/Views/Components/LinkComponent.php
@@ -16,7 +16,8 @@ public function __construct(string $href)
         $this->href = Hyde::relativeLink($href);
     }
 
-    public function render(): View|Factory
+    /** @interitDoc */
+    public function render(): Factory|View
     {
         return view('hyde::components.link');
     }