Annoying analysis options

Strict analysis options for your flutter project combining rules from very_good_analysis and dart_code_metrics.

How to use 🚀

mason make annoying_analysis_options

Outputs 📦

project_name
├── analysis_options.yaml
├── // probably a pubspec.yaml
└── ...

include: package:very_good_analysis/analysis_options.yaml

linter:
  rules:
    public_member_api_docs: false

analyzer:
  plugins:
   - dart_code_metrics
  exclude:
    - "**/*.g.dart"
    - "**/*.freezed.dart"
    - "**/models/**"
    - "lib/injection/ioc.config.dart"
  errors:
    invalid_annotation_target: ignore
    unnecessary_import: ignore
    always_use_package_imports: ignore

dart_code_metrics:
  metrics:
    cyclomatic-complexity: 20
    maximum-nesting-level: 5
    lines-of-code: 100
    number-of-methods: 10
    technical-debt:
      threshold: 1
      todo-cost: 100
      ignore-cost: 50
      ignore-for-file-cost: 200
      as-dynamic-cost: 300
      deprecated-annotations-cost: 40
      file-nullsafety-migration-cost: 40
      unit-type: "USD"
  rules:
    - avoid-global-state
    - avoid-missing-enum-constant-in-map
    - avoid-nested-conditional-expressions:
        acceptable-level: 2
    - avoid-throw-in-catch-block
    - avoid-unnecessary-type-assertions
    - avoid-unnecessary-type-casts
    - avoid-unrelated-type-assertions
    - binary-expression-operand-order
    - double-literal-format
    - member-ordering-extended:
        exclude:
          - '**/models/**'
        order:
          - constructors
          - private-late-final-fields
          - private-fields
          - public-late-final-fields
          - public-fields
    - prefer-correct-type-name:
        min-length: 3
        max-length: 40
    - prefer-first
    - prefer-last
    - prefer-match-file-name:
        exclude:
          - test/**
          - lib/gen/**
          - lib/l10n/l10n.dart
          - lib/injection/module.dart
    - always-remove-listener
    - avoid-returning-widgets:
        ignored-names:
          - testFunction
        ignored-annotations:
          - allowedAnnotation
    - prefer-single-widget-per-file:
        ignore-private-widgets: true
    - avoid-unnecessary-setstate
    - avoid-wrapping-in-padding
    - prefer-extracting-callbacks:
        ignored-named-arguments:
          - onPressed
    - newline-before-return
    - no-boolean-literal-compare
    - no-empty-block:
        exclude:
          - test/**
    - prefer-trailing-comma
    - prefer-conditional-expressions
    - no-equal-then-else
  anti-patterns:
    - long-method:
        exclude:
          - test/**
    - long-parameter-list

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add annoying_analysis_options

# Install globally
mason add -g annoying_analysis_options

Usage 🚀

mason make annoying_analysis_options

Variables ✨

Hooks 🪝

• ❌   Pre-Gen
• ❌   Post-Gen

Environment 🌎

mason: "any"

0.1.0

• initial release 🎉

The MIT License (MIT) Copyright (c) 2020 Prince Nna

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.