feat: create command scaffold (#5)

README.md

@@ -26,7 +26,7 @@ Create a new very good flutter application in seconds.
 See the complete list of commands and usage information.
 
 ```sh
-🦄 A Very Good Commandline Interface
+🦄 A Very Good Command Line Interface
 
 Usage: very_good <command> [arguments]
 
@@ -35,7 +35,7 @@ Global options:
  --version Print the current version.
 
 Available commands:
- help Display help information for very_good.
+ create Creates a new very good flutter application in seconds.
 
 Run "very_good help <command>" for more information about a command.
 ```

lib/src/command_runner.dart

@@ -2,6 +2,7 @@ import 'package:args/args.dart';
 import 'package:args/command_runner.dart';
 import 'package:io/io.dart';
 import 'package:mason/mason.dart';
+import 'package:very_good_cli/src/commands/commands.dart';
 
 import 'version.dart';
 
@@ -12,12 +13,13 @@ class VeryGoodCommandRunner extends CommandRunner<int> {
  /// {@macro very_good_command_runner}
  VeryGoodCommandRunner({Logger logger})
  : _logger = logger ?? Logger(),
- super('very_good', '🦄 A Very Good Commandline Interface') {
+ super('very_good', '🦄 A Very Good Command Line Interface') {
  argParser.addFlag(
  'version',
  negatable: false,
  help: 'Print the current version.',
  );
+ addCommand(CreateCommand());
  }
 
  final Logger _logger;

lib/src/commands/commands.dart

@@ -0,0 +1 @@
+export 'create.dart';

lib/src/commands/create.dart

@@ -0,0 +1,26 @@
+import 'package:args/command_runner.dart';
+import 'package:io/io.dart';
+import 'package:mason/mason.dart';
+
+/// {@template create_command}
+/// `very_good create` command creates a new very good flutter app.
+/// {@endtemplate}
+class CreateCommand extends Command<int> {
+ /// {@macro create_command}
+ CreateCommand({Logger logger}) : _logger = logger ?? Logger();
+
+ final Logger _logger;
+
+ @override
+ final String description =
+ 'Creates a new very good flutter application in seconds.';
+
+ @override
+ final String name = 'create';
+
+ @override
+ Future<int> run() async {
+ _logger.alert('Created a Very Good App! 🦄');
+ return ExitCode.success.code;
+ }
+}

test/src/command_runner_test.dart

@@ -70,7 +70,7 @@ void main() {
 
  test('handles no command', overridePrint(() async {
  const expectedPrintLogs = [
- '🦄 A Very Good Commandline Interface\n'
+ '🦄 A Very Good Command Line Interface\n'
  '\n'
  'Usage: very_good <command> [arguments]\n'
  '\n'
@@ -79,7 +79,7 @@ void main() {
  ' --version Print the current version.\n'
  '\n'
  'Available commands:\n'
- ' help Display help information for very_good.\n'
+ ''' create Creates a new very good flutter application in seconds.\n'''
  '\n'
  '''Run "very_good help <command>" for more information about a command.'''
  ];
@@ -91,7 +91,7 @@ void main() {
  group('--help', () {
  test('outputs usage', overridePrint(() async {
  const expectedPrintLogs = [
- '🦄 A Very Good Commandline Interface\n'
+ '🦄 A Very Good Command Line Interface\n'
  '\n'
  'Usage: very_good <command> [arguments]\n'
  '\n'
@@ -100,7 +100,7 @@ void main() {
  ' --version Print the current version.\n'
  '\n'
  'Available commands:\n'
- ' help Display help information for very_good.\n'
+ ''' create Creates a new very good flutter application in seconds.\n'''
  '\n'
  '''Run "very_good help <command>" for more information about a command.'''
  ];

test/src/commands/create_test.dart

@@ -0,0 +1,30 @@
+import 'package:io/io.dart';
+import 'package:mason/mason.dart';
+import 'package:mockito/mockito.dart';
+import 'package:test/test.dart';
+import 'package:very_good_cli/src/commands/create.dart';
+
+class MockLogger extends Mock implements Logger {}
+
+void main() {
+ group('Create', () {
+ Logger logger;
+ CreateCommand command;
+
+ setUp(() {
+ logger = MockLogger();
+ command = CreateCommand(logger: logger);
+ });
+
+ test('can be instantiated without an explicit Logger instance', () {
+ final command = CreateCommand();
+ expect(command, isNotNull);
+ });
+
+ test('completes successfully with correct output', () async {
+ final result = await command.run();
+ expect(result, equals(ExitCode.success.code));
+ verify(logger.alert('Created a Very Good App! 🦄')).called(1);
+ });
+ });
+}