feat: add optional auto-install (#29)

Author: renancaraujo

lib/src/command_runner/completion_command_runner.dart

@@ -42,6 +42,15 @@ abstract class CompletionCommandRunner<T> extends CommandRunner<T> {
 
   CompletionInstallation? _completionInstallation;
 
+  /// Define whether the installation of the completion files should done
+  /// automatically upon the first command run.
+  ///
+  /// If set to false the user will have to manually install the completion
+  /// files via the `install-completion-files` command.
+  ///
+  /// Override this field to disable auto installation.
+  bool get enableAutoInstall => true;
+
   /// The [CompletionInstallation] used to install completion files.
   CompletionInstallation get completionInstallation {
     var completionInstallation = _completionInstallation;
@@ -62,7 +71,8 @@ abstract class CompletionCommandRunner<T> extends CommandRunner<T> {
       InstallCompletionFilesCommand.commandName,
     ];
 
-    if (!reservedCommands.contains(topLevelResults.command?.name)) {
+    if (enableAutoInstall &&
+        !reservedCommands.contains(topLevelResults.command?.name)) {
       // When auto installing, use error level to display messages.
       tryInstallCompletionFiles(Level.error);
     }
@@ -77,6 +87,8 @@ abstract class CompletionCommandRunner<T> extends CommandRunner<T> {
       completionInstallationLogger.level = level;
       completionInstallation.install(executableName);
     } on CompletionInstallationException catch (e) {
+      completionInstallationLogger.warn(e.toString());
+    } on Exception catch (e) {
       completionInstallationLogger.err(e.toString());
     }
   }

test/src/command_runner/completion_command_runner_test.dart

@@ -14,6 +14,9 @@ class MockCompletionInstallation extends Mock
 class _TestCompletionCommandRunner extends CompletionCommandRunner<int> {
   _TestCompletionCommandRunner() : super('test', 'Test command runner');
 
+  @override
+  bool enableAutoInstall = true;
+
   @override
   // ignore: overridden_fields
   final Logger completionLogger = MockLogger();
@@ -52,6 +55,10 @@ class _TestCompletionResult extends CompletionResult {
 }
 
 void main() {
+  setUpAll(() {
+    registerFallbackValue(Level.error);
+  });
+
   group('CompletionCommandRunner', () {
     test('can be instantiated', () {
       final commandRunner = _TestCompletionCommandRunner();
@@ -105,40 +112,72 @@ void main() {
       );
     });
 
-    test('Tries to install completion file test subcommand', () async {
-      final commandRunner = _TestCompletionCommandRunner()
-        ..addCommand(_TestUserCommand())
-        ..mockCompletionInstallation = MockCompletionInstallation();
+    group('auto install', () {
+      test('Tries to install completion files on test subcommand', () async {
+        final commandRunner = _TestCompletionCommandRunner()
+          ..addCommand(_TestUserCommand())
+          ..mockCompletionInstallation = MockCompletionInstallation();
 
-      await commandRunner.run(['ahoy']);
+        await commandRunner.run(['ahoy']);
 
-      verify(() => commandRunner.completionInstallation.install('test'))
-          .called(1);
+        verify(() => commandRunner.completionInstallation.install('test'))
+            .called(1);
+
+        verify(
+          () => commandRunner.completionInstallationLogger.level = Level.error,
+        ).called(1);
+      });
+
+      test('does not auto install when it is disabled', () async {
+        final commandRunner = _TestCompletionCommandRunner()
+          ..enableAutoInstall = false
+          ..addCommand(_TestUserCommand())
+          ..mockCompletionInstallation = MockCompletionInstallation();
+
+        await commandRunner.run(['ahoy']);
 
-      verify(
-        () => commandRunner.completionInstallationLogger.level = Level.error,
-      ).called(1);
+        verifyNever(() => commandRunner.completionInstallation.install('test'));
+
+        verifyNever(
+          () => commandRunner.completionInstallationLogger.level = any(),
+        );
+      });
     });
 
-    test('When something goes wrong on install, it logs as error', () async {
+    test(
+      'When it throws CompletionInstallationException, it logs as a warning',
+      () async {
+        final commandRunner = _TestCompletionCommandRunner()
+          ..addCommand(_TestUserCommand())
+          ..mockCompletionInstallation = MockCompletionInstallation();
+
+        when(
+          () => commandRunner.completionInstallation.install('test'),
+        ).thenThrow(
+          CompletionInstallationException(message: 'oops', rootCommand: 'test'),
+        );
+
+        await commandRunner.run(['ahoy']);
+
+        verify(() => commandRunner.completionInstallationLogger.warn(any()))
+            .called(1);
+      },
+    );
+
+    test('When an unknown exception happens during a install, it logs as error',
+        () async {
       final commandRunner = _TestCompletionCommandRunner()
         ..addCommand(_TestUserCommand())
         ..mockCompletionInstallation = MockCompletionInstallation();
 
       when(
         () => commandRunner.completionInstallation.install('test'),
-      ).thenThrow(
-        CompletionInstallationException(message: 'oops', rootCommand: 'test'),
-      );
+      ).thenThrow(Exception('oops'));
 
       await commandRunner.run(['ahoy']);
 
-      verify(
-        () {
-          commandRunner.completionInstallationLogger
-              .err('Could not install completion scripts for test: oops');
-        },
-      ).called(1);
+      verify(() => commandRunner.completionInstallationLogger.err(any()))
+          .called(1);
     });
 
     group('renderCompletionResult', () {