.analysis_options 3.01 KB
Newer Older
1
# Specify analysis options.
2 3 4 5 6 7 8 9
#
# Until there are meta linter rules, each desired lint must be explicitly enabled.
# See: https://github.com/dart-lang/linter/issues/288
#
# For a list of lints, see: http://dart-lang.github.io/linter/lints/
# See the configuration guide for more
# https://github.com/dart-lang/sdk/tree/master/pkg/analyzer#configuring-the-analyzer
#
10 11 12 13
# This file contains the analysis options used by Flutter editors, such as Atom.
# It is very similar to .analysis_options_flutter_analyze;
# the only difference (currently) is the public_member_api_docs option,
# which triggers too many messages to be used in editors.
14 15 16 17 18 19 20

analyzer:
  language:
    enableStrictCallChecks: true
    enableSuperMixins: true
  strong-mode: true
  errors:
21
    # allow overriding fields (if they use super, ideally...)
22
    strong_mode_invalid_field_override: ignore
23
    # allow type narrowing
24 25 26
    strong_mode_invalid_method_override: ignore
    strong_mode_static_type_error: ignore
    strong_mode_down_cast_composite: ignore
27
    # allow having TODOs in the code
28
    todo: ignore
29 30
  exclude:
    - 'bin/**'
31

32 33
linter:
  rules:
34 35 36
    # these rules are documented on and in the same order as
    # the Dart Lint rules page to make maintenance easier
    # http://dart-lang.github.io/linter/lints/
37

38
    # === error rules ===
39
    - avoid_empty_else
40
    # - comment_references # blocked on https://github.com/dart-lang/dartdoc/issues/1153
41
    - cancel_subscriptions
42
    # - close_sinks # https://github.com/flutter/flutter/issues/5789
43
    - control_flow_in_finally
44
    - empty_statements
45
    - hash_and_equals
46
    # - invariant_booleans # https://github.com/flutter/flutter/issues/5790
47
    # - iterable_contains_unrelated_type
48 49
    - list_remove_unrelated_type
    # - literal_only_boolean_expressions # https://github.com/flutter/flutter/issues/5791
50 51 52
    - test_types_in_equals
    - throw_in_finally
    - unrelated_type_equality_checks
53
    - valid_regexps
54

55
    # === style rules ===
56 57 58 59 60
    - always_declare_return_types
    - always_specify_types
    - annotate_overrides
    - avoid_as
    - avoid_init_to_null
61 62
    - avoid_return_types_on_setters
    - await_only_futures
63
    - camel_case_types
64
    # - constant_identifier_names # https://github.com/dart-lang/linter/issues/204
65
    - control_flow_in_finally
66
    - empty_constructor_bodies
67
    - implementation_imports
68 69 70
    - library_names
    - library_prefixes
    - non_constant_identifier_names
71
    - one_member_abstracts
72
    # - only_throw_errors # https://github.com/flutter/flutter/issues/5792
73
    # - overridden_fields
74 75 76
    - package_api_docs
    - package_prefixed_library_names
    - prefer_is_not_empty
77
    # - public_member_api_docs
78 79 80 81
    - slash_for_doc_comments
    - sort_constructors_first
    - sort_unnamed_constructors_first
    - super_goes_last
82
    # - type_annotate_public_apis # subset of always_specify_types
83
    - type_init_formals
84
    # - unawaited_futures # https://github.com/flutter/flutter/issues/5793
85 86
    - unnecessary_brace_in_string_interp
    - unnecessary_getters_setters
87

88
    # === pub rules ===
89
    - package_names