feat(dart_frog_cli): add cli completion (#503)

Author: felangel

packages/dart_frog_cli/lib/src/command_runner.dart

@@ -2,6 +2,7 @@ import 'dart:io' as io;
 
 import 'package:args/args.dart';
 import 'package:args/command_runner.dart';
+import 'package:cli_completion/cli_completion.dart';
 import 'package:dart_frog_cli/src/commands/commands.dart';
 import 'package:dart_frog_cli/src/commands/update/update.dart';
 import 'package:dart_frog_cli/src/version.dart';
@@ -24,7 +25,7 @@ const executableDescription =
 /// {@template dart_frog_command_runner}
 /// A [CommandRunner] for the Dart Frog CLI.
 /// {@endtemplate}
-class DartFrogCommandRunner extends CommandRunner<int> {
+class DartFrogCommandRunner extends CompletionCommandRunner<int> {
   /// {@macro dart_frog_command_runner}
   DartFrogCommandRunner({
     Logger? logger,
@@ -68,7 +69,10 @@ class DartFrogCommandRunner extends CommandRunner<int> {
       exitCode = ExitCode.software.code;
     }
 
-    if (argResults.command?.name != 'update') await _checkForUpdates();
+    if (argResults.command?.name != 'update' &&
+        argResults.command?.name != 'completion') {
+      await _checkForUpdates();
+    }
 
     return exitCode;
   }
@@ -121,6 +125,10 @@ Run ${lightCyan.wrap('$executableName update')} to update''',
 
   @override
   Future<int?> runCommand(ArgResults topLevelResults) async {
+    if (topLevelResults.command?.name == 'completion') {
+      await super.runCommand(topLevelResults);
+      return ExitCode.success.code;
+    }
     if (topLevelResults['version'] == true) {
       _logger.info(packageVersion);
       return ExitCode.success.code;

packages/dart_frog_cli/pubspec.yaml

@@ -11,6 +11,7 @@ environment:
 
 dependencies:
   args: ^2.1.0
+  cli_completion: ^0.2.0
   mason: ^0.1.0-dev.39
   meta: ^1.7.0
   path: ^1.8.1

packages/dart_frog_cli/test/src/command_runner_test.dart

@@ -158,6 +158,20 @@ void main() {
         }),
       );
 
+      test(
+        'does not show update message when the shell calls the '
+        'completion command',
+        () async {
+          when(
+            () => pubUpdater.getLatestVersion(any()),
+          ).thenAnswer((_) async => latestVersion);
+
+          final result = await commandRunner.run(['completion']);
+          expect(result, equals(ExitCode.success.code));
+          verifyNever(() => logger.info(updateMessage));
+        },
+      );
+
       group('--help', () {
         test(
           'outputs usage',

packages/dart_frog_cli/test/src/commands/create/create_test.dart

@@ -69,27 +69,59 @@ void main() {
 
     test('throws UsageException when project directory is invalid.', () async {
       final directory = Directory.systemTemp.createTempSync();
-      when(() => argResults.rest).thenReturn([directory.path]);
+      when(() => argResults.rest).thenReturn([directory.path, directory.path]);
       when<dynamic>(() => argResults['project-name']).thenReturn(null);
       expect(command.run, throwsA(isA<UsageException>()));
     });
 
-    test('generates a project successfully.', () async {
+    test('generates a project successfully (defaults)', () async {
+      final generatorHooks = _MockGeneratorHooks();
+      final directory = Directory.current.absolute.path;
+      when(
+        () => generatorHooks.postGen(
+          vars: any(named: 'vars'),
+          workingDirectory: any(named: 'workingDirectory'),
+        ),
+      ).thenAnswer((_) async {});
+      when(() => argResults.rest).thenReturn([directory]);
+      when(
+        () => generator.generate(any(), vars: any(named: 'vars')),
+      ).thenAnswer((_) async => []);
+      when(() => generator.hooks).thenReturn(generatorHooks);
+      final exitCode = await command.run();
+      expect(exitCode, equals(ExitCode.success.code));
+      verify(
+        () => generator.generate(
+          any(),
+          vars: {'name': 'dart_frog_cli', 'output_directory': directory},
+        ),
+      ).called(1);
+    });
+
+    test('generates a project successfully (custom)', () async {
       final generatorHooks = _MockGeneratorHooks();
+      final directory = Directory.current.absolute.path;
+      const projectName = 'example';
       when(
         () => generatorHooks.postGen(
           vars: any(named: 'vars'),
           workingDirectory: any(named: 'workingDirectory'),
         ),
       ).thenAnswer((_) async {});
-      when<dynamic>(() => argResults['project-name']).thenReturn('example');
-      when(() => argResults.rest).thenReturn(['.']);
+      when<dynamic>(() => argResults['project-name']).thenReturn(projectName);
+      when(() => argResults.rest).thenReturn([directory]);
       when(
         () => generator.generate(any(), vars: any(named: 'vars')),
       ).thenAnswer((_) async => []);
       when(() => generator.hooks).thenReturn(generatorHooks);
       final exitCode = await command.run();
       expect(exitCode, equals(ExitCode.success.code));
+      verify(
+        () => generator.generate(
+          any(),
+          vars: {'name': projectName, 'output_directory': directory},
+        ),
+      ).called(1);
     });
   });
 }