Merge pull request #1813 from hydephp/documentation-generator-fixes

Internal: Add a linting feature to the documentation generator script

Author: emmadesilva

.github/workflows/hyde-stan.yml

@@ -21,3 +21,9 @@ jobs:
 
       - name: Run HydeFront linter
         run: php packages/hydefront/.github/scripts/post-build.php
+
+      - name: Install dependencies
+        run: composer install --no-progress --no-interaction --no-scripts --prefer-dist
+
+      - name: Run DocGen linter
+        run: php monorepo/scripts/docs/DocGen.php --lint

docs/_data/partials/hyde-pages-api/hyde-kernel-base-methods.md

@@ -1,7 +1,7 @@
 <section id="hyde-kernel-base-methods">
 
 <!-- Start generated docs for Hyde\Foundation\HydeKernel -->
-<!-- Generated by HydePHP DocGen script at 2023-03-11 11:09:45 in 2.53ms -->
+<!-- Generated by HydePHP DocGen script at 2024-07-08 20:47:38 in 2.89ms -->
 
 #### `version()`
 
@@ -32,7 +32,7 @@ Hyde::features(): Hyde\Facades\Features
 No description provided.
 
 ```php
-Hyde::hasFeature(Hyde\Enums\Feature $feature): bool
+Hyde::hasFeature(Hyde\Enums\Feature|string $feature): bool
 ```
 
 #### `toArray()`

docs/_data/partials/hyde-pages-api/hyde-page-methods.md

@@ -1,7 +1,7 @@
 <section id="hyde-page-methods">
 
 <!-- Start generated docs for Hyde\Pages\Concerns\HydePage -->
-<!-- Generated by HydePHP DocGen script at 2023-03-10 16:18:02 in 3.30ms -->
+<!-- Generated by HydePHP DocGen script at 2024-07-08 20:48:42 in 5.42ms -->
 
 #### `make()`
 
@@ -24,7 +24,7 @@ HydePage::isDiscoverable(): bool
 Get a page instance from the Kernel&#039;s page index by its identifier.
 
 ```php
-HydePage::get(string $identifier): Hyde\Pages\Concerns\HydePage
+HydePage::get(string $identifier): static
 ```
 
 - **Throws:** \Hyde\Framework\Exceptions\FileNotFoundException If the page does not exist.

monorepo/scripts/docs/DocGen.php

@@ -9,6 +9,24 @@
 use Hyde\Pages\Concerns\HydePage;
 use Illuminate\Support\Str;
 
+// Check if --lint flag is present
+if (in_array('--lint', $argv, true)) {
+    echo "\033[32mLinting...\033[0m";
+
+    // Rerun the script without the --lint flag
+    $output = shell_exec('php '.__FILE__);
+
+    $dirty = str_contains($output, 'Convents saved');
+
+    if ($dirty) {
+        echo " \033[31mDocumentation is not up to date!\033[0m\n";
+        exit(1);
+    }
+
+    echo " \033[32mDocumentation is up to date!\033[0m\n";
+    exit(0);
+}
+
 require_once __DIR__.'/../../../vendor/autoload.php';
 
 echo "\033[32mHydePHP method DocGen\033[0m\n\n";