fix: stabilized command usage tests (#626)

* fix: stabilized command usage tests

* docs: add missing documentation

Author: dkrutskikh

CHANGELOG.md

@@ -5,6 +5,7 @@
 * feat: add static code diagnostics `avoid-global-state`.
 * chore: migrate from deprecated api
 * fix: fixed issue with type check in prefer-match-file-name
+* fix: stabilized command usage tests
 * doc: add flutter favorite badge
 * chore: disable github_checks annotations from codecov
 * chore: activate language strict rules

test/src/cli/commands/analyze_command_test.dart

@@ -1,6 +1,7 @@
 @TestOn('vm')
 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';
 
 const _usage = 'Collect code metrics, rules and anti-patterns violations.\n'
@@ -67,10 +68,7 @@ void main() {
 
     test('should have correct usage', () {
       expect(
-        command.usage.replaceAll(
-          RegExp('defaults to "(.*?)dart-code-metrics"'),
-          'defaults to current directory',
-        ),
+        command.usage.replaceAll('"${p.current}"', 'current directory'),
         _usage,
       );
     });

test/src/cli/commands/check_unused_files_command_test.dart

@@ -1,6 +1,7 @@
 @TestOn('vm')
 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';
 
 const _usage = 'Check unused *.dart files.\n'
@@ -50,10 +51,7 @@ void main() {
 
     test('should have correct usage', () {
       expect(
-        command.usage.replaceAll(
-          RegExp('defaults to "(.*?)dart-code-metrics"'),
-          'defaults to current directory',
-        ),
+        command.usage.replaceAll('"${p.current}"', 'current directory'),
         _usage,
       );
     });

test/src/cli/commands/check_unused_l10n_command_test.dart

@@ -1,6 +1,7 @@
 @TestOn('vm')
 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';
 
 const _usage = 'Check unused localization in *.dart files.\n'
@@ -54,10 +55,7 @@ void main() {
 
     test('should have correct usage', () {
       expect(
-        command.usage.replaceAll(
-          RegExp('defaults to "(.*?)dart-code-metrics"'),
-          'defaults to current directory',
-        ),
+        command.usage.replaceAll('"${p.current}"', 'current directory'),
         _usage,
       );
     });

website/docs/rules/common/avoid-global-state.md

@@ -13,6 +13,7 @@ Warning
 The rule should violate on not final and non-const top-level variables.
 
 Having many mutable global variables inside application is a pretty bad practice:
+
 - application state becomes distributed between multiple files
 - application state is not protected: it can be modified in almost any place
 - it might be hard to debug such applications

website/docs/rules/overview.md

@@ -11,6 +11,10 @@ Rules configuration is [described here](../getting-started/configuration#configu
 
 ## Common {#common}
 
+- [avoid-global-state](./common/avoid-global-state.md)
+
+    Warns about usage mutable global variables.
+
 - [avoid-ignoring-return-values](./common/avoid-ignoring-return-values.md)
 
     Warns when a return value of a method or function invocation or a class instance property access is not used.