add more useful rules (#7)

* add more useful rules
migrate to dcm 4.9

* Added test runner and clarification about issues with running DCM checks

* Update README.md to make run commands simpler

Co-authored-by: Yuri Prykhodko <[email protected]>

* Improved wording thanks to @solid-yuriiprykhodko!

Co-authored-by: Yuri Prykhodko <[email protected]>

Author: Illia Romanenko

README.md

@@ -29,11 +29,13 @@ Then you can see suggestions in your IDE or you can run checks manually:
 
 ```bash
 dart analyze;
-dart run dart_code_metrics:metrics analyze lib;
-dart run dart_code_metrics:metrics check-unused-files lib;
-dart run dart_code_metrics:metrics check-unused-l10n lib;
+dart run dart_code_metrics:metrics analyze lib test;
+dart run dart_code_metrics:metrics check-unused-files lib test;
+dart run dart_code_metrics:metrics check-unused-l10n lib test;
 
 ```
+Beware that some of the `dart_code_metrics` checks are not displayed in IDE so running checks 
+manually or in your actions (CI) is essential.
 
 Learn more: https://github.com/dart-code-checker/dart-code-metrics#cli
 # Badge

example/pubspec.yaml

@@ -6,7 +6,6 @@ environment:
   sdk: '>=2.14.4 <3.0.0'
 
 dev_dependencies:
-  dart_code_metrics: ^4.8.0
   solid_lints:
     path: ../
   test: ^1.20.1

lib/analysis_options.yaml

@@ -30,12 +30,31 @@ dart_code_metrics:
     # We use source-lines-of-code instead of this as we don't want to count comment or blank lines.
     # lines-of-code: 50
   rules:
+    - avoid-global-state
     - avoid-late-keyword
     - avoid-non-null-assertion
     - avoid-returning-widgets
     - avoid-unnecessary-setstate
+    - avoid-unnecessary-type-assertions
+    - avoid-unnecessary-type-casts
+    - avoid-unrelated-type-assertions
+    - avoid-unused-parameters
+    - double-literal-format
+    - member-ordering-extended:
+        order:
+          - fields
+          - getters-setters
+          - constructors
+          - methods
     - newline-before-return
+    - no-empty-block
+    - no-equal-then-else
     - no-magic-number
+    - prefer-conditional-expressions
+    - prefer-first
+    - prefer-last
+    # This improves navigation by matching file content and file name.
+    - prefer-match-file-name
   anti-patterns:
     - long-method
     - long-parameter-list

lib/analysis_options_test.yaml

@@ -48,6 +48,8 @@ dart_code_metrics:
 #      many places inside the test code, adding uninformative visual noise.
 #    - The use of this operator is also discouraged by the main ruleset.
     avoid-late-keyword: false
+# It's acceptable to include stubs or other helper classes into the test file.
+    prefer-match-file-name: false
   anti-patterns:
 # Same as for `source-lines-of-code`
     long-method: false

pubspec.yaml

@@ -7,4 +7,4 @@ environment:
   sdk: '>=2.14.4 <3.0.0'
 
 dependencies:
-  dart_code_metrics: ^4.8.0
+  dart_code_metrics: ^4.9.0