From d5f5241f13be738e31eff85a2d67261e6dba4ba2 Mon Sep 17 00:00:00 2001 From: github-actions Date: Wed, 13 Dec 2023 20:28:16 +0000 Subject: [PATCH 1/5] Merge pull request #1501 from hydephp/format-code Format and normalize files https://github.com/hydephp/develop/commit/5029740295d49f9381d2f7fb9be75d824c83d8fa --- src/Console/Commands/ServeCommand.php | 2 +- tests/Feature/Actions/CreatesNewPageSourceFileTest.php | 2 +- tests/Feature/LoadYamlConfigurationTest.php | 4 ++-- tests/Unit/CreatesNewMarkdownPostFileTest.php | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/Console/Commands/ServeCommand.php b/src/Console/Commands/ServeCommand.php index 9558fa4f..abeb85f9 100644 --- a/src/Console/Commands/ServeCommand.php +++ b/src/Console/Commands/ServeCommand.php @@ -25,7 +25,7 @@ class ServeCommand extends Command { /** @var string */ - protected $signature = 'serve + protected $signature = 'serve {--host= : [default: "localhost"]}} {--port= : [default: 8080]} {--save-preview= : Should the served page be saved to disk? (Overrides config setting)} diff --git a/tests/Feature/Actions/CreatesNewPageSourceFileTest.php b/tests/Feature/Actions/CreatesNewPageSourceFileTest.php index 4b32145f..67cf466d 100644 --- a/tests/Feature/Actions/CreatesNewPageSourceFileTest.php +++ b/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! diff --git a/tests/Feature/LoadYamlConfigurationTest.php b/tests/Feature/LoadYamlConfigurationTest.php index 47f199eb..5cc6edec 100644 --- a/tests/Feature/LoadYamlConfigurationTest.php +++ b/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); diff --git a/tests/Unit/CreatesNewMarkdownPostFileTest.php b/tests/Unit/CreatesNewMarkdownPostFileTest.php index ef889878..47b81290 100644 --- a/tests/Unit/CreatesNewMarkdownPostFileTest.php +++ b/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); From 3368500c78d7ca73eba4802fcb2127d0c9f03ddf Mon Sep 17 00:00:00 2001 From: github-actions Date: Thu, 14 Dec 2023 10:47:53 +0000 Subject: [PATCH 2/5] Merge pull request #1502 from hydephp/normalize-code-comments Clean up and normalize class description comments https://github.com/hydephp/develop/commit/56f3bf8e8d7a98204b366e47f6576da13c588607 --- src/Console/Commands/BuildRssFeedCommand.php | 2 +- src/Console/Commands/BuildSearchCommand.php | 2 +- src/Console/Commands/BuildSiteCommand.php | 2 +- src/Console/Commands/BuildSitemapCommand.php | 2 +- src/Console/Commands/ChangeSourceDirectoryCommand.php | 3 +++ src/Console/Commands/DebugCommand.php | 2 +- src/Console/Commands/MakePageCommand.php | 2 +- src/Console/Commands/MakePostCommand.php | 2 +- src/Console/Commands/PackageDiscoverCommand.php | 3 +++ src/Console/Commands/PublishConfigsCommand.php | 2 +- src/Console/Commands/PublishHomepageCommand.php | 2 +- src/Console/Commands/RebuildPageCommand.php | 2 +- src/Console/Commands/RouteListCommand.php | 2 +- src/Console/Commands/ValidateCommand.php | 3 +++ src/Foundation/Kernel/RouteCollection.php | 3 ++- src/Framework/Actions/StaticPageBuilder.php | 2 +- src/Framework/Concerns/InteractsWithFrontMatter.php | 2 +- src/Framework/Features/Blogging/Models/PostAuthor.php | 2 +- 18 files changed, 25 insertions(+), 15 deletions(-) diff --git a/src/Console/Commands/BuildRssFeedCommand.php b/src/Console/Commands/BuildRssFeedCommand.php index e3b7166b..6880c50b 100644 --- a/src/Console/Commands/BuildRssFeedCommand.php +++ b/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 { diff --git a/src/Console/Commands/BuildSearchCommand.php b/src/Console/Commands/BuildSearchCommand.php index d2f26ffc..a886aad0 100644 --- a/src/Console/Commands/BuildSearchCommand.php +++ b/src/Console/Commands/BuildSearchCommand.php @@ -8,7 +8,7 @@ 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 { diff --git a/src/Console/Commands/BuildSiteCommand.php b/src/Console/Commands/BuildSiteCommand.php index 0de82bb3..263ca07c 100644 --- a/src/Console/Commands/BuildSiteCommand.php +++ b/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 { diff --git a/src/Console/Commands/BuildSitemapCommand.php b/src/Console/Commands/BuildSitemapCommand.php index 4a39616d..65fbf232 100644 --- a/src/Console/Commands/BuildSitemapCommand.php +++ b/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 { diff --git a/src/Console/Commands/ChangeSourceDirectoryCommand.php b/src/Console/Commands/ChangeSourceDirectoryCommand.php index 92f9f318..92b0d583 100644 --- a/src/Console/Commands/ChangeSourceDirectoryCommand.php +++ b/src/Console/Commands/ChangeSourceDirectoryCommand.php @@ -21,6 +21,9 @@ use function basename; use function realpath; +/** + * Change the source directory for your project. + */ class ChangeSourceDirectoryCommand extends Command { /** @var string */ diff --git a/src/Console/Commands/DebugCommand.php b/src/Console/Commands/DebugCommand.php index cf8db2f3..b15a5554 100644 --- a/src/Console/Commands/DebugCommand.php +++ b/src/Console/Commands/DebugCommand.php @@ -14,7 +14,7 @@ use function app; /** - * Hyde Command to print debug information. + * Print debug information. */ class DebugCommand extends Command { diff --git a/src/Console/Commands/MakePageCommand.php b/src/Console/Commands/MakePageCommand.php index e3f47510..6f76e3af 100644 --- a/src/Console/Commands/MakePageCommand.php +++ b/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 { diff --git a/src/Console/Commands/MakePostCommand.php b/src/Console/Commands/MakePostCommand.php index 510784e2..004d9209 100644 --- a/src/Console/Commands/MakePostCommand.php +++ b/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 { diff --git a/src/Console/Commands/PackageDiscoverCommand.php b/src/Console/Commands/PackageDiscoverCommand.php index 5b8d8653..be3cdafb 100644 --- a/src/Console/Commands/PackageDiscoverCommand.php +++ b/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 */ diff --git a/src/Console/Commands/PublishConfigsCommand.php b/src/Console/Commands/PublishConfigsCommand.php index b3b60399..496d88ec 100644 --- a/src/Console/Commands/PublishConfigsCommand.php +++ b/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 { diff --git a/src/Console/Commands/PublishHomepageCommand.php b/src/Console/Commands/PublishHomepageCommand.php index 05744d01..4d0a5602 100644 --- a/src/Console/Commands/PublishHomepageCommand.php +++ b/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 { diff --git a/src/Console/Commands/RebuildPageCommand.php b/src/Console/Commands/RebuildPageCommand.php index 601ca6a5..1ac5e920 100644 --- a/src/Console/Commands/RebuildPageCommand.php +++ b/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 { diff --git a/src/Console/Commands/RouteListCommand.php b/src/Console/Commands/RouteListCommand.php index 1440afe1..ddbed8b5 100644 --- a/src/Console/Commands/RouteListCommand.php +++ b/src/Console/Commands/RouteListCommand.php @@ -15,7 +15,7 @@ use function sprintf; /** - * Hyde command to display the list of site routes. + * Display the list of site routes. */ class RouteListCommand extends Command { diff --git a/src/Console/Commands/ValidateCommand.php b/src/Console/Commands/ValidateCommand.php index 00e61cc0..3a14fed0 100644 --- a/src/Console/Commands/ValidateCommand.php +++ b/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; diff --git a/src/Foundation/Kernel/RouteCollection.php b/src/Foundation/Kernel/RouteCollection.php index 6e2d902e..a93b8eab 100644 --- a/src/Foundation/Kernel/RouteCollection.php +++ b/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 * diff --git a/src/Framework/Actions/StaticPageBuilder.php b/src/Framework/Actions/StaticPageBuilder.php index bf961a1f..ddd89c87 100644 --- a/src/Framework/Actions/StaticPageBuilder.php +++ b/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 { diff --git a/src/Framework/Concerns/InteractsWithFrontMatter.php b/src/Framework/Concerns/InteractsWithFrontMatter.php index 33f33b69..fd8a5bbc 100644 --- a/src/Framework/Concerns/InteractsWithFrontMatter.php +++ b/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 { diff --git a/src/Framework/Features/Blogging/Models/PostAuthor.php b/src/Framework/Features/Blogging/Models/PostAuthor.php index 6364e85b..ac6b850b 100644 --- a/src/Framework/Features/Blogging/Models/PostAuthor.php +++ b/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 { From 6c463f4f056ec1b032c8b9871920728bbba86ebb Mon Sep 17 00:00:00 2001 From: github-actions Date: Thu, 14 Dec 2023 14:34:59 +0000 Subject: [PATCH 3/5] Merge pull request #1503 from hydephp/normalize-code-style Normalize console command descriptions https://github.com/hydephp/develop/commit/b9077e7cfe7246ad8f97da364fa3fe05e4d91bef --- src/Console/Commands/ChangeSourceDirectoryCommand.php | 2 +- src/Console/Commands/DebugCommand.php | 2 +- src/Console/Commands/PublishHomepageCommand.php | 2 +- src/Console/Commands/PublishViewsCommand.php | 8 ++++---- src/Console/Commands/RouteListCommand.php | 2 +- src/Console/Commands/ServeCommand.php | 2 +- src/Console/Commands/ValidateCommand.php | 4 ++-- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/Console/Commands/ChangeSourceDirectoryCommand.php b/src/Console/Commands/ChangeSourceDirectoryCommand.php index 92b0d583..6bffde7f 100644 --- a/src/Console/Commands/ChangeSourceDirectoryCommand.php +++ b/src/Console/Commands/ChangeSourceDirectoryCommand.php @@ -30,7 +30,7 @@ class ChangeSourceDirectoryCommand extends Command 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; diff --git a/src/Console/Commands/DebugCommand.php b/src/Console/Commands/DebugCommand.php index b15a5554..c3f4effc 100644 --- a/src/Console/Commands/DebugCommand.php +++ b/src/Console/Commands/DebugCommand.php @@ -22,7 +22,7 @@ class DebugCommand extends Command protected $signature = 'debug'; /** @var string */ - protected $description = 'Print debug info'; + protected $description = 'Print debug information'; public function __construct() { diff --git a/src/Console/Commands/PublishHomepageCommand.php b/src/Console/Commands/PublishHomepageCommand.php index 4d0a5602..6a2a19dd 100644 --- a/src/Console/Commands/PublishHomepageCommand.php +++ b/src/Console/Commands/PublishHomepageCommand.php @@ -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 */ protected array $options = [ diff --git a/src/Console/Commands/PublishViewsCommand.php b/src/Console/Commands/PublishViewsCommand.php index fb6c0a01..46ef8d6c 100644 --- a/src/Console/Commands/PublishViewsCommand.php +++ b/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> */ 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', ], ]; diff --git a/src/Console/Commands/RouteListCommand.php b/src/Console/Commands/RouteListCommand.php index ddbed8b5..3fcc1ddc 100644 --- a/src/Console/Commands/RouteListCommand.php +++ b/src/Console/Commands/RouteListCommand.php @@ -23,7 +23,7 @@ class RouteListCommand extends Command protected $signature = 'route:list'; /** @var string */ - protected $description = 'Display all registered routes.'; + protected $description = 'Display all the registered routes'; public function handle(): int { diff --git a/src/Console/Commands/ServeCommand.php b/src/Console/Commands/ServeCommand.php index abeb85f9..98972f34 100644 --- a/src/Console/Commands/ServeCommand.php +++ b/src/Console/Commands/ServeCommand.php @@ -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; diff --git a/src/Console/Commands/ValidateCommand.php b/src/Console/Commands/ValidateCommand.php index 3a14fed0..14836641 100644 --- a/src/Console/Commands/ValidateCommand.php +++ b/src/Console/Commands/ValidateCommand.php @@ -24,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; From d99d84d3949ce64badae874535e08c1e35a5faa3 Mon Sep 17 00:00:00 2001 From: github-actions Date: Thu, 14 Dec 2023 14:42:45 +0000 Subject: [PATCH 4/5] Update command description to be better worded https://github.com/hydephp/develop/commit/8dff4cfa6551c419c95da1236d6f292932421f49 --- src/Console/Commands/BuildSearchCommand.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Console/Commands/BuildSearchCommand.php b/src/Console/Commands/BuildSearchCommand.php index a886aad0..03cf8f95 100644 --- a/src/Console/Commands/BuildSearchCommand.php +++ b/src/Console/Commands/BuildSearchCommand.php @@ -16,7 +16,7 @@ class BuildSearchCommand extends Command protected $signature = 'build:search'; /** @var string */ - protected $description = 'Generate the docs/search.json'; + protected $description = 'Generate the documentation search index'; public function handle(): int { From a19a2df127c1a1dfdadbf56df43367de39ec9b9a Mon Sep 17 00:00:00 2001 From: github-actions Date: Fri, 22 Dec 2023 16:47:11 +0000 Subject: [PATCH 5/5] Merge pull request #1505 from hydephp/framework-v1.4.2 Framework version v1.4.2 https://github.com/hydephp/develop/commit/8d24f573255527145df4b6df1a518c717550607c --- src/Foundation/HydeKernel.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Foundation/HydeKernel.php b/src/Foundation/HydeKernel.php index b7c8205b..27666c5f 100644 --- a/src/Foundation/HydeKernel.php +++ b/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;