From 8721275a159114f91e61fb8798c293fc4e90f15b Mon Sep 17 00:00:00 2001 From: matiasleyba Date: Tue, 5 Aug 2025 10:14:41 -0300 Subject: [PATCH 1/3] docs: create command updates --- site/docs/overview.md | 8 +++++++- site/docs/templates/core.md | 3 +++ site/docs/templates/dart_cli.md | 3 +++ site/docs/templates/dart_pkg.md | 3 +++ site/docs/templates/docs_site.md | 3 +++ site/docs/templates/federated_plugin.md | 3 +++ site/docs/templates/flame_game.md | 3 +++ site/docs/templates/flutter_pkg.md | 3 +++ site/docs/templates/wear.md | 3 +++ 9 files changed, 31 insertions(+), 1 deletion(-) diff --git a/site/docs/overview.md b/site/docs/overview.md index 7c1fe1bf4..27ab819f3 100644 --- a/site/docs/overview.md +++ b/site/docs/overview.md @@ -42,7 +42,9 @@ dart pub global run very_good_cli:very_good ### `very_good create` -Create a very good project in seconds based on the provided template. Each template has a corresponding sub-command. Ex: `very_good create flutter_app` will generate a Flutter starter app. +Create a very good project in seconds based on the provided template. Each template has a corresponding sub-command. + +Ex: `very_good create flutter_app my_app` will generate a Flutter starter app named `my_app`. ```sh Creates a new very good project in the specified directory. @@ -62,6 +64,10 @@ Available subcommands: Run "very_good help" to see global options. ``` +:::tip +You can use `.` as the project name to create the project in the current directory. The project will be named with the name of the current directory. +::: + ### `very_good packages get` Get packages in a Dart or Flutter project. diff --git a/site/docs/templates/core.md b/site/docs/templates/core.md index 3b2bbd673..9280b2f73 100644 --- a/site/docs/templates/core.md +++ b/site/docs/templates/core.md @@ -56,6 +56,9 @@ very_good create flutter_app my_app --desc "My new Flutter app" # Create a new Flutter app named my_app with a custom org very_good create flutter_app my_app --desc "My new Flutter app" --org "com.custom.org" + +# Create a new Flutter app named with the name of the current directory +very_good create flutter_app . --desc "My new Flutter app" ``` ### Running the Project ⚡ diff --git a/site/docs/templates/dart_cli.md b/site/docs/templates/dart_cli.md index 978a9c850..3a01487e8 100644 --- a/site/docs/templates/dart_cli.md +++ b/site/docs/templates/dart_cli.md @@ -16,6 +16,9 @@ very_good create dart_cli my_dart_cli --desc "My new Dart CLI package" # Create a new Dart CLI application named my_dart_cli with a custom executable name very_good create dart_cli my_dart_cli --desc "My new Dart CLI package" --executable-name my_executable_name + +# Create a new Dart CLI named with the name of the current directory +very_good create dart_cli . --desc "My new Dart CLI package" ``` [dart_cli]: /img/dart_cli_hero.png diff --git a/site/docs/templates/dart_pkg.md b/site/docs/templates/dart_pkg.md index 7a9afeea9..44b11d0ad 100644 --- a/site/docs/templates/dart_pkg.md +++ b/site/docs/templates/dart_pkg.md @@ -14,4 +14,7 @@ very_good create dart_package my_dart_package --desc "My new Dart package" # Create a new Dart package named my_dart_package that is publishable very_good create dart_package my_dart_package --desc "My new Dart package" --publishable + +# Create a new Dart package named with the name of the current directory +very_good create dart_package . --desc "My new Dart package" ``` diff --git a/site/docs/templates/docs_site.md b/site/docs/templates/docs_site.md index 4bff3c187..05f3d2d8b 100644 --- a/site/docs/templates/docs_site.md +++ b/site/docs/templates/docs_site.md @@ -31,6 +31,9 @@ This template is powered by [Docusaurus][docusaurus_link] and comes with the fol ```sh # Create a new docs site named my_docs_site very_good create docs_site my_docs_site + +# Create a new docs site named with the name of the current directory +very_good create docs_site . ``` ## Preview 📝 diff --git a/site/docs/templates/federated_plugin.md b/site/docs/templates/federated_plugin.md index 74133d897..ee565ac52 100644 --- a/site/docs/templates/federated_plugin.md +++ b/site/docs/templates/federated_plugin.md @@ -28,6 +28,9 @@ very_good create flutter_plugin my_flutter_plugin --desc "My new Flutter plugin" very_good create flutter_plugin my_flutter_plugin --desc "My new Flutter plugin" --platforms=android,ios,web # or very_good create flutter_plugin my_flutter_plugin --desc "My new Flutter plugin" --platforms android --platforms ios --platforms web + +# Create a new Flutter plugin named with the name of the current directory +very_good create flutter_plugin . --desc "My new Flutter plugin" --platforms android,ios,web ``` [federated_plugin_docs]: https://docs.flutter.dev/development/packages-and-plugins/developing-packages#federated-plugins diff --git a/site/docs/templates/flame_game.md b/site/docs/templates/flame_game.md index 5a65e30d5..3a670bde0 100644 --- a/site/docs/templates/flame_game.md +++ b/site/docs/templates/flame_game.md @@ -29,6 +29,9 @@ Read more about this game template [in our blog][blog]. ```sh # Create a new Flame game named my_game very_good create flame_game my_game --desc "My new Flame game" + +# Create a new Flame game named with the name of the current directory +very_good create flame_game . --desc "My new Flame game" ``` [blog]: https://verygood.ventures/blog/generate-a-game-with-our-new-template diff --git a/site/docs/templates/flutter_pkg.md b/site/docs/templates/flutter_pkg.md index f83060e8f..6885e6a5a 100644 --- a/site/docs/templates/flutter_pkg.md +++ b/site/docs/templates/flutter_pkg.md @@ -14,4 +14,7 @@ very_good create flutter_package my_flutter_package --desc "My new Flutter packa # Create a new Flutter package named my_flutter_package that is publishable very_good create flutter_package my_flutter_package --desc "My new Flutter package" --publishable + +# Create a new Flutter package named with the name of the current directory +very_good create flutter_package . --desc "My new Flutter package" ``` diff --git a/site/docs/templates/wear.md b/site/docs/templates/wear.md index 8dcdb0bcd..ded71e517 100644 --- a/site/docs/templates/wear.md +++ b/site/docs/templates/wear.md @@ -29,6 +29,9 @@ Read more about this app template [in our blog][blog]. ```sh # Create a new Wear OS app named my_wear_app very_good create flutter_app my_wear_app --desc "My new Wear OS app" --template wear + +# Create a new Wear OS named with the name of the current directory +very_good create flutter_app . --desc "My new Wear OS app" --template wear ``` [blog]: https://verygood.ventures/blog/building-wear-os-apps-with-flutter-a-very-good-guide From 4904b3853e9913c0c8a0005d5105a08cfe8008a9 Mon Sep 17 00:00:00 2001 From: matiasleyba Date: Tue, 5 Aug 2025 10:25:46 -0300 Subject: [PATCH 2/3] fix: ignore site updates for releases --- .github/workflows/release_please.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/release_please.yaml b/.github/workflows/release_please.yaml index 81b9087c4..a3f2fa6f6 100644 --- a/.github/workflows/release_please.yaml +++ b/.github/workflows/release_please.yaml @@ -9,6 +9,9 @@ on: push: branches: - main + paths: + - "!.github/workflows/site.yaml" + - "!site/**" jobs: create_release_pr: From 56c9bdd3cb48027267e0dcc5c039ac6b6721ea91 Mon Sep 17 00:00:00 2001 From: matiasleyba Date: Tue, 5 Aug 2025 10:28:55 -0300 Subject: [PATCH 3/3] fix: format --- site/docs/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/docs/overview.md b/site/docs/overview.md index 27ab819f3..546873788 100644 --- a/site/docs/overview.md +++ b/site/docs/overview.md @@ -42,7 +42,7 @@ dart pub global run very_good_cli:very_good ### `very_good create` -Create a very good project in seconds based on the provided template. Each template has a corresponding sub-command. +Create a very good project in seconds based on the provided template. Each template has a corresponding sub-command. Ex: `very_good create flutter_app my_app` will generate a Flutter starter app named `my_app`.