From 3e427da08ec506bef79915b45b98ab73f60d432c Mon Sep 17 00:00:00 2001 From: Jeff Gandt <1019665+jgandt@users.noreply.github.com> Date: Sun, 15 Nov 2020 00:05:18 -0500 Subject: [PATCH] Make the buffalo verification use the "help" subcommand As of version v0.16.17, the `buffalo` command with no subcommand returns an error after printing out the help message e.g. `ERRO[0000] Error: subcommand is required` Thus adding the help subcommand avoids displaying that error to the new buffalo user. I also updated the output of the help command to the match the latest version. --- .../en/docs/getting-started/installation.md | 27 ++++++++++--------- .../fr/docs/getting-started/installation.md | 27 ++++++++++--------- .../it/docs/getting-started/installation.md | 27 ++++++++++--------- 3 files changed, 42 insertions(+), 39 deletions(-) diff --git a/templates/en/docs/getting-started/installation.md b/templates/en/docs/getting-started/installation.md index 429ac4ef2..e8624da4c 100644 --- a/templates/en/docs/getting-started/installation.md +++ b/templates/en/docs/getting-started/installation.md @@ -130,26 +130,27 @@ These instructions can also be used for upgrading to a newer version of Buffalo. You can check if your installation is working, by executing the `buffalo` command in a terminal/command prompt: ```bash -$ buffalo -Helps you build your Buffalo applications that much easier! +$ buffalo help +Build Buffalo applications with ease Usage: buffalo [command] Available Commands: - build Builds a Buffalo binary, including bundling of assets (packr & webpack) - db A tasty treat for all your database needs - destroy Allows to destroy generated code. - dev Runs your Buffalo app in 'development' mode - generate A collection of generators to make life easier + build Build the application binary, including bundling of assets (packr & webpack) + destroy Destroy generated components + dev Run the Buffalo app in 'development' mode + fix Attempt to fix a Buffalo application's API to match version v0.16.17 + generate Generate application components help Help about any command - info Prints off diagnostic information useful for debugging. + info Print diagnostic information (useful for debugging) new Creates a new Buffalo application - setup Setups a newly created, or recently checked out application. - task Runs your grift tasks - test Runs the tests for your Buffalo app - update will attempt to upgrade a Buffalo application to version v<%= version %> - version Print the version number of buffalo + plugins tools for working with buffalo plugins + routes Print all defined routes + setup Setup a newly created, or recently checked out application. + task Run grift tasks + test Run the tests for the Buffalo app. Use --force-migrations to skip schema load. + version Print the version information Flags: -h, --help help for buffalo diff --git a/templates/fr/docs/getting-started/installation.md b/templates/fr/docs/getting-started/installation.md index 11304dc97..bd1a3b2e8 100644 --- a/templates/fr/docs/getting-started/installation.md +++ b/templates/fr/docs/getting-started/installation.md @@ -130,26 +130,27 @@ Ces instructions peuvent également être utilisées pour mettre à jour votre v Vous pouvez vérifier que votre installation fonctionne, en exécutant la commande `buffalo` dans un terminal (ou console) : ```bash -$ buffalo -Helps you build your Buffalo applications that much easier! +$ buffalo help +Build Buffalo applications with ease Usage: buffalo [command] Available Commands: - build Builds a Buffalo binary, including bundling of assets (packr & webpack) - db A tasty treat for all your database needs - destroy Allows to destroy generated code. - dev Runs your Buffalo app in 'development' mode - generate A collection of generators to make life easier + build Build the application binary, including bundling of assets (packr & webpack) + destroy Destroy generated components + dev Run the Buffalo app in 'development' mode + fix Attempt to fix a Buffalo application's API to match version v0.16.17 + generate Generate application components help Help about any command - info Prints off diagnostic information useful for debugging. + info Print diagnostic information (useful for debugging) new Creates a new Buffalo application - setup Setups a newly created, or recently checked out application. - task Runs your grift tasks - test Runs the tests for your Buffalo app - update will attempt to upgrade a Buffalo application to version v<%= version %> - version Print the version number of buffalo + plugins tools for working with buffalo plugins + routes Print all defined routes + setup Setup a newly created, or recently checked out application. + task Run grift tasks + test Run the tests for the Buffalo app. Use --force-migrations to skip schema load. + version Print the version information Flags: -h, --help help for buffalo diff --git a/templates/it/docs/getting-started/installation.md b/templates/it/docs/getting-started/installation.md index 620e37c99..ff917b009 100644 --- a/templates/it/docs/getting-started/installation.md +++ b/templates/it/docs/getting-started/installation.md @@ -130,26 +130,27 @@ Queste istruzioni possono essere usate anche per aggiornare Buffalo a una nuova Puoi verificare se hai installato tutto in maniera corretta eseguendo il comando `buffalo` in un terminale/prompt dei comandi: ```bash -$ buffalo -Helps you build your Buffalo applications that much easier! +$ buffalo help +Build Buffalo applications with ease Usage: buffalo [command] Available Commands: - build Builds a Buffalo binary, including bundling of assets (packr & webpack) - db A tasty treat for all your database needs - destroy Allows to destroy generated code. - dev Runs your Buffalo app in 'development' mode - generate A collection of generators to make life easier + build Build the application binary, including bundling of assets (packr & webpack) + destroy Destroy generated components + dev Run the Buffalo app in 'development' mode + fix Attempt to fix a Buffalo application's API to match version v0.16.17 + generate Generate application components help Help about any command - info Prints off diagnostic information useful for debugging. + info Print diagnostic information (useful for debugging) new Creates a new Buffalo application - setup Setups a newly created, or recently checked out application. - task Runs your grift tasks - test Runs the tests for your Buffalo app - update will attempt to upgrade a Buffalo application to version v<%= version %> - version Print the version number of buffalo + plugins tools for working with buffalo plugins + routes Print all defined routes + setup Setup a newly created, or recently checked out application. + task Run grift tasks + test Run the tests for the Buffalo app. Use --force-migrations to skip schema load. + version Print the version information Flags: -h, --help help for buffalo