Merge pull request #9 from netglade/dcm-teams

Update DCM to Teams 1.6.0

Author: tenhobi

.github/workflows/ci.yaml

@@ -22,5 +22,16 @@ jobs:
       - name: Analyze
         run: dart analyze .
 
+      - name: Install DCM
+        run: |
+          sudo apt-get update
+          wget -qO- https://dcm.dev/pgp-key.public | sudo gpg --dearmor -o /usr/share/keyrings/dcm.gpg
+          echo 'deb [signed-by=/usr/share/keyrings/dcm.gpg arch=amd64] https://dcm.dev/debian stable main' | sudo tee /etc/apt/sources.list.d/dart_stable.list
+          sudo apt-get update
+          sudo apt-get install dcm
+
+      - name: DCM Analyze
+        run: dcm analyze --reporter=github --ci-key ${{ secrets.DCM_KEY }} --email ${{ secrets.DCM_EMAIL }} .
+
       - name: Dry Publish
-        run: dart pub publish --dry-run
+        run: dart pub publish --dry-run

CHANGELOG.md

@@ -1,11 +1,14 @@
+## 2.0.0-rc.1
+- Update DCM rules to adhere DCM Teams 1.6.0.
+
 ## 1.2.3
-- Fix pub dev icon
+- Fix pub dev icon.
 
 ## 1.2.2
-- Fix pub dev picture
+- Fix pub dev picture.
 
 ## 1.2.1
-- Update logo
+- Update logo.
 
 ## 1.2.0
 - Remove `analyzer:exclude:` from `lints.yaml`. (add to README as a recommendation)

README.md

@@ -27,7 +27,7 @@ To use the lints, add as a dev dependency in your `pubspec.yaml`:
 
 ```yaml
 dev_dependencies:
-  netglade_analysis: ^1.2.0
+  netglade_analysis: ^2.0.0
 ```
 
 Then, add an include in `analysis_options.yaml`:
@@ -36,13 +36,10 @@ Then, add an include in `analysis_options.yaml`:
 include: package:netglade_analysis/lints.yaml
 ```
 
-To also use [Dart Code Metrics](https://dcm.dev), add configuration in `analysis_options.yaml` (and add `dart_code_metrics` to dev dependencies):
+To also use [Dart Code Metrics](https://dcm.dev), add configuration in `analysis_options.yaml`.
+Then you can use its CLI tool.
 
 ```yaml
-analyzer:
-  plugins:
-    - dart_code_metrics
-
 dart_code_metrics:
   extends:
     - package:netglade_analysis/dcm.yaml
@@ -85,4 +82,4 @@ To indicate your project is using `netglade_analysis` →
 
 [linter_rules]: https://dart.dev/tools/linter-rules
 [supported_lint_rules]: https://dart-lang.github.io/linter/lints
-[dcm_rules]: https://dcm.dev/docs/individuals/rules/
+[dcm_rules]: https://dcm.dev/docs/rules/

analysis_options.yaml

@@ -1 +1,7 @@
 include: lib/lints.yaml
+
+dart_code_metrics:
+  extends:
+    - package:netglade_analysis/dcm.yaml
+  pubspec-rules:
+    prefer-publish-to-none: false

lib/dcm.yaml

@@ -1,41 +1,98 @@
+# version 1.6.0
 dart_code_metrics:
+  pubspec-rules:
+    ### Pubspec
+    - avoid-any-version
+    # - avoid-dependency-overrides
+    - banned-dependencies
+    - prefer-caret-version-syntax
+    # - prefer-correct-package-name
+    - prefer-correct-screenshots
+    - prefer-publish-to-none
+    - prefer-semver-version
+
   rules:
-    ### Dart
+    ### Common
     # - arguments-ordering # way too pedantic
-    - avoid-banned-imports
+    # - avoid-banned-file-names
+    # - avoid-banned-imports
+    # - avoid-banned-types
+    - avoid-bottom-type-in-patterns
+    - avoid-bottom-type-in-records
     - avoid-cascade-after-if-null
+    - avoid-collapsible-if
     - avoid-collection-methods-with-unrelated-types
+    - avoid-declaring-call-method
     - avoid-double-slash-imports
     - avoid-duplicate-exports
+    - avoid-duplicate-named-imports
+    - avoid-duplicate-patterns
     - avoid-dynamic
+    - avoid-equal-expressions
+    - avoid-explicit-pattern-field-name
+    # - avoid-explicit-type-declaration # public API
+    - avoid-function-type-in-records
+    - avoid-future-tostring
     - avoid-global-state
     - avoid-ignoring-return-values
+    - avoid-inverted-boolean-checks
     # - avoid-late-keyword
+    # - avoid-long-functions # way too pedantic
+    # - avoid-long-parameter-list # doesn't play well with Flutter
+    - avoid-long-records
+    - avoid-missed-calls
     - avoid-missing-enum-constant-in-map
+    - avoid-mixing-named-and-positional-fields
     - avoid-nested-conditional-expressions:
         acceptable-level: 2
