Merge pull request #11 from netglade/adhere-to-dcm-1.7.0

Adhere to DCM 1.7.0

Author: tenhobi

.github/workflows/ci.yaml

@@ -23,15 +23,20 @@ jobs:
         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 }} --fatal-style --fatal-performance --fatal-warnings .
+        uses: CQLabs/setup-dcm@v1.0.0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Run DCM
+        uses: CQLabs/dcm-action@v1.0.0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          ci_key: ${{ secrets.DCM_KEY }}
+          email: ${{ secrets.DCM_EMAIL }}
+          folders: .
+          fatal_style: true
+          fatal_performance: true
+          fatal_warnings: true
 
       - name: Dry Publish
         run: dart pub publish --dry-run

CHANGELOG.md

@@ -1,3 +1,29 @@
+## 3.0.0
+- Adhere to DCM 1.7.0:
+  - Add avoid-accessing-other-classes-private-members
+  - Add avoid-generics-shadowing
+  - Add avoid-keywords-in-wildcard-pattern
+  - Add avoid-misused-wildcard-pattern
+  - Add avoid-nested-futures
+  - Add avoid-nested-streams-and-futures
+  - Add avoid-shadowed-extension-methods
+  - Add avoid-uncaught-future-errors
+  - Add avoid-unnecessary-call
+  - Add avoid-unnecessary-futures
+  - Add map-keys-ordering
+  - Add no-equal-nested-conditions
+  - Add prefer-correct-future-return-type
+  - Add prefer-correct-stream-return-type
+  - Add prefer-parentheses-with-if-null
+  - Add prefer-trailing-comma
+  - Add avoid-missing-image-alt
+  - Add avoid-unnecessary-overrides-in-state
+  - Add prefer-dedicated-media-query-methods
+  - Update allow-false for no-boolean-literal-compare
+  - Disable in tests avoid-non-ascii-symbols
+  - Disable in tests prefer-moving-to-variable
+  - Remove avoid-long-parameter-list
+
 ## 2.0.1
 - Fix README logo
 

lib/dcm.yaml

@@ -1,4 +1,4 @@
-# version 1.6.0 - https://dcm.dev/changelog/
+# version 1.7.0 - https://dcm.dev/changelog/
 dart_code_metrics:
   pubspec-rules:
     ### Pubspec
@@ -14,9 +14,11 @@ dart_code_metrics:
   rules:
     ### Common
     # - arguments-ordering # way too pedantic
+    - avoid-accessing-other-classes-private-members
     # - avoid-banned-file-names
     # - avoid-banned-imports
     # - avoid-banned-types
+    # - avoid-barrel-files # for now we use them
     - avoid-bottom-type-in-patterns
     - avoid-bottom-type-in-records
     - avoid-cascade-after-if-null
@@ -33,23 +35,33 @@ dart_code_metrics:
     # - avoid-explicit-type-declaration # public API
     - avoid-function-type-in-records
     - avoid-future-tostring
+    - avoid-generics-shadowing
     - avoid-global-state
     - avoid-ignoring-return-values
+    # - avoid-importing-entrypoint-exports: false # TODO: has false positives in monorepo
     - avoid-inverted-boolean-checks
+    - avoid-keywords-in-wildcard-pattern
     # - avoid-late-keyword
     # - avoid-long-functions # way too pedantic
-    - avoid-long-parameter-list:
-        ignore-optional: true # exclude optional and (required) named parameters
+    # - avoid-long-parameter-list: # way too pedantic
+        # ignore-optional: true # exclude optional and (non-required) named parameters
     - avoid-long-records
     - avoid-missed-calls
     - avoid-missing-enum-constant-in-map
+    - avoid-misused-wildcard-pattern
     - avoid-mixing-named-and-positional-fields
+    # - avoid-mutating-parameters # we use ValueNotifier etc.
+    # - avoid-negated-conditions # sometimes it might be better
     - avoid-nested-conditional-expressions:
         acceptable-level: 2
+    - avoid-nested-futures
     - avoid-nested-records
+    - avoid-nested-streams-and-futures
     - avoid-nested-switch-expressions
     - avoid-nested-switches
