feat!: Preserves UsageException instead of replacing it with ExitException (#23)

* feat!: No longer replaces UsageException with ExitException

BREAKING CHANGES: Upon argument parse errors the UsageException was replaced by an ExitException.
This behavior is now changed to rethrow the orginal UsageException instead.

* test: Added specific exit code conds to existing select tests

* chore: Reformatted source with Dart 3.6

* ci: Pinned CI Dart version to 3.6

Author: christerswahn

.github/workflows/ci.yml

@@ -13,22 +13,28 @@ jobs:
         name: Dart format
         runs-on: ubuntu-latest
         steps:
-           - uses: actions/checkout@v4
-           - uses: dart-lang/setup-dart@v1.6.4
-           - name: Verify formatting
-             run: dart format --output=none --set-exit-if-changed .
+            - uses: actions/checkout@v4
+            - uses: dart-lang/setup-dart@v1.7.1
+              with:
+                sdk: 3.6
+            - name: Verify formatting
+              run: dart format --output=none --set-exit-if-changed .
     dart_analyze:
         name: Dart Analyze
         runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@v4
-            - uses: dart-lang/setup-dart@v1.6.4
+            - uses: dart-lang/setup-dart@v1.7.1
+              with:
+                sdk: 3.6
             - run: dart pub get
             - run: dart analyze --fatal-infos
     dart_test:
         name: Dart Test
         runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@v4
-            - uses: dart-lang/setup-dart@v1.6.4
+            - uses: dart-lang/setup-dart@v1.7.1
+              with:
+                sdk: 3.6
             - run: dart test

lib/src/analytics/analytics.dart

@@ -24,9 +24,9 @@ class MixPanelAnalytics implements Analytics {
     required String uniqueUserId,
     required String projectToken,
     required String version,
-  }) : _uniqueUserId = uniqueUserId,
-       _projectToken = projectToken,
-       _version = version;
+  })  : _uniqueUserId = uniqueUserId,
+        _projectToken = projectToken,
+        _version = version;
 
   @override
   void cleanUp() {}
