Skip to content

README.md

Latest commit

 

History

History
78 lines (54 loc) · 1.89 KB

README.md

File metadata and controls

78 lines (54 loc) · 1.89 KB
Raw

Solid Lints

style: solid $solid_lints

Flutter/Dart lints configuration based on software engineering industry standards (ISO/IEC, NIST) and best practices.

Documentation

For more detailed information and guidelines on using Solid Lints, please refer to the documentation:

Usage

Add dependency in your pubspec.yaml:

dev_dependencies:
  solid_lints: <INSERT LATEST VERSION>

Enable the plugin and include solid_lints in your project's top-level analysis_options.yaml:

include: package:solid_lints/analysis_options.yaml

plugins:
  solid_lints:

Also, you can use a specialized rule set designed for Dart tests. Add an analysis_options.yaml file under the test/ directory, and include the ruleset:

include: package:solid_lints/analysis_options_test.yaml

Then you can see suggestions in your IDE or you can run checks manually:

dart analyze;

Configuration

You can customize individual rule settings in your analysis_options.yaml.

Option 1: Inside the plugins block (Recommended)

plugins:
  solid_lints:
    diagnostics:
      cyclomatic_complexity:
        max_complexity: 10
      avoid_non_null_assertion: true

Option 2: Separate top-level solid_lints block

plugins:
  solid_lints:

solid_lints:
  diagnostics:
    cyclomatic_complexity:
      max_complexity: 10
    avoid_non_null_assertion: true

Badge

To indicate that your project is using Solid Lints, you can use the following badge:

[![style: solid](https://img.shields.io/badge/style-solid-orange)](https://pub.dev/packages/solid_lints)