Repository: VeryGoodOpenSource/very_good_cli
Pull request #625 (2023-01-19 12:38:56)

feat: change description of create sub commands
<!--
  Thanks for contributing!

  Provide a description of your changes below and a general summary in the title

  Please look at the following checklist to ensure that your PR can be accepted quickly:
-->

## Description
Addresses this comment: https://github.com/VeryGoodOpenSource/very_good_cli/pull/621#discussion_r1071544602

## Type of Change

<!--- Put an `x` in all the boxes that apply: -->

- [x] ✨ New feature (non-breaking change which adds functionality)
- [ ] 🛠️ Bug fix (non-breaking change which fixes an issue)
- [ ] ❌ Breaking change (fix or feature that would cause existing functionality to change)
- [ ] 🧹 Code refactor
- [ ] ✅ Build configuration change
- [ ] 📝 Documentation
- [ ] 🗑️ Chore



Patch:
diff --git a/README.md b/README.md
index 8ba756d..51bba88 100644
--- a/README.md
+++ b/README.md
@@ -40,13 +40,13 @@ Usage: very_good create <subcommand> <project-name> [arguments]
 -h, --help    Print this usage information.
 
 Available subcommands:
-  dart_cli          Creates a new very good Dart CLI in the specified directory.
-  dart_package      Creates a new very good Dart package in the specified directory.
-  docs_site         Creates a new very good docs site in the specified directory.
-  flame_game        Creates a new very good Flame game in the specified directory.
-  flutter_app       Creates a new very good Flutter app in the specified directory.
-  flutter_package   Creates a new very good Flutter package in the specified directory.
-  flutter_plugin    Creates a new very good federated Flutter plugin in the specified directory.
+  dart_cli          Generate a Very Good Dart CLI application.
+  dart_package      Generate a Very Good Dart package.
+  docs_site         Generate a Very Good documentation site.
+  flame_game        Generate a Very Good Flame game.
+  flutter_app       Generate a Very Good Flutter application.
+  flutter_package   Generate a Very Good Flutter package.
+  flutter_plugin    Generate a Very Good Flutter plugin.
 
 Run "very_good help" to see global options.
 ```
diff --git a/lib/src/commands/create/commands/dart_cli.dart b/lib/src/commands/create/commands/dart_cli.dart
index 139c357..cdbf989 100644
--- a/lib/src/commands/create/commands/dart_cli.dart
+++ b/lib/src/commands/create/commands/dart_cli.dart
@@ -29,8 +29,7 @@ class CreateDartCLI extends CreateSubCommand with Publishable {
   String get name => 'dart_cli';
 
   @override
-  String get description =>
-      'Creates a new very good Dart CLI in the specified directory.';
+  String get description => 'Generate a Very Good Dart CLI application.';
 
   @override
   Template get template => VeryGoodDartCLITemplate();
diff --git a/lib/src/commands/create/commands/dart_package.dart b/lib/src/commands/create/commands/dart_package.dart
index 39da542..d50e944 100644
--- a/lib/src/commands/create/commands/dart_package.dart
+++ b/lib/src/commands/create/commands/dart_package.dart
@@ -27,8 +27,7 @@ class CreateDartPackage extends CreateSubCommand with Publishable {
   List<String> get aliases => ['dart_pkg'];
 
   @override
-  String get description =>
-      'Creates a new very good Dart package in the specified directory.';
+  String get description => 'Generate a Very Good Dart package.';
 
   @override
   Template get template => DartPkgTemplate();
diff --git a/lib/src/commands/create/commands/docs_site.dart b/lib/src/commands/create/commands/docs_site.dart
index 86d5e67..a69a59d 100644
--- a/lib/src/commands/create/commands/docs_site.dart
+++ b/lib/src/commands/create/commands/docs_site.dart
@@ -33,8 +33,7 @@ class CreateDocsSite extends CreateSubCommand {
   String get name => 'docs_site';
 
   @override
-  String get description =>
-      'Creates a new very good docs site in the specified directory.';
+  String get description => 'Generate a Very Good documentation site.';
 
   @override
   Map<String, dynamic> getTemplateVars() {
diff --git a/lib/src/commands/create/commands/flame_game.dart b/lib/src/commands/create/commands/flame_game.dart
index dd19d4a..3e26c0e 100644
--- a/lib/src/commands/create/commands/flame_game.dart
+++ b/lib/src/commands/create/commands/flame_game.dart
@@ -24,8 +24,7 @@ class CreateFlameGame extends CreateSubCommand with OrgName {
   String get name => 'flame_game';
 
   @override
-  String get description =>
-      'Creates a new very good Flame game in the specified directory.';
+  String get description => 'Generate a Very Good Flame game.';
 
   @override
   Template get template => VeryGoodFlameGameTemplate();
diff --git a/lib/src/commands/create/commands/flutter_app.dart b/lib/src/commands/create/commands/flutter_app.dart
index 4e1ef98..4421bde 100644
--- a/lib/src/commands/create/commands/flutter_app.dart
+++ b/lib/src/commands/create/commands/flutter_app.dart
@@ -30,8 +30,7 @@ class CreateFlutterApp extends CreateSubCommand with OrgName {
   String get name => 'flutter_app';
 
   @override
-  String get description =>
-      'Creates a new very good Flutter app in the specified directory.';
+  String get description => 'Generate a Very Good Flutter application.';
 
   @override
   Template get template => VeryGoodCoreTemplate();
diff --git a/lib/src/commands/create/commands/flutter_package.dart b/lib/src/commands/create/commands/flutter_package.dart
index 51a509d..9f55ddf 100644
--- a/lib/src/commands/create/commands/flutter_package.dart
+++ b/lib/src/commands/create/commands/flutter_package.dart
@@ -27,8 +27,7 @@ class CreateFlutterPackage extends CreateSubCommand with Publishable {
   List<String> get aliases => ['flutter_pkg'];
 
   @override
-  String get description =>
-      'Creates a new very good Flutter package in the specified directory.';
+  String get description => 'Generate a Very Good Flutter package.';
 
   @override
   Template get template => FlutterPkgTemplate();
diff --git a/lib/src/commands/create/commands/flutter_plugin.dart b/lib/src/commands/create/commands/flutter_plugin.dart
index a4e52eb..7b42732 100644
--- a/lib/src/commands/create/commands/flutter_plugin.dart
+++ b/lib/src/commands/create/commands/flutter_plugin.dart
@@ -40,9 +40,7 @@ class CreateFlutterPlugin extends CreateSubCommand with Publishable {
   String get name => 'flutter_plugin';
 
   @override
-  String get description =>
-      'Creates a new very good federated Flutter plugin in the specified '
-      'directory.';
+  String get description => 'Generate a Very Good Flutter plugin.';
 
   @override
   Template get template => FlutterPluginTemplate();
diff --git a/lib/src/commands/create/templates/very_good_dart_package/very_good_dart_package_template.dart b/lib/src/commands/create/templates/very_good_dart_package/very_good_dart_package_template.dart
index 0651522..055f295 100644
--- a/lib/src/commands/create/templates/very_good_dart_package/very_good_dart_package_template.dart
+++ b/lib/src/commands/create/templates/very_good_dart_package/very_good_dart_package_template.dart
@@ -12,7 +12,7 @@ class DartPkgTemplate extends Template {
       : super(
           name: 'dart_pkg',
           bundle: veryGoodDartPackageBundle,
-          help: 'Generate a reusable Dart package.',
+          help: 'Generate a Very Good Dart package.',
         );
 
   @override
diff --git a/lib/src/commands/create/templates/very_good_flutter_package/very_good_flutter_package_template.dart b/lib/src/commands/create/templates/very_good_flutter_package/very_good_flutter_package_template.dart
index b9e3768..a508e77 100644
--- a/lib/src/commands/create/templates/very_good_flutter_package/very_good_flutter_package_template.dart
+++ b/lib/src/commands/create/templates/very_good_flutter_package/very_good_flutter_package_template.dart
@@ -12,7 +12,7 @@ class FlutterPkgTemplate extends Template {
       : super(
           name: 'flutter_pkg',
           bundle: veryGoodFlutterPackageBundle,
-          help: 'Generate a reusable Flutter package.',
+          help: 'Generate a Very Good Flutter package.',
         );
 
   @override
diff --git a/lib/src/commands/create/templates/very_good_flutter_plugin/very_good_flutter_plugin_template.dart b/lib/src/commands/create/templates/very_good_flutter_plugin/very_good_flutter_plugin_template.dart
index 6a71b0f..7ff2ede 100644
--- a/lib/src/commands/create/templates/very_good_flutter_plugin/very_good_flutter_plugin_template.dart
+++ b/lib/src/commands/create/templates/very_good_flutter_plugin/very_good_flutter_plugin_template.dart
@@ -12,7 +12,7 @@ class FlutterPluginTemplate extends Template {
       : super(
           name: 'flutter_plugin',
           bundle: veryGoodFlutterPluginBundle,
-          help: 'Generate a reusable Flutter plugin.',
+          help: 'Generate a Very Good Flutter plugin.',
         );
 
   @override
diff --git a/site/docs/overview.md b/site/docs/overview.md
index 5558633..59baf6a 100644
--- a/site/docs/overview.md
+++ b/site/docs/overview.md
@@ -37,13 +37,13 @@ Usage: very_good create <subcommand> <project-name> [arguments]
 -h, --help    Print this usage information.
 
 Available subcommands:
-  dart_cli          Creates a new very good Dart CLI in the specified directory.
-  dart_package      Creates a new very good Dart package in the specified directory.
-  docs_site         Creates a new very good docs site in the specified directory.
-  flame_game        Creates a new very good Flame game in the specified directory.
-  flutter_app       Creates a new very good Flutter app in the specified directory.
-  flutter_package   Creates a new very good Flutter package in the specified directory.
-  flutter_plugin    Creates a new very good federated Flutter plugin in the specified directory.
+  dart_cli          Generate a Very Good Dart CLI application.
+  dart_package      Generate a Very Good Dart package.
+  docs_site         Generate a Very Good documentation site.
+  flame_game        Generate a Very Good Flame game.
+  flutter_app       Generate a Very Good Flutter application.
+  flutter_package   Generate a Very Good Flutter package.
+  flutter_plugin    Generate a Very Good Flutter plugin.
 
 Run "very_good help" to see global options.
 ```