@@ -62,16 +62,14 @@ class MixPanelAnalytics implements Analytics {
 
   Future<void> _quietPost(String payload) async {
     try {
-      await http
-          .post(
-            Uri.parse(_endpoint),
-            body: 'data=$payload',
-            headers: {
-              'Accept': 'text/plain',
-              'Content-Type': 'application/x-www-form-urlencoded',
-            },
-          )
-          .timeout(const Duration(seconds: 2));
+      await http.post(
+        Uri.parse(_endpoint),
+        body: 'data=$payload',
+        headers: {
+          'Accept': 'text/plain',
+          'Content-Type': 'application/x-www-form-urlencoded',
+        },
+      ).timeout(const Duration(seconds: 2));
     } catch (e) {
       return;
     }

lib/src/better_command_runner/better_command.dart

@@ -7,8 +7,8 @@ abstract class BetterCommand extends Command {
   final ArgParser _argParser;
 
   BetterCommand({PassMessage? logInfo, int? wrapTextColumn})
-    : _logInfo = logInfo,
-      _argParser = ArgParser(usageLineLength: wrapTextColumn);
+      : _logInfo = logInfo,
+        _argParser = ArgParser(usageLineLength: wrapTextColumn);
 
   @override
   ArgParser get argParser => _argParser;

lib/src/better_command_runner/better_command_runner.dart

@@ -2,7 +2,6 @@ import 'dart:async';
 
 import 'package:args/args.dart';
 import 'package:args/command_runner.dart';
-import 'package:cli_tools/src/better_command_runner/exit_exception.dart';
 
 /// A function type for executing code before running a command.
 typedef OnBeforeRunCommand = Future<void> Function(BetterCommandRunner runner);
@@ -14,11 +13,10 @@ typedef PassMessage = void Function(String message);
 /// The [logLevel] is the log level to set.
 /// The [commandName] is the name of the command if custom rules for log
 /// levels are needed.
-typedef SetLogLevel =
-    void Function({
-      required CommandRunnerLogLevel parsedLogLevel,
-      String? commandName,
-    });
+typedef SetLogLevel = void Function({
+  required CommandRunnerLogLevel parsedLogLevel,
+  String? commandName,
+});
 
 /// A function type for tracking events.
 typedef OnAnalyticsEvent = void Function(String event);
@@ -63,19 +61,18 @@ class BetterCommandRunner extends CommandRunner {
     OnBeforeRunCommand? onBeforeRunCommand,
     OnAnalyticsEvent? onAnalyticsEvent,
     int? wrapTextColumn,
-  }) : _logError = logError,
-       _logInfo = logInfo,
-       _onBeforeRunCommand = onBeforeRunCommand,
-       _setLogLevel = setLogLevel,
-       _onAnalyticsEvent = onAnalyticsEvent,
-       _argParser = ArgParser(usageLineLength: wrapTextColumn) {
+  })  : _logError = logError,
+        _logInfo = logInfo,
+        _onBeforeRunCommand = onBeforeRunCommand,
+        _setLogLevel = setLogLevel,
+        _onAnalyticsEvent = onAnalyticsEvent,
+        _argParser = ArgParser(usageLineLength: wrapTextColumn) {
     argParser.addFlag(
       BetterCommandRunnerFlags.quiet,
       abbr: BetterCommandRunnerFlags.quietAbbr,
       defaultsTo: false,
       negatable: false,
-      help:
-          'Suppress all cli output. Is overridden by '
+      help: 'Suppress all cli output. Is overridden by '
           ' -${BetterCommandRunnerFlags.verboseAbbr}, --${BetterCommandRunnerFlags.verbose}.',
     );
 
@@ -84,8 +81,7 @@ class BetterCommandRunner extends CommandRunner {
       abbr: BetterCommandRunnerFlags.verboseAbbr,
       defaultsTo: false,
       negatable: false,
-      help:
-          'Prints additional information useful for development. '
+      help: 'Prints additional information useful for development. '
           'Overrides --${BetterCommandRunnerFlags.quietAbbr}, --${BetterCommandRunnerFlags.quiet}.',
     );
 
@@ -120,7 +116,7 @@ class BetterCommandRunner extends CommandRunner {
     } on UsageException catch (e) {
       _onAnalyticsEvent?.call(BetterCommandRunnerAnalyticsEvents.invalid);
       _logError?.call(e.toString());
-      throw ExitException(exitCodeCommandNotFound);
+      rethrow;
     }
   }
 
@@ -176,7 +172,7 @@ class BetterCommandRunner extends CommandRunner {
     } on UsageException catch (e) {
       _logError?.call(e.toString());
       _onAnalyticsEvent?.call(BetterCommandRunnerAnalyticsEvents.invalid);
-      throw ExitException(exitCodeCommandNotFound);
+      rethrow;
     }
   }
 

lib/src/logger/helpers/progress.dart