+    - avoid-nested-records
+    - avoid-nested-switch-expressions
+    - avoid-nested-switches
     - avoid-non-ascii-symbols
     - avoid-non-null-assertion:
         exclude:
           - test/**
+    - avoid-one-field-records
     - avoid-passing-async-when-sync-expected:
         exclude:
           - test/**
+    - avoid-positional-record-field-access
     - avoid-redundant-async
+    - avoid-redundant-else
+    - avoid-redundant-positional-field-name
+    - avoid-redundant-pragma-inline
+    - avoid-self-assignment
+    - avoid-self-compare
+    - avoid-shadowing:
+        ignore-parameters: true
+        ignored-names:
+          - context
+    # - avoid-similar-names # way too pedantic
+    - avoid-substring
     - avoid-throw-in-catch-block
+    - avoid-throw-objects-without-tostring
     - avoid-top-level-members-in-tests
-    - avoid-unnecessary-conditionals # already in Dart lints - avoid_bool_literals_in_conditional_expressions
+    - avoid-unassigned-late-fields-keyword
+    - avoid-unnecessary-conditionals
+    - avoid-unnecessary-negations
+    - avoid-unnecessary-nullable-return-type
+    - avoid-unnecessary-return
     - avoid-unnecessary-type-assertions
     - avoid-unnecessary-type-casts
     - avoid-unrelated-type-assertions
+    - avoid-unrelated-type-casts
+    - avoid-unsafe-collection-methods
+    - avoid-unused-generics
     - avoid-unused-parameters
-    # - ban-name
+    # - banned-usage
     - binary-expression-operand-order
     - double-literal-format
-    - format-comment
-    - list-all-equatable-fields
+    - format-comment:
+        only-doc-comments: true
+    # - format-test-name # good but painful
+    - function-always-returns-null
+    # - match-positional-field-names-on-assignment # not compatible with avoid-redundant-positional-field-name
     - member-ordering:
-        # alphabetize: true
         order:
           - public-fields
           - private-fields
@@ -59,28 +116,43 @@ dart_code_metrics:
           - public-methods
           - private-methods
           - build-method
-    - missing-test-assertion:
-        include-assertions:
-          - assertAllTrue
+    - missing-test-assertion
+    - move-records-to-typedefs:
+        min-fields: 3
+        min-occurrences: 3
     - newline-before-return
     - no-boolean-literal-compare
     - no-empty-block
     - no-equal-arguments:
         ignored-parameters:
           - height
           - width
+          - top
+          - right
+          - bottom
+          - left
+          - topLeft
+          - topRight
+          - bottomLeft
+          - bottomRight
+    - no-equal-conditions
+    - no-equal-switch-case
+    - no-equal-switch-expression-cases
     - no-equal-then-else
     #- no-magic-number: # way to strict for default values of parameters etc.
-    #    exclude:
-    #      - test/**
     - no-object-declaration
     - prefer-async-await
+    - prefer-bytes-builder
     - prefer-commenting-analyzer-ignores
     - prefer-conditional-expressions
-    # - prefer-correct-identifier-length
+    # - prefer-correct-identifier-length # way too pedantic
+    - prefer-correct-switch-length
     - prefer-correct-test-file-name
     - prefer-correct-type-name
+    - prefer-declaring-const-constructor
+    - prefer-early-return
     - prefer-enums-by-name
+    - prefer-explicit-parameter-names
     - prefer-first
     - prefer-immediate-return
     - prefer-iterable-of
@@ -90,37 +162,75 @@ dart_code_metrics:
           - test/**
     - prefer-moving-to-variable:
         allowed-duplicated-chains: 3
+    - prefer-return-await
+    - prefer-returning-conditional-expressions
+    - prefer-simpler-patterns-null-check
     - prefer-static-class:
         ignore-private: true
         ignore-names:
           - (.*)Provider
           - use(.*)
+    - prefer-test-matchers
     # - prefer-trailing-comma # already in Dart lints - require_trailing_commas
+    # - prefer-unwrapping-future-or # we are ok with awaiting values
+    - prefer-visible-for-testing-on-members
+    - prefer-wildcard-pattern
     - tag-name
+    - unnecessary-trailing-comma:
+        max-width: 80
 
     ### Flutter
+    - add-copy-with
     - always-remove-listener
     - avoid-border-all
+    - avoid-empty-setstate
+    - avoid-expanded-as-spacer
+    - avoid-incomplete-copy-with
+    - avoid-inherited-widget-in-initstate
+    - avoid-late-context
     - avoid-returning-widgets
     - avoid-shrink-wrap-in-lists
+    - avoid-state-constructors
+    - avoid-stateless-widget-initialized-fields
     - avoid-unnecessary-setstate
-    - use-setstate-synchronously
-    - avoid-expanded-as-spacer
+    - avoid-unnecessary-stateful-widgets
     - avoid-wrapping-in-padding
     - check-for-equals-in-render-object-setters
     - consistent-update-render-object
+    - dispose-fields
+    - prefer-action-button-tooltip
     - prefer-const-border-radius
     - prefer-correct-edge-insets-constructor
+    - prefer-define-hero-tag
     - prefer-extracting-callbacks
     - prefer-single-widget-per-file:
         ignore-private-widgets: true
     - prefer-using-list-view
+    # - prefer-widget-private-members # cannot use this.field in constructor
+    - proper-super-calls
+    - use-setstate-synchronously
+
+    ### Provider
+    - avoid-instantiating-in-value-provider
+    - avoid-read-inside-build
+    - avoid-watch-outside-build
+    - dispose-providers
+    - prefer-multi-provider
+
+    ### Bloc
+    - avoid-bloc-public-methods
+    # - avoid-cubits
+    # - avoid-passing-bloc-to-bloc
+    - check-is-not-closed-after-async-gap
+    - prefer-correct-bloc-provider
+    - prefer-multi-bloc-provider
+
+    ### Equatable
+    - extend-equatable
+    - list-all-equatable-fields
+
+    ### Flame - not used
 
-    ### Intl
-    # - prefer-intl-name
-    # - provide-correct-intl-args
+    ### Intl - not used
 
-    ### Angular
-    # - avoid-preserve-whitespace-false
-    # - component-annotation-arguments-ordering
-    # - prefer-on-push-cd-strategy
+    ### Angular - not used