.analysis_options_repo 2.99 KB
Newer Older
1
# Specify analysis options.
2 3 4 5 6 7 8 9 10 11
#
# 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
#
# This file contains the analysis options used by 'flutter analyze' when analyzing
# the flutter repository. It is very similar to .analysis_options;
12 13 14 15 16 17 18 19 20 21
# the only difference (currently) is the public_member_api_docs option,
# which is turned on and programmatically reduced to a single output line
# indicating the # of violations for that rule.

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

linter:
  rules:
33 34 35
    # 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/
36

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

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

87
    # === pub rules ===
88
    - package_names