@@ -64,8 +64,8 @@ class Progress {
     this._message,
     this._stdout, {
     ProgressOptions options = const ProgressOptions(),
-  }) : _stopwatch = Stopwatch(),
-       _options = options {
+  })  : _stopwatch = Stopwatch(),
+        _options = options {
     _stopwatch
       ..reset()
       ..start();

lib/src/logger/loggers/std_out_logger.dart

@@ -17,7 +17,7 @@ class StdOutLogger extends Logger {
   final Map<String, String>? _replacements;
 
   StdOutLogger(super.logLevel, {Map<String, String>? replacements})
-    : _replacements = replacements;
+      : _replacements = replacements;
 
   @override
   int? get wrapTextColumn => stdout.hasTerminal ? stdout.terminalColumns : null;
@@ -189,9 +189,9 @@ class StdOutLogger extends Logger {
     message = switch (_replacements) {
       null => message,
       Map<String, String> replacements => replacements.entries.fold(
-        message,
-        (String acc, entry) => acc.replaceAll(entry.key, entry.value),
-      ),
+          message,
+          (String acc, entry) => acc.replaceAll(entry.key, entry.value),
+        ),
     };
 
     _stopAnimationInProgress();

lib/src/package_version/package_version.dart

@@ -20,7 +20,7 @@ abstract class PackageVersion {
   /// attempting to fetch the latest version again.
   static Future<Version?> fetchLatestPackageVersion({
     required Future<void> Function(PackageVersionData versionArtefact)
-    storePackageVersionData,
+        storePackageVersionData,
     required Future<PackageVersionData?> Function() loadPackageVersionData,
     required Future<Version?> Function() fetchLatestPackageVersion,
   }) async {
@@ -47,7 +47,7 @@ abstract class PackageVersion {
   static Future<void> _storePubDevVersion(
     Version? version, {
     required Future<void> Function(PackageVersionData versionArtefact)
-    storePackageVersionData,
+        storePackageVersionData,
   }) async {
     PackageVersionData versionArtefact;
     if (version != null) {
@@ -81,7 +81,7 @@ class PackageVersionData {
       );
 
   Map<String, dynamic> toJson() => {
-    'version': version.toString(),
-    'valid_until': validUntil.millisecondsSinceEpoch,
-  };
+        'version': version.toString(),
+        'valid_until': validUntil.millisecondsSinceEpoch,
+      };
 }

lib/src/package_version/pub_api_client.dart

@@ -13,8 +13,8 @@ class PubApiClient {
   PubApiClient({
     http.Client? httpClient,
     requestTimeout = const Duration(seconds: 2),
-  }) : _pubClient = PubClient(client: httpClient),
-       _requestTimeout = requestTimeout;
+  })  : _pubClient = PubClient(client: httpClient),
+        _requestTimeout = requestTimeout;
 
   /// Tries to fetch the latest stable version, version does not include '-' or '+',
   /// for the package named [packageName].

lib/src/prompts/confirm.dart

@@ -10,10 +10,9 @@ Future<bool> confirm(
   bool? defaultValue,
   required Logger logger,
 }) async {
-  var prompt =
-      defaultValue == null
-          ? '[y/n]'
-          : defaultValue
+  var prompt = defaultValue == null
+      ? '[y/n]'
+      : defaultValue
           ? '[Y/n]'
           : '[y/N]';
 

lib/src/prompts/select.dart

@@ -22,7 +22,8 @@ Future<Option> select(
     prompt,
     options: options,
     logger: logger,
-  )).first;
+  ))
+      .first;
 }
 
 /// Prompts the user to select multiple options from a list of [options].
@@ -166,10 +167,9 @@ class _SelectState {
     return _SelectState(
       options: options,
       selectedIndex: selectedIndex,
-      selectedOptions:
-          selectedOptions.contains(selectedIndex)
-              ? (selectedOptions..remove(selectedIndex))
-              : (selectedOptions..add(selectedIndex)),
+      selectedOptions: selectedOptions.contains(selectedIndex)
+          ? (selectedOptions..remove(selectedIndex))
+          : (selectedOptions..add(selectedIndex)),
       multiple: multiple,
     );
   }
@@ -208,7 +208,7 @@ void _clearTerminal() {
 const _underlineSelectGraphicRenditionControlSequence = '\x1B[4m';
 const _resetSelectGraphicRenditionControlSequence = '\x1B[0m';
 String underline(String text) => [
-  _underlineSelectGraphicRenditionControlSequence,
-  text,
-  _resetSelectGraphicRenditionControlSequence,
-].join('');
+      _underlineSelectGraphicRenditionControlSequence,
+      text,
+      _resetSelectGraphicRenditionControlSequence,
+    ].join('');