Skip to content

Commit

Permalink
feat: change description of create sub commands (#625)
Browse files Browse the repository at this point in the history
* feat: change description of create sub commands

* remove the 'reusable' thing from description
  • Loading branch information
renancaraujo committed Jan 20, 2023
1 parent c44f194 commit 560f44a
Show file tree
Hide file tree
Showing 22 changed files with 56 additions and 72 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
```
Expand Down
3 changes: 1 addition & 2 deletions lib/src/commands/create/commands/dart_cli.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down
3 changes: 1 addition & 2 deletions lib/src/commands/create/commands/dart_package.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down
3 changes: 1 addition & 2 deletions lib/src/commands/create/commands/docs_site.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand Down
3 changes: 1 addition & 2 deletions lib/src/commands/create/commands/flame_game.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down
3 changes: 1 addition & 2 deletions lib/src/commands/create/commands/flutter_app.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down
3 changes: 1 addition & 2 deletions lib/src/commands/create/commands/flutter_package.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down
4 changes: 1 addition & 3 deletions lib/src/commands/create/commands/flutter_plugin.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 7 additions & 7 deletions site/docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
```
Expand Down
1 change: 1 addition & 0 deletions site/docs/resources/syntax_changes_in_0_10_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
```
Expand Down
4 changes: 2 additions & 2 deletions test/src/commands/create/commands/dart_cli_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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>());
Expand Down
4 changes: 2 additions & 2 deletions test/src/commands/create/commands/dart_package_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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));
Expand Down
6 changes: 2 additions & 4 deletions test/src/commands/create/commands/docs_site_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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>());
Expand Down
6 changes: 2 additions & 4 deletions test/src/commands/create/commands/flame_game_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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));
});
Expand Down
6 changes: 2 additions & 4 deletions test/src/commands/create/commands/flutter_app_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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'));
Expand Down
6 changes: 2 additions & 4 deletions test/src/commands/create/commands/flutter_package_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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>());
Expand Down
5 changes: 2 additions & 3 deletions test/src/commands/create/commands/flutter_plugin_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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));
Expand Down
14 changes: 7 additions & 7 deletions test/src/commands/create/commands/legacy_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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.'''
];
Expand Down
20 changes: 10 additions & 10 deletions test/src/commands/create/create_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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.'''
];
Expand Down Expand Up @@ -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")
Expand Down

0 comments on commit 560f44a

Please sign in to comment.