refactor: used enhanced enum for system shell name (#67)

Author: alestiago

lib/src/installer/completion_installation.dart

@@ -113,7 +113,7 @@ class CompletionInstallation {
 
     logger.detail(
       'Installing completion for the command $rootCommand '
-      'on ${configuration.name}',
+      'on ${configuration.shell.name}',
     );
 
     createCompletionConfigDir();
@@ -164,7 +164,7 @@ class CompletionInstallation {
   bool writeCompletionScriptForCommand(String rootCommand) {
     final configuration = this.configuration!;
     final completionConfigDirPath = completionConfigDir.path;
-    final commandScriptName = '$rootCommand.${configuration.name}';
+    final commandScriptName = '$rootCommand.${configuration.shell.name}';
     final commandScriptPath = path.join(
       completionConfigDirPath,
       commandScriptName,
@@ -207,7 +207,7 @@ class CompletionInstallation {
       logger.info('No file found at $configPath, creating one now');
       configFile.createSync();
     }
-    final commandScriptName = '$rootCommand.${configuration.name}';
+    final commandScriptName = '$rootCommand.${configuration.shell.name}';
 
     final containsLine =
         configFile.readAsStringSync().contains(commandScriptName);

lib/src/installer/shell_completion_configuration.dart

@@ -20,7 +20,7 @@ typedef SourceStringTemplate = String Function(String scriptPath);
 class ShellCompletionConfiguration {
   /// {@macro shell_completion_configuration}
   const ShellCompletionConfiguration._({
-    required this.name,
+    required this.shell,
     required this.shellRCFile,
     required this.sourceLineTemplate,
     required this.scriptTemplate,
@@ -38,8 +38,8 @@ class ShellCompletionConfiguration {
     }
   }
 
-  /// A descriptive string to identify the shell among others.
-  final String name;
+  /// {@macro system_shell}
+  final SystemShell shell;
 
   /// The location of a config file that is run upon shell start.
   /// Eg: .bash_profile or .zshrc
@@ -52,13 +52,14 @@ class ShellCompletionConfiguration {
   final CompletionScriptTemplate scriptTemplate;
 
   /// The name for the config file for this shell.
-  String get completionConfigForShellFileName => '$name-config.$name';
+  String get completionConfigForShellFileName =>
+      '${shell.name}-config.${shell.name}';
 }
 
 /// A [ShellCompletionConfiguration] for zsh.
 @visibleForTesting
 final zshConfiguration = ShellCompletionConfiguration._(
-  name: 'zsh',
+  shell: SystemShell.zsh,
   shellRCFile: '~/.zshrc',
   sourceLineTemplate: (String scriptPath) {
     return '[[ -f $scriptPath ]] && . $scriptPath || true';
@@ -91,7 +92,7 @@ fi
 /// A [ShellCompletionConfiguration] for bash.
 @visibleForTesting
 final bashConfiguration = ShellCompletionConfiguration._(
-  name: 'bash',
+  shell: SystemShell.bash,
   shellRCFile: '~/.bash_profile',
   sourceLineTemplate: (String scriptPath) {
     return '[ -f $scriptPath ] && . $scriptPath || true';

lib/src/system_shell.dart

@@ -2,13 +2,23 @@ import 'dart:io';
 
 import 'package:path/path.dart' as path;
 
-/// The supported shells.
+/// {@template system_shell}
+/// A type definition for a shell.
+///
+/// The enumerated shells are the supported shells.
+/// {@endtemplate}
 enum SystemShell {
   /// The Zsh shell: https://www.zsh.org/
-  zsh,
+  zsh('zsh'),
 
   /// GNU Bash shell: https://www.gnu.org/software/bash/
-  bash;
+  bash('bash');
+
+  /// {@macro system_shell}
+  const SystemShell(this.name);
+
+  /// A descriptive string to identify the shell among others.
+  final String name;
 
   /// Identifies the current shell based on the [Platform.environment].
   ///

test/src/command_runner/completion_command_runner_test.dart

@@ -93,9 +93,9 @@ void main() {
         expect(
           commandRunner.completionInstallation,
           isA<CompletionInstallation>().having(
-            (e) => e.configuration?.name,
+            (e) => e.configuration?.shell,
             'chosen shell',
-            equals('zsh'),
+            equals(SystemShell.zsh),
           ),
         );
       });

test/src/installer/completion_installation_test.dart

@@ -25,15 +25,15 @@ void main() {
           systemShell: SystemShell.bash,
           logger: logger,
         );
-        expect(installation.configuration?.name, 'bash');
+        expect(installation.configuration?.shell, SystemShell.bash);
       });
 
       test('zsh', () {
         final installation = CompletionInstallation.fromSystemShell(
           systemShell: SystemShell.zsh,
           logger: logger,
         );
-        expect(installation.configuration?.name, 'zsh');
+        expect(installation.configuration?.shell, SystemShell.zsh);
       });
 
       test('proxies overrides', () {

test/src/installer/shell_completion_configuration_test.dart

@@ -11,8 +11,8 @@ void main() {
             ShellCompletionConfiguration.fromSystemShell(SystemShell.zsh);
       });
 
-      test('name', () {
-        expect(zshConfiguration.name, 'zsh');
+      test('shell', () {
+        expect(zshConfiguration.shell, SystemShell.zsh);
       });
 
       test('shellRCFile', () {
@@ -62,8 +62,8 @@ fi
             ShellCompletionConfiguration.fromSystemShell(SystemShell.bash);
       });
 
-      test('name', () {
-        expect(bashConfiguration.name, 'bash');
+      test('shell', () {
+        expect(bashConfiguration.shell, SystemShell.bash);
       });
 
       test('shellRCFile', () {

test/src/system_shell_test.dart

@@ -3,6 +3,16 @@ import 'package:test/test.dart';
 
 void main() {
   group('SystemShell', () {
+    group('name', () {
+      test('bash is correct', () {
+        expect(SystemShell.bash.name, equals('bash'));
+      });
+
+      test('zsh is correct', () {
+        expect(SystemShell.zsh.name, equals('zsh'));
+      });
+    });
+
     group('current', () {
       test('instantiated without env', () {
         expect(