feat: add version flag to print package version (#660)

* feat: add version flag to pring package version

* chore: tune some test

* chore: add some tests

Co-authored-by: Dmitry Krutskikh <[email protected]>

Author: incendial

CHANGELOG.md

@@ -3,8 +3,9 @@
 ## Unreleased
 
 * feat: add new command flag `--no-congratulate`.
-* chore: restrict `analyzer` version to `>=2.4.0 <3.3.0`.
+* feat: add `--version` flag to print current version of the package.
 * fix: make `check-unused-l10n` also cover supertype member calls.
+* chore: restrict `analyzer` version to `>=2.4.0 <3.3.0`.
 
 ## 4.10.0-dev.2
 

lib/src/cli/cli_runner.dart

@@ -2,10 +2,12 @@ import 'dart:io';
 
 import 'package:args/command_runner.dart';
 
+import '../version.dart';
 import 'commands/analyze_command.dart';
 import 'commands/check_unused_code_command.dart';
 import 'commands/check_unused_files_command.dart';
 import 'commands/check_unused_l10n_command.dart';
+import 'models/flag_names.dart';
 
 /// Represents a cli runner responsible
 /// for running a command based on raw cli call data.
@@ -17,12 +19,15 @@ class CliRunner extends CommandRunner<void> {
     CheckUnusedCodeCommand(),
   ];
 
-  CliRunner()
-      : super(
-          'metrics',
-          'Analyze and improve your code quality.',
-        ) {
+  late final IOSink _output;
+
+  CliRunner([IOSink? output])
+      : super('metrics', 'Analyze and improve your code quality.') {
+    _output = output ?? stdout;
+
     _commands.forEach(addCommand);
+
+    _usesVersionOption();
   }
 
   /// Represents the invocation string message
@@ -32,14 +37,26 @@ class CliRunner extends CommandRunner<void> {
   /// Main entry point for running a command
   @override
   Future<void> run(Iterable<String> args) async {
+    final results = parse(args);
+    final showVersion = results[FlagNames.version] as bool;
+
+    if (showVersion) {
+      _output.writeln('Dart Code Metrics version: $packageVersion');
+
+      return;
+    }
+
     try {
       await super.run(_addDefaultCommand(args));
     } on UsageException catch (e) {
-      print('${e.message}\n');
-      print('${e.usage}\n');
+      _output
+        ..writeln(e.message)
+        ..writeln(e.usage);
+
       exit(64);
     } on Exception catch (e) {
-      print('Oops; metrics has exited unexpectedly: "$e"');
+      _output.writeln('Oops; metrics has exited unexpectedly: "$e"');
+
       exit(1);
     }
   }
@@ -49,4 +66,14 @@ class CliRunner extends CommandRunner<void> {
       : !commands.keys.contains(args.first)
           ? ['analyze', ...args]
           : args;
+
+  void _usesVersionOption() {
+    argParser
+      ..addSeparator('')
+      ..addFlag(
+        FlagNames.version,
+        help: 'Reports the version of this tool.',
+        negatable: false,
+      );
+  }
 }

lib/src/cli/models/flag_names.dart

@@ -11,6 +11,7 @@ class FlagNames {
   static const reporter = 'reporter';
   static const rootFolder = 'root-folder';
   static const sdkPath = 'sdk-path';
+  static const version = 'version';
 
   static const consoleReporter = ConsoleReporter.id;
   static const consoleVerboseReporter = ConsoleReporter.verboseId;

lib/src/version.dart

@@ -0,0 +1 @@
+const packageVersion = '4.10.0-dev.2';

test/src/cli/cli_runner_test.dart

@@ -0,0 +1,43 @@
+import 'dart:io';
+
+import 'package:dart_code_metrics/src/cli/cli_runner.dart';
+import 'package:mocktail/mocktail.dart';
+import 'package:test/test.dart';
+
+class IOSinkMock extends Mock implements IOSink {}
+
+void main() {
+  group('Cli runner', () {
+    test('should have correct description', () {
+      expect(
+        CliRunner().description,
+        equals('Analyze and improve your code quality.'),
+      );
+    });
+
+    test('should have correct invocation', () {
+      expect(
+        CliRunner().invocation,
+        equals('metrics <command> [arguments] <directories>'),
+      );
+    });
+
+    group('run', () {
+      late IOSinkMock output; // ignore: close_sinks
+
+      setUp(() {
+        output = IOSinkMock();
+      });
+
+      test('with version argument', () {
+        CliRunner(output).run(['--version']);
+
+        final captured =
+            verify(() => output.writeln(captureAny())).captured.cast<String>();
+
+        expect(captured, isNotEmpty);
+        expect(captured.first, startsWith('Dart Code Metrics version: '));
+      });
+    });
+  });
+}

test/src/cli/commands/analyze_command_test.dart

@@ -1,5 +1,4 @@
 import 'package:dart_code_metrics/src/cli/cli_runner.dart';
-import 'package:dart_code_metrics/src/cli/commands/analyze_command.dart';
 import 'package:path/path.dart' as p;
 import 'package:test/test.dart';
 
@@ -48,30 +47,30 @@ const _usage = 'Collect code metrics, rules and anti-patterns violations.\n'
 void main() {
   group('AnalyzeCommand', () {
     final runner = CliRunner();
-    final command = runner.commands['analyze'] as AnalyzeCommand;
+    final command = runner.commands['analyze'];
 
     test('should have correct name', () {
-      expect(command.name, 'analyze');
+      expect(command?.name, equals('analyze'));
     });
 
     test('should have correct description', () {
       expect(
-        command.description,
-        'Collect code metrics, rules and anti-patterns violations.',
+        command?.description,
+        equals('Collect code metrics, rules and anti-patterns violations.'),
       );
     });
 
     test('should have correct invocation', () {
       expect(
-        command.invocation,
-        'metrics analyze [arguments] <directories>',
+        command?.invocation,
+        equals('metrics analyze [arguments] <directories>'),
       );
     });
 
     test('should have correct usage', () {
       expect(
-        command.usage.replaceAll('"${p.current}"', 'current directory'),
-        _usage,
+        command?.usage.replaceAll('"${p.current}"', 'current directory'),
+        equals(_usage),
       );
     });
   });

test/src/cli/commands/base_command_test.dart

@@ -70,7 +70,7 @@ void main() {
       () {
         when(() => result['sdk-path'] as String).thenReturn('SDK_PATH');
 
-        expect(command.findSdkPath(), 'SDK_PATH');
+        expect(command.findSdkPath(), equals('SDK_PATH'));
       },
     );
 

test/src/cli/commands/check_unused_code_command_test.dart

@@ -1,5 +1,4 @@
 import 'package:dart_code_metrics/src/cli/cli_runner.dart';
-import 'package:dart_code_metrics/src/cli/commands/check_unused_code_command.dart';
 import 'package:path/path.dart' as p;
 import 'package:test/test.dart';
 
@@ -30,31 +29,30 @@ const _usage = 'Check unused code in *.dart files.\n'
 void main() {
   group('CheckUnusedCodeCommand', () {
     final runner = CliRunner();
-    final command =
-        runner.commands['check-unused-code'] as CheckUnusedCodeCommand;
+    final command = runner.commands['check-unused-code'];
 
     test('should have correct name', () {
-      expect(command.name, 'check-unused-code');
+      expect(command?.name, equals('check-unused-code'));
     });
 
     test('should have correct description', () {
       expect(
-        command.description,
-        'Check unused code in *.dart files.',
+        command?.description,
+        equals('Check unused code in *.dart files.'),
       );
     });
 
     test('should have correct invocation', () {
       expect(
-        command.invocation,
-        'metrics check-unused-code [arguments] <directories>',
+        command?.invocation,
+        equals('metrics check-unused-code [arguments] <directories>'),
       );
     });
 
     test('should have correct usage', () {
       expect(
-        command.usage.replaceAll('"${p.current}"', 'current directory'),
-        _usage,
+        command?.usage.replaceAll('"${p.current}"', 'current directory'),
+        equals(_usage),
       );
     });
   });

test/src/cli/commands/check_unused_files_command_test.dart

@@ -1,5 +1,4 @@
 import 'package:dart_code_metrics/src/cli/cli_runner.dart';
-import 'package:dart_code_metrics/src/cli/commands/check_unused_files_command.dart';
 import 'package:path/path.dart' as p;
 import 'package:test/test.dart';
 
@@ -33,31 +32,27 @@ const _usage = 'Check unused *.dart files.\n'
 void main() {
   group('CheckUnusedFilesCommand', () {
     final runner = CliRunner();
-    final command =
-        runner.commands['check-unused-files'] as CheckUnusedFilesCommand;
+    final command = runner.commands['check-unused-files'];
 
     test('should have correct name', () {
-      expect(command.name, 'check-unused-files');
+      expect(command?.name, equals('check-unused-files'));
     });
 
     test('should have correct description', () {
-      expect(
-        command.description,
-        'Check unused *.dart files.',
-      );
+      expect(command?.description, equals('Check unused *.dart files.'));
     });
 
     test('should have correct invocation', () {
       expect(
-        command.invocation,
-        'metrics check-unused-files [arguments] <directories>',
+        command?.invocation,
+        equals('metrics check-unused-files [arguments] <directories>'),
       );
     });
 
     test('should have correct usage', () {
       expect(
-        command.usage.replaceAll('"${p.current}"', 'current directory'),
-        _usage,
+        command?.usage.replaceAll('"${p.current}"', 'current directory'),
+        equals(_usage),
       );
     });
   });

test/src/cli/commands/check_unused_l10n_command_test.dart

@@ -1,5 +1,4 @@
 import 'package:dart_code_metrics/src/cli/cli_runner.dart';
-import 'package:dart_code_metrics/src/cli/commands/check_unused_l10n_command.dart';
 import 'package:path/path.dart' as p;
 import 'package:test/test.dart';
 
@@ -34,31 +33,30 @@ const _usage = 'Check unused localization in *.dart files.\n'
 void main() {
   group('CheckUnusedL10nCommand', () {
     final runner = CliRunner();
-    final command =
-        runner.commands['check-unused-l10n'] as CheckUnusedL10nCommand;
+    final command = runner.commands['check-unused-l10n'];
 
     test('should have correct name', () {
-      expect(command.name, 'check-unused-l10n');
+      expect(command?.name, equals('check-unused-l10n'));
     });
 
     test('should have correct description', () {
       expect(
-        command.description,
-        'Check unused localization in *.dart files.',
+        command?.description,
+        equals('Check unused localization in *.dart files.'),
       );
     });
 
     test('should have correct invocation', () {
       expect(
-        command.invocation,
-        'metrics check-unused-l10n [arguments] <directories>',
+        command?.invocation,
+        equals('metrics check-unused-l10n [arguments] <directories>'),
       );
     });
 
     test('should have correct usage', () {
       expect(
-        command.usage.replaceAll('"${p.current}"', 'current directory'),
-        _usage,
+        command?.usage.replaceAll('"${p.current}"', 'current directory'),
+        equals(_usage),
       );
     });
   });