glyder_lints's Introduction

Glyder Lints

This package defines all custom lint rules for flutter applications and is built on top of the custom_lint package.

Install

Add the following in the dev_dependencies section in your pubspec.yaml after flutter_lints if present:

# Linting.
custom_lint: 0.5.7
glyder_lints:
  git:
    url: https://github.com/Mathorga/glyder_lints.git
    ref: main

Add the following at the bottom of the analysis_options.yaml if present (create it otherwise):

analyzer:
  plugins:
    - custom_lint

Example analysis_options.yaml file

include: package:flutter_lints/flutter.yaml

# Flutter linter.
linter:
  rules:

# Added custom_lint as additional package.
analyzer:
  plugins:
    - custom_lint

# Plugin customization.
custom_lint:
  # Uncomment this to enable specific lint rules at will.
  # By default all lint rules are enabled.
  # enable_all_lint_rules: false
  rules:
    # Disable a single lint rule.
    - specify_type: false
    # Uncomment this to enable a specific rule. Only usefule if enable_all_lint_rules is false.
    # - other_rule: true

Lint Rules

specify_type -> Explicitly specify type in variable declarations.
write_docs_pls -> Provide documentation comments for public classes and methods.
static_fields_go_first -> Static fields should go first in class definition.
use_double_quotes -> Enforces the use of double quotes for string literals when not used in import statements.
amend_multiple_declarations -> Discourages the user from defining multiple variables at once.
ament_eol_comments -> Amends the use of end-of-line comments.

Recommend Projects