-    - avoid-non-ascii-symbols
+    - avoid-non-ascii-symbols:
+        exclude:
+          - test/**
     - avoid-non-null-assertion:
         exclude:
           - test/**
@@ -64,6 +76,7 @@ dart_code_metrics:
     - avoid-redundant-pragma-inline
     - avoid-self-assignment
     - avoid-self-compare
+    - avoid-shadowed-extension-methods
     - avoid-shadowing:
         ignore-parameters: true
         ignored-names:
@@ -74,7 +87,10 @@ dart_code_metrics:
     - avoid-throw-objects-without-tostring
     - avoid-top-level-members-in-tests
     - avoid-unassigned-late-fields-keyword
+    - avoid-uncaught-future-errors
+    - avoid-unnecessary-call
     - avoid-unnecessary-conditionals
+    - avoid-unnecessary-futures
     - avoid-unnecessary-negations
     - avoid-unnecessary-nullable-return-type
     - avoid-unnecessary-return
@@ -92,6 +108,9 @@ dart_code_metrics:
         only-doc-comments: true
     # - format-test-name # good but painful
     - function-always-returns-null
+    - map-keys-ordering:
+        exclude:
+          - test/**
     # - match-positional-field-names-on-assignment # not compatible with avoid-redundant-positional-field-name
     - member-ordering:
         order:
@@ -122,7 +141,8 @@ dart_code_metrics:
         min-fields: 3
         min-occurrences: 3
     - newline-before-return
-    - no-boolean-literal-compare
+    - no-boolean-literal-compare:
+        allow-false: true # allows `variable == false` instead of just `!variable`
     - no-empty-block
     - no-equal-arguments:
         ignored-parameters:
@@ -137,6 +157,7 @@ dart_code_metrics:
           - bottomLeft
           - bottomRight
     - no-equal-conditions
+    - no-equal-nested-conditions
     - no-equal-switch-case
     - no-equal-switch-expression-cases
     - no-equal-then-else
@@ -146,7 +167,10 @@ dart_code_metrics:
     - prefer-bytes-builder
     - prefer-commenting-analyzer-ignores
     - prefer-conditional-expressions
+    # - prefer-correct-error-name # we use `e`
+    - prefer-correct-future-return-type
     # - prefer-correct-identifier-length # way too pedantic
+    - prefer-correct-stream-return-type
     - prefer-correct-switch-length
     - prefer-correct-test-file-name
     - prefer-correct-type-name
@@ -163,6 +187,9 @@ dart_code_metrics:
           - test/**
     - prefer-moving-to-variable:
         allowed-duplicated-chains: 3
+        exclude:
+          - test/**
+    - prefer-parentheses-with-if-null
     - prefer-return-await
     # - prefer-returning-conditional-expressions # annoying sometimes
     - prefer-simpler-patterns-null-check
@@ -172,7 +199,8 @@ dart_code_metrics:
           - (.*)Provider
           - use(.*)
     - prefer-test-matchers
-    # - prefer-trailing-comma # already in Dart lints - require_trailing_commas
+    - prefer-trailing-comma
+    # - prefer-type-over-var # we prefer inference
     # - prefer-unwrapping-future-or # we are ok with awaiting values
     - prefer-visible-for-testing-on-members
     - prefer-wildcard-pattern
@@ -189,10 +217,12 @@ dart_code_metrics:
     - avoid-incomplete-copy-with
     - avoid-inherited-widget-in-initstate
     - avoid-late-context
+    - avoid-missing-image-alt
     - avoid-returning-widgets
     - avoid-shrink-wrap-in-lists
     - avoid-state-constructors
     - avoid-stateless-widget-initialized-fields
+    - avoid-unnecessary-overrides-in-state
     - avoid-unnecessary-setstate
     - avoid-unnecessary-stateful-widgets
     - avoid-wrapping-in-padding
@@ -202,6 +232,7 @@ dart_code_metrics:
     - prefer-action-button-tooltip
     - prefer-const-border-radius
     - prefer-correct-edge-insets-constructor
+    - prefer-dedicated-media-query-methods
     - prefer-define-hero-tag
     - prefer-extracting-callbacks
     - prefer-single-widget-per-file:

lib/netglade_analysis.dart

@@ -1,3 +1,3 @@
 /// NetGlade Dart and Flutter analyzer settings and best practices
-/// used internally at [netglade](https://netglade.cz/en).
+/// used internally at [netglade](https://netglade.com).
 library netglade_analysis;

pubspec.yaml

@@ -1,5 +1,5 @@
 name: netglade_analysis
-version: 2.0.1
+version: 3.0.0
 description: Lint rules for Dart and Flutter used internally at netglade.
 repository: https://github.com/netglade/netglade_analysis
 issue_tracker: https://github.com/netglade/netglade_analysis/issues