Merge pull request #851 from hydephp/housekeeping

Improve type coverage
hydephp · Jan 21, 2023 · 4a48814 · 4a48814
2 parents b346c13 + 592c3fd
commit 4a48814
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 11 deletions.
diff --git a/packages/framework/src/Framework/Concerns/RegistersFileLocations.php b/packages/framework/src/Framework/Concerns/RegistersFileLocations.php
@@ -36,16 +36,15 @@ protected function registerSourceDirectories(array $directoryMapping): void
         }
     }
 
-    /*
+    /**
      * Register the optional output directories.
      * Some HTML pages, like Blade and Markdown pages are stored right in the _site/ directory.
      * However, some pages, like docs and posts are in subdirectories of the _site/ directory.
      * Location string should be relative to the root of the application.
      *
      * @example registerOutputDirectories([HydePage::class => 'docs'])
      *
-     * @param  array  $directoryMapping{class: string<HydePage>, location: string}
-     * @return void
+     * @param  array  $directoryMapping{class:  string<HydePage>, location: string}
      */
     protected function registerOutputDirectories(array $directoryMapping): void
     {

diff --git a/packages/framework/src/Framework/Features/Metadata/Elements/LinkElement.php b/packages/framework/src/Framework/Features/Metadata/Elements/LinkElement.php
@@ -35,7 +35,7 @@ protected function formatOptionalAttributes(): string
             return '';
         }
 
-        return sprintf(' %s', collect($this->attr)->map(function ($value, $key): string {
+        return sprintf(' %s', collect($this->attr)->map(function (string $value, string $key): string {
             return e($key).'="'.e($value).'"';
         })->implode(' '));
     }

diff --git a/packages/framework/src/Framework/Services/DiscoveryService.php b/packages/framework/src/Framework/Services/DiscoveryService.php
@@ -62,6 +62,7 @@ public static function getDocumentationPageFiles(): array
      * Supply a model::class constant and get a list of all the existing source file base names.
      *
      * @param  class-string<\Hyde\Pages\Concerns\HydePage>  $model
+     * @return array<string>
      *
      * @throws \Hyde\Framework\Exceptions\UnsupportedPageTypeException
      *

diff --git a/packages/framework/src/Markdown/Processing/BladeDownProcessor.php b/packages/framework/src/Markdown/Processing/BladeDownProcessor.php
@@ -34,9 +34,9 @@ public static function render(string $html, ?array $pageData = []): string
 
     public static function preprocess(string $markdown): string
     {
-        return implode("\n", array_map(function ($line): string {
+        return implode("\n", array_map(function (string $line): string {
             return str_starts_with(strtolower($line), strtolower('[Blade]:'))
-                ? '<!-- HYDE'.trim(htmlentities($line)).' -->'
+                ? '<!-- HYDE'.trim(e($line)).' -->'
                 : $line;
         }, explode("\n", $markdown)));
     }
@@ -54,7 +54,7 @@ public function __construct(string $html, ?array $pageData = [])
 
     public function run(): static
     {
-        $this->output = implode("\n", array_map(function ($line): string {
+        $this->output = implode("\n", array_map(function (string $line): string {
             return $this->lineStartsWithDirective($line)
                 ? $this->processLine($line)
                 : $line;

diff --git a/packages/framework/src/Markdown/Processing/ShortcodeProcessor.php b/packages/framework/src/Markdown/Processing/ShortcodeProcessor.php
@@ -52,7 +52,7 @@ public function __construct(string $input)
 
     public function processInput(): static
     {
-        $this->output = implode("\n", array_map(function ($line): string {
+        $this->output = implode("\n", array_map(function (string $line): string {
             return $this->expandShortcode($line);
         }, explode("\n", $this->input)));
 

diff --git a/packages/framework/src/Pages/Concerns/HydePage.php b/packages/framework/src/Pages/Concerns/HydePage.php
@@ -104,9 +104,9 @@ public static function parse(string $identifier): HydePage
      *
      * Essentially an alias of DiscoveryService::getAbstractPageList().
      *
-     * @return array<string>|false
+     * @return array<string>
      */
-    public static function files(): array|false
+    public static function files(): array
     {
         return DiscoveryService::getSourceFileListForModel(static::class);
     }

diff --git a/packages/framework/src/Support/Concerns/Serializable.php b/packages/framework/src/Support/Concerns/Serializable.php
@@ -21,7 +21,7 @@ public function jsonSerialize(): array
         return $this->toArray();
     }
 
-    /** @inheritDoc */
+    /** @param  int  $options */
     public function toJson($options = 0): string
     {
         return json_encode($this->jsonSerialize(), $options);