Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Normalize console command descriptions #1503

Merged
merged 3 commits into from
Dec 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This serves two purposes:

### Changed
- Shortened the path printed to console when using the dashboard to create a page in https://github.com/hydephp/develop/pull/1492
- Code cleanup and style improvements in https://github.com/hydephp/develop/pull/1501 and https://github.com/hydephp/develop/pull/1502
- Code cleanup and style improvements in https://github.com/hydephp/develop/pull/1501, https://github.com/hydephp/develop/pull/1502, and https://github.com/hydephp/develop/pull/1503.

### Deprecated
- for soon-to-be removed features.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
2 changes: 1 addition & 1 deletion packages/framework/src/Console/Commands/DebugCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -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()
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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',
],
];
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion packages/framework/src/Console/Commands/ServeCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
4 changes: 2 additions & 2 deletions packages/framework/src/Console/Commands/ValidateCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
Loading