Merge pull request #587 from hydephp/develop

HydePHP v1.4.2 - 2023-12-22

src/Console/Commands/BuildRssFeedCommand.php

@@ -8,7 +8,7 @@
 use LaravelZero\Framework\Commands\Command;
 
 /**
- * Hyde command to run the build process for the RSS feed.
+ * Run the build process for the RSS feed.
  */
 class BuildRssFeedCommand extends Command
 {

src/Console/Commands/BuildSearchCommand.php

@@ -8,15 +8,15 @@
 use LaravelZero\Framework\Commands\Command;
 
 /**
- * Hyde command to run the build process for the documentation search index.
+ * Run the build process for the documentation search index.
  */
 class BuildSearchCommand extends Command
 {
     /** @var string */
     protected $signature = 'build:search';
 
     /** @var string */
-    protected $description = 'Generate the docs/search.json';
+    protected $description = 'Generate the documentation search index';
 
     public function handle(): int
     {

src/Console/Commands/BuildSiteCommand.php

@@ -20,7 +20,7 @@
 use function app;
 
 /**
- * Hyde Command to run the Build Process.
+ * Run the static site build process.
  */
 class BuildSiteCommand extends Command
 {

src/Console/Commands/BuildSitemapCommand.php

@@ -8,7 +8,7 @@
 use LaravelZero\Framework\Commands\Command;
 
 /**
- * Hyde command to run the build process for the sitemap.
+ * Run the build process for the sitemap.
  */
 class BuildSitemapCommand extends Command
 {

src/Console/Commands/ChangeSourceDirectoryCommand.php

@@ -21,13 +21,16 @@
 use function basename;
 use function realpath;
 
+/**
+ * Change the source directory for your project.
+ */
 class ChangeSourceDirectoryCommand extends Command
 {
     /** @var string */
     protected $signature = 'change:sourceDirectory {name : The new source directory name }';
 
     /** @var string */
-    protected $description = 'Change the source directory for your project.';
+    protected $description = 'Change the source directory for your project';
 
     protected $hidden = true;
 

src/Console/Commands/DebugCommand.php

@@ -14,15 +14,15 @@
 use function app;
 
 /**
- * Hyde Command to print debug information.
+ * Print debug information.
  */
 class DebugCommand extends Command
 {
     /** @var string */
     protected $signature = 'debug';
 
     /** @var string */
-    protected $description = 'Print debug info';
+    protected $description = 'Print debug information';
 
     public function __construct()
     {

src/Console/Commands/MakePageCommand.php

@@ -15,7 +15,7 @@
 use function ucfirst;
 
 /**
- * Hyde Command to scaffold a new Markdown or Blade page file.
+ * Scaffold a new Markdown or Blade page file.
  */
 class MakePageCommand extends Command
 {

src/Console/Commands/MakePostCommand.php

@@ -12,7 +12,7 @@
 use function ucwords;
 
 /**
- * Hyde Command to scaffold a new Markdown Post.
+ * Scaffold a new Markdown blog post file.
  */
 class MakePostCommand extends Command
 {

src/Console/Commands/PackageDiscoverCommand.php

@@ -8,6 +8,9 @@
 use Illuminate\Foundation\Console\PackageDiscoverCommand as BaseCommand;
 use Illuminate\Foundation\PackageManifest;
 
+/**
+ * Extended package discovery command to use the custom manifest path.
+ */
 class PackageDiscoverCommand extends BaseCommand
 {
     /** @var true */

src/Console/Commands/PublishConfigsCommand.php

@@ -12,7 +12,7 @@
 use function sprintf;
 
 /**
- * Publish the Hyde Config Files.
+ * Publish the Hyde config files.
  */
 class PublishConfigsCommand extends Command
 {

src/Console/Commands/PublishHomepageCommand.php

@@ -18,7 +18,7 @@
 use function strstr;
 
 /**
- * Publish one of the default homepages.
+ * Publish one of the default homepages to index.blade.php.
  */
 class PublishHomepageCommand extends Command
 {
@@ -29,7 +29,7 @@ class PublishHomepageCommand extends Command
                                 {--force : Overwrite any existing files}';
 
     /** @var string */
-    protected $description = 'Publish one of the default homepages to index.blade.php.';
+    protected $description = 'Publish one of the default homepages to index.blade.php';
 
     /** @var array<string, array{name: string, description: string, group: string}> */
     protected array $options = [

src/Console/Commands/PublishViewsCommand.php

@@ -20,23 +20,23 @@ class PublishViewsCommand extends Command
     protected $signature = 'publish:views {category? : The category to publish}';
 
     /** @var string */
-    protected $description = 'Publish the hyde components for customization. Note that existing files will be overwritten.';
+    protected $description = 'Publish the hyde components for customization. Note that existing files will be overwritten';
 
     /** @var array<string, array<string, string>> */
     protected array $options = [
         'layouts' => [
             'name' => 'Blade Layouts',
-            'description' => 'Shared layout views, such as the app layout, navigation menu, and Markdown page templates.',
+            'description' => 'Shared layout views, such as the app layout, navigation menu, and Markdown page templates',
             'group' => 'hyde-layouts',
         ],
         'components' => [
             'name' => 'Blade Components',
-            'description' => 'More or less self contained components, extracted for customizability and DRY code.',
+            'description' => 'More or less self contained components, extracted for customizability and DRY code',
             'group' => 'hyde-components',
         ],
         'page-404' => [
             'name' => '404 Page',
-            'description' => 'A beautiful 404 error page by the Laravel Collective.',
+            'description' => 'A beautiful 404 error page by the Laravel Collective',
             'group' => 'hyde-page-404',
         ],
     ];

src/Console/Commands/RebuildPageCommand.php

@@ -24,7 +24,7 @@
 use function unslash;
 
 /**
- * Hyde Command to build a single static site file.
+ * Build a single static site file.
  */
 class RebuildPageCommand extends Command
 {

src/Console/Commands/RouteListCommand.php

@@ -15,15 +15,15 @@
 use function sprintf;
 
 /**
- * Hyde command to display the list of site routes.
+ * Display the list of site routes.
  */
 class RouteListCommand extends Command
 {
     /** @var string */
     protected $signature = 'route:list';
 
     /** @var string */
-    protected $description = 'Display all registered routes.';
+    protected $description = 'Display all the registered routes';
 
     public function handle(): int
     {

src/Console/Commands/ServeCommand.php

@@ -25,7 +25,7 @@
 class ServeCommand extends Command
 {
     /** @var string */
-    protected $signature = 'serve 
+    protected $signature = 'serve
         {--host= : <comment>[default: "localhost"]</comment>}}
         {--port= : <comment>[default: 8080]</comment>}
         {--save-preview= : Should the served page be saved to disk? (Overrides config setting)}
@@ -36,7 +36,7 @@ class ServeCommand extends Command
     ';
 
     /** @var string */
-    protected $description = 'Start the realtime compiler server.';
+    protected $description = 'Start the realtime compiler server';
 
     protected ConsoleOutput $console;
 

src/Console/Commands/ValidateCommand.php

@@ -13,6 +13,9 @@
 use function sprintf;
 use function sizeof;
 
+/**
+ * Run a series of tests to validate your setup and help you optimize your site.
+ */
 class ValidateCommand extends Command
 {
     use TracksExecutionTime;
@@ -21,10 +24,10 @@ class ValidateCommand extends Command
     protected $signature = 'validate';
 
     /** @var string */
-    protected $description = 'Test and validate your project to optimize your site.';
+    protected $description = 'Test and validate your project to optimize your site';
 
     /** @var string */
-    protected $help = 'Run a series of tests to validate your setup and help you optimize your site.';
+    protected $help = 'Run a series of tests to validate your setup and help you optimize your site';
 
     protected ValidationService $service;
 

src/Foundation/HydeKernel.php

@@ -49,7 +49,7 @@ class HydeKernel implements SerializableContract
     use Serializable;
     use Macroable;
 
-    final public const VERSION = '1.4.1';
+    final public const VERSION = '1.4.2';
 
     protected static self $instance;
 

src/Foundation/Kernel/RouteCollection.php

@@ -10,7 +10,8 @@
 use Hyde\Support\Models\Route;
 
 /**
- * The RouteCollection contains all the routes, making it the Pseudo-Router for Hyde.
+ * The RouteCollection contains all the page routes, making it the pseudo-router for Hyde,
+ * as it maps each page to the eventual URL that will be used to access it once built.
  *
  * @template T of \Hyde\Support\Models\Route
  *

src/Framework/Actions/StaticPageBuilder.php

@@ -10,7 +10,7 @@
 use Hyde\Pages\Concerns\HydePage;
 
 /**
- * Converts a Page Model into a static HTML page.
+ * Converts a Hyde page object into a static HTML page.
  */
 class StaticPageBuilder
 {

src/Framework/Concerns/InteractsWithFrontMatter.php

@@ -11,7 +11,7 @@
 use function blank;
 
 /**
- * Adds methods to a class to allow it to fluently interact with the front matter.
+ * Adds methods to a class to allow it to fluently interact with its front matter.
  */
 trait InteractsWithFrontMatter
 {

src/Framework/Features/Blogging/Models/PostAuthor.php

@@ -13,7 +13,7 @@
 use function is_string;
 
 /**
- * The Post Author model object.
+ * Object representation of a post author for the site.
  */
 class PostAuthor implements Stringable
 {

tests/Feature/Actions/CreatesNewPageSourceFileTest.php

@@ -144,7 +144,7 @@ public function test_that_a_markdown_file_can_be_created_with_custom_content()
             ---
             title: 'Test Page'
             ---
-            
+
             # Test Page
 
             Hello World!

tests/Feature/LoadYamlConfigurationTest.php

@@ -52,7 +52,7 @@ public function testCanDefineMultipleConfigSettingsInHydeYmlFile()
             name: HydePHP
             url: "http://localhost"
         docs:
-            sidebar: 
+            sidebar:
                 header: "My Docs"
         YAML);
 
@@ -147,7 +147,7 @@ public function testCanAddArbitraryNamespacedData()
 
         $this->file('hyde.yml', <<<'YAML'
         hyde:
-          some: thing 
+          some: thing
         foo:
           bar: baz
         YAML);

tests/Unit/CreatesNewMarkdownPostFileTest.php

@@ -66,7 +66,7 @@ public function testSave()
         ---
 
         ## Write something awesome.
-        
+
         MARKDOWN, file_get_contents($path));
 
         unlink($path);
@@ -89,7 +89,7 @@ public function testSaveWithCustomContent()
         ---
 
         Hello World!
-        
+
         MARKDOWN, file_get_contents($path));
 
         unlink($path);