diff --git a/site/docs/resources/syntax_changes_in_0_10_0.md b/site/docs/resources/syntax_changes_in_0_10_0.md
index 95400d1..b155584 100644
--- a/site/docs/resources/syntax_changes_in_0_10_0.md
+++ b/site/docs/resources/syntax_changes_in_0_10_0.md
@@ -30,6 +30,7 @@ The default template (core) is now under the sub-command flutter_app
 
 ```diff
 - very_good create my_flutter_package -t flutter_pkg --desc "My new Flutter package"
+
 + very_good create flutter_package my_flutter_package --desc "My new Flutter package"
 + very_good create flutter_pkg my_flutter_package --desc "My new Flutter package"
 ```


Test patch:
diff --git a/test/src/commands/create/commands/dart_cli_test.dart b/test/src/commands/create/commands/dart_cli_test.dart
index 1f30244..cf6fbcd 100644
--- a/test/src/commands/create/commands/dart_cli_test.dart
+++ b/test/src/commands/create/commands/dart_cli_test.dart
@@ -27,7 +27,7 @@ class FakeDirectoryGeneratorTarget extends Fake
 
 final expectedUsage = [
   '''
-Creates a new very good Dart CLI in the specified directory.
+Generate a Very Good Dart CLI application.
 
 Usage: very_good create dart_cli <project-name> [arguments]
 -h, --help                Print this usage information.
@@ -83,7 +83,7 @@ void main() {
       expect(command.name, equals('dart_cli'));
       expect(
         command.description,
-        equals('Creates a new very good Dart CLI in the specified directory.'),
+        equals('Generate a Very Good Dart CLI application.'),
       );
       expect(command.logger, equals(logger));
       expect(command, isA<Publishable>());
diff --git a/test/src/commands/create/commands/dart_package_test.dart b/test/src/commands/create/commands/dart_package_test.dart
index be6113d..2e68e21 100644
--- a/test/src/commands/create/commands/dart_package_test.dart
+++ b/test/src/commands/create/commands/dart_package_test.dart
@@ -27,7 +27,7 @@ class FakeDirectoryGeneratorTarget extends Fake
 
 final expectedUsage = [
   '''
-Creates a new very good Dart package in the specified directory.
+Generate a Very Good Dart package.
 
 Usage: very_good create dart_package <project-name> [arguments]
 -h, --help                Print this usage information.
@@ -83,7 +83,7 @@ void main() {
       expect(
         command.description,
         equals(
-          'Creates a new very good Dart package in the specified directory.',
+          'Generate a Very Good Dart package.',
         ),
       );
       expect(command.logger, equals(logger));
diff --git a/test/src/commands/create/commands/docs_site_test.dart b/test/src/commands/create/commands/docs_site_test.dart
index 13b5b8b..8d04b2b 100644
--- a/test/src/commands/create/commands/docs_site_test.dart
+++ b/test/src/commands/create/commands/docs_site_test.dart
@@ -27,7 +27,7 @@ class FakeDirectoryGeneratorTarget extends Fake
 
 final expectedUsage = [
   '''
-Creates a new very good docs site in the specified directory.
+Generate a Very Good documentation site.
 
 Usage: very_good create docs_site <project-name> [arguments]
 -h, --help                Print this usage information.
@@ -83,9 +83,7 @@ void main() {
       expect(command.name, equals('docs_site'));
       expect(
         command.description,
-        equals(
-          'Creates a new very good docs site in the specified directory.',
-        ),
+        equals('Generate a Very Good documentation site.'),
       );
       expect(command.logger, equals(logger));
       expect(command, isA<CreateSubCommand>());
diff --git a/test/src/commands/create/commands/flame_game_test.dart b/test/src/commands/create/commands/flame_game_test.dart
index 3c07753..9ff7b5b 100644
--- a/test/src/commands/create/commands/flame_game_test.dart
+++ b/test/src/commands/create/commands/flame_game_test.dart
@@ -28,7 +28,7 @@ class FakeDirectoryGeneratorTarget extends Fake
 
 final expectedUsage = [
   '''
-Creates a new very good Flame game in the specified directory.
+Generate a Very Good Flame game.
 
 Usage: very_good create flame_game <project-name> [arguments]
 -h, --help                Print this usage information.
@@ -90,9 +90,7 @@ void main() {
       expect(command.name, equals('flame_game'));
       expect(
         command.description,
-        equals(
-          'Creates a new very good Flame game in the specified directory.',
-        ),
+        equals('Generate a Very Good Flame game.'),
       );
       expect(command.logger, equals(logger));
     });
diff --git a/test/src/commands/create/commands/flutter_app_test.dart b/test/src/commands/create/commands/flutter_app_test.dart
index 639fbfd..a4aa365 100644
--- a/test/src/commands/create/commands/flutter_app_test.dart
+++ b/test/src/commands/create/commands/flutter_app_test.dart
@@ -27,7 +27,7 @@ class FakeDirectoryGeneratorTarget extends Fake
 
 final expectedUsage = [
   '''
-Creates a new very good Flutter app in the specified directory.
+Generate a Very Good Flutter application.
 
 Usage: very_good create flutter_app <project-name> [arguments]
 -h, --help                Print this usage information.
@@ -90,9 +90,7 @@ void main() {
       expect(command.name, equals('flutter_app'));
       expect(
         command.description,
-        equals(
-          'Creates a new very good Flutter app in the specified directory.',
-        ),
+        equals('Generate a Very Good Flutter application.'),
       );
       expect(command.logger, equals(logger));
       expect(command.argParser.options, contains('application-id'));
diff --git a/test/src/commands/create/commands/flutter_package_test.dart b/test/src/commands/create/commands/flutter_package_test.dart
index 808b034..850ee78 100644
--- a/test/src/commands/create/commands/flutter_package_test.dart
+++ b/test/src/commands/create/commands/flutter_package_test.dart
@@ -27,7 +27,7 @@ class FakeDirectoryGeneratorTarget extends Fake
 
 final expectedUsage = [
   '''
-Creates a new very good Flutter package in the specified directory.
+Generate a Very Good Flutter package.
 
 Usage: very_good create flutter_package <project-name> [arguments]
 -h, --help                Print this usage information.
@@ -82,9 +82,7 @@ void main() {
       expect(command.name, equals('flutter_package'));
       expect(
         command.description,
-        equals(
-          'Creates a new very good Flutter package in the specified directory.',
-        ),
+        equals('Generate a Very Good Flutter package.'),
       );
       expect(command.logger, equals(logger));
       expect(command, isA<Publishable>());
diff --git a/test/src/commands/create/commands/flutter_plugin_test.dart b/test/src/commands/create/commands/flutter_plugin_test.dart
index 2541a9e..2943e67 100644
--- a/test/src/commands/create/commands/flutter_plugin_test.dart
+++ b/test/src/commands/create/commands/flutter_plugin_test.dart
@@ -27,7 +27,7 @@ class FakeDirectoryGeneratorTarget extends Fake
 
 final expectedUsage = [
   '''
-Creates a new very good federated Flutter plugin in the specified directory.
+Generate a Very Good Flutter plugin.
 
 Usage: very_good create flutter_plugin <project-name> [arguments]
 -h, --help                       Print this usage information.
@@ -91,8 +91,7 @@ void main() {
       expect(
         command.description,
         equals(
-          'Creates a new very good federated Flutter plugin in the specified '
-          'directory.',
+          'Generate a Very Good Flutter plugin.',
         ),
       );
       expect(command.logger, equals(logger));
diff --git a/test/src/commands/create/commands/legacy_test.dart b/test/src/commands/create/commands/legacy_test.dart
index 5230954..d63ac27 100644
--- a/test/src/commands/create/commands/legacy_test.dart
+++ b/test/src/commands/create/commands/legacy_test.dart
@@ -23,13 +23,13 @@ Usage: very_good create <subcommand> <project-name> [arguments]
 -h, --help    Print this usage information.
 
 Available subcommands:
-  dart_cli          Creates a new very good Dart CLI in the specified directory.
-  dart_package      Creates a new very good Dart package in the specified directory.
-  docs_site         Creates a new very good docs site in the specified directory.
-  flame_game        Creates a new very good Flame game in the specified directory.
-  flutter_app       Creates a new very good Flutter app in the specified directory.
-  flutter_package   Creates a new very good Flutter package in the specified directory.
-  flutter_plugin    Creates a new very good federated Flutter plugin in the specified directory.
+  dart_cli          Generate a Very Good Dart CLI application.
+  dart_package      Generate a Very Good Dart package.
+  docs_site         Generate a Very Good documentation site.
+  flame_game        Generate a Very Good Flame game.
+  flutter_app       Generate a Very Good Flutter application.
+  flutter_package   Generate a Very Good Flutter package.
+  flutter_plugin    Generate a Very Good Flutter plugin.
 
 Run "very_good help" to see global options.'''
 ];
diff --git a/test/src/commands/create/create_test.dart b/test/src/commands/create/create_test.dart
index 8d09b12..5774067 100644
--- a/test/src/commands/create/create_test.dart
+++ b/test/src/commands/create/create_test.dart
@@ -29,13 +29,13 @@ Usage: very_good create <subcommand> <project-name> [arguments]
 -h, --help    Print this usage information.
 
 Available subcommands:
-  dart_cli          Creates a new very good Dart CLI in the specified directory.
-  dart_package      Creates a new very good Dart package in the specified directory.
-  docs_site         Creates a new very good docs site in the specified directory.
-  flame_game        Creates a new very good Flame game in the specified directory.
-  flutter_app       Creates a new very good Flutter app in the specified directory.
-  flutter_package   Creates a new very good Flutter package in the specified directory.
-  flutter_plugin    Creates a new very good federated Flutter plugin in the specified directory.
+  dart_cli          Generate a Very Good Dart CLI application.
+  dart_package      Generate a Very Good Dart package.
+  docs_site         Generate a Very Good documentation site.
+  flame_game        Generate a Very Good Flame game.
+  flutter_app       Generate a Very Good Flutter application.
+  flutter_package   Generate a Very Good Flutter package.
+  flutter_plugin    Generate a Very Good Flutter plugin.
 
 Run "very_good help" to see global options.'''
 ];
@@ -163,11 +163,11 @@ Usage: Deprecated usage of the create command: run 'very_good create --help' to
 
           [core] (default)    Generate a Very Good Flutter application.
           [dart_cli]          Generate a Very Good Dart CLI application.
-          [dart_pkg]          Generate a reusable Dart package.
+          [dart_pkg]          Generate a Very Good Dart package.
           [docs_site]         Generate a Very Good documentation site.
           [flame_game]        Generate a Very Good Flame game.
-          [flutter_pkg]       Generate a reusable Flutter package.
-          [flutter_plugin]    Generate a reusable Flutter plugin.
+          [flutter_pkg]       Generate a Very Good Flutter package.
+          [flutter_plugin]    Generate a Very Good Flutter plugin.
 
     --org-name                The organization for this new project.
                               (defaults to "com.example.verygoodcore")