analysis_options.yaml 10.9 KB
Newer Older
1 2 3 4
# Specify analysis options.
#
# For a list of lints, see: http://dart-lang.github.io/linter/lints/
# See the configuration guide for more
5
# https://github.com/dart-lang/sdk/tree/main/pkg/analyzer#configuring-the-analyzer
6 7 8 9 10 11 12
#
# There are other similar analysis options files in the flutter repos,
# which should be kept in sync with this file:
#
#   - analysis_options.yaml (this file)
#   - https://github.com/flutter/plugins/blob/master/analysis_options.yaml
#   - https://github.com/flutter/engine/blob/master/analysis_options.yaml
13
#   - https://github.com/flutter/packages/blob/master/analysis_options.yaml
14
#
15 16
# This file contains the analysis options used for code in the flutter/flutter
# repository.
17 18

analyzer:
19
  language:
20
    strict-casts: true
21
    strict-raw-types: true
22
  errors:
23 24 25
    # allow self-reference to deprecated members (we do this because otherwise we have
    # to annotate every member in every test, assert, etc, when we deprecate something)
    deprecated_member_use_from_same_package: ignore
26 27
    # Turned off until null-safe rollout is complete.
    unnecessary_null_comparison: ignore
28
  exclude:
29
    - "bin/cache/**"
30
      # Ignore protoc generated files
31
    - "dev/conductor/lib/proto/*"
32 33 34

linter:
  rules:
35
    # This list is derived from the list of all available lints located at
36 37 38 39 40 41
    # https://github.com/dart-lang/linter/blob/master/example/all.yaml
    - always_declare_return_types
    - always_put_control_body_on_new_line
    # - always_put_required_named_parameters_first # we prefer having parameters in the same order as fields https://github.com/flutter/flutter/issues/10219
    - always_require_non_null_named_parameters
    - always_specify_types
42
    # - always_use_package_imports # we do this commonly
43 44
    - annotate_overrides
    # - avoid_annotating_with_dynamic # conflicts with always_specify_types
45
    - avoid_bool_literals_in_conditional_expressions
46 47
    # - avoid_catches_without_on_clauses # blocked on https://github.com/dart-lang/linter/issues/3023
    # - avoid_catching_errors # blocked on https://github.com/dart-lang/linter/issues/3023
48
    - avoid_classes_with_only_static_members
49
    - avoid_double_and_int_checks
50
    - avoid_dynamic_calls
51
    - avoid_empty_else
52
    - avoid_equals_and_hash_code_on_mutable_classes
53
    - avoid_escaping_inner_quotes
54
    - avoid_field_initializers_in_const_classes
55
    # - avoid_final_parameters # incompatible with prefer_final_parameters
56
    - avoid_function_literals_in_foreach_calls
57
    - avoid_implementing_value_types
58
    - avoid_init_to_null
59
    - avoid_js_rounded_ints
60
    # - avoid_multiple_declarations_per_line # seems to be a stylistic choice we don't subscribe to
61
    - avoid_null_checks_in_equality_operators
62 63
    # - avoid_positional_boolean_parameters # would have been nice to enable this but by now there's too many places that break it
    - avoid_print
64
    # - avoid_private_typedef_functions # we prefer having typedef (discussion in https://github.com/flutter/flutter/pull/16356)
65
    - avoid_redundant_argument_values
66 67 68
    - avoid_relative_lib_imports
    - avoid_renaming_method_parameters
    - avoid_return_types_on_setters
69
    - avoid_returning_null
70
    - avoid_returning_null_for_future
71
    - avoid_returning_null_for_void
72
    # - avoid_returning_this # there are enough valid reasons to return `this` that this lint ends up with too many false positives
73
    - avoid_setters_without_getters
Ian Hickson's avatar
Ian Hickson committed
74
    - avoid_shadowing_type_parameters
75
    - avoid_single_cascade_in_expression_statements
76
    - avoid_slow_async_io
77
    - avoid_type_to_string
78 79
    - avoid_types_as_parameter_names
    # - avoid_types_on_closure_parameters # conflicts with always_specify_types
80
    - avoid_unnecessary_containers
81 82
    - avoid_unused_constructor_parameters
    - avoid_void_async
83
    # - avoid_web_libraries_in_flutter # we use web libraries in web-specific code, and our tests prevent us from using them elsewhere
84
    - await_only_futures
85
    - camel_case_extensions
86 87
    - camel_case_types
    - cancel_subscriptions
88
    # - cascade_invocations # doesn't match the typical style of this repo
89
    - cast_nullable_to_non_nullable
90
    # - close_sinks # not reliable enough
91
    - combinators_ordering
92
    # - comment_references # blocked on https://github.com/dart-lang/linter/issues/1142
93
    - conditional_uri_does_not_exist
94 95
    # - constant_identifier_names # needs an opt-out https://github.com/dart-lang/linter/issues/204
    - control_flow_in_finally
96
    - curly_braces_in_flow_control_structures
97
    - depend_on_referenced_packages
98
    - deprecated_consistency
99
    # - diagnostic_describe_all_properties # enabled only at the framework level (packages/flutter/lib)
100
    - directives_ordering
101
    # - discarded_futures # not yet tested
102
    # - do_not_use_environment # there are appropriate times to use the environment, especially in our tests and build logic
103 104 105
    - empty_catches
    - empty_constructor_bodies
    - empty_statements
106
    - eol_at_end_of_file
107
    - exhaustive_cases
108
    - file_names
109 110 111 112
    - flutter_style_todos
    - hash_and_equals
    - implementation_imports
    - iterable_contains_unrelated_type
Ian Hickson's avatar
Ian Hickson committed
113
    # - join_return_with_assignment # not required by flutter style
114
    - leading_newlines_in_multiline_strings
115 116
    - library_names
    - library_prefixes
117
    - library_private_types_in_public_api
Ian Hickson's avatar
Ian Hickson committed
118
    # - lines_longer_than_80_chars # not required by flutter style
119
    - list_remove_unrelated_type
120
    # - literal_only_boolean_expressions # too many false positives: https://github.com/dart-lang/linter/issues/453
121
    - missing_whitespace_between_adjacent_strings
122
    - no_adjacent_strings_in_list
123
    - no_default_cases
124
    - no_duplicate_case_values
125
    - no_leading_underscores_for_library_prefixes
126
    - no_leading_underscores_for_local_identifiers
Ian Hickson's avatar
Ian Hickson committed
127 128
    - no_logic_in_create_state
    # - no_runtimeType_toString # ok in tests; we enable this only in packages/
129
    - non_constant_identifier_names
130
    - noop_primitive_operations
131
    - null_check_on_nullable_type_parameter
132
    - null_closures
133 134
    # - omit_local_variable_types # opposite of always_specify_types
    # - one_member_abstracts # too many false positives
135
    - only_throw_errors # this does get disabled in a few places where we have legacy code that uses strings et al
136 137
    - overridden_fields
    - package_api_docs
138
    - package_names
139 140 141 142
    - package_prefixed_library_names
    # - parameter_assignments # we do this commonly
    - prefer_adjacent_string_concatenation
    - prefer_asserts_in_initializer_lists
Ian Hickson's avatar
Ian Hickson committed
143
    # - prefer_asserts_with_message # not required by flutter style
144
    - prefer_collection_literals
145
    - prefer_conditional_assignment
Dan Field's avatar
Dan Field committed
146
    - prefer_const_constructors
147 148 149
    - prefer_const_constructors_in_immutables
    - prefer_const_declarations
    - prefer_const_literals_to_create_immutables
Ian Hickson's avatar
Ian Hickson committed
150
    # - prefer_constructors_over_static_methods # far too many false positives
151
    - prefer_contains
152
    # - prefer_double_quotes # opposite of prefer_single_quotes
153 154 155
    - prefer_equal_for_default_values
    # - prefer_expression_function_bodies # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#consider-using--for-short-functions-and-methods
    - prefer_final_fields
156
    - prefer_final_in_for_each
157
    - prefer_final_locals
158
    # - prefer_final_parameters # we should enable this one day when it can be auto-fixed (https://github.com/dart-lang/linter/issues/3104), see also parameter_assignments
159
    - prefer_for_elements_to_map_fromIterable
160
    - prefer_foreach
161
    - prefer_function_declarations_over_variables
162
    - prefer_generic_function_type_aliases
163
    - prefer_if_elements_to_conditional_expressions
164
    - prefer_if_null_operators
165
    - prefer_initializing_formals
166
    - prefer_inlined_adds
167
    # - prefer_int_literals # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#use-double-literals-for-double-constants
168
    - prefer_interpolation_to_compose_strings
169
    - prefer_is_empty
170
    - prefer_is_not_empty
171
    - prefer_is_not_operator
172
    - prefer_iterable_whereType
173
    # - prefer_mixin # Has false positives, see https://github.com/dart-lang/linter/issues/3018
174
    # - prefer_null_aware_method_calls # "call()" is confusing to people new to the language since it's not documented anywhere
175
    - prefer_null_aware_operators
176
    - prefer_relative_imports
177
    - prefer_single_quotes
178
    - prefer_spread_collections
179 180
    - prefer_typing_uninitialized_variables
    - prefer_void_to_null
181
    - provide_deprecation_message
182 183
    # - public_member_api_docs # enabled on a case-by-case basis; see e.g. packages/analysis_options.yaml
    - recursive_getters
184
    # - require_trailing_commas # blocked on https://github.com/dart-lang/sdk/issues/47441
185
    - secure_pubspec_urls
186
    - sized_box_for_whitespace
187
    # - sized_box_shrink_expand # not yet tested
188
    - slash_for_doc_comments
189
    - sort_child_properties_last
190
    - sort_constructors_first
191
    # - sort_pub_dependencies # prevents separating pinned transitive dependencies
192 193 194
    - sort_unnamed_constructors_first
    - test_types_in_equals
    - throw_in_finally
195
    - tighten_type_of_initializing_formals
196 197
    # - type_annotate_public_apis # subset of always_specify_types
    - type_init_formals
198
    # - unawaited_futures # too many false positives, especially with the way AnimationController works
199
    - unnecessary_await_in_return
200 201
    - unnecessary_brace_in_string_interps
    - unnecessary_const
202
    - unnecessary_constructor_name
203
    # - unnecessary_final # conflicts with prefer_final_locals
204 205
    - unnecessary_getters_setters
    # - unnecessary_lambdas # has false positives: https://github.com/dart-lang/linter/issues/498
206
    - unnecessary_late
207 208
    - unnecessary_new
    - unnecessary_null_aware_assignments
209
    - unnecessary_null_aware_operator_on_extension_on_nullable
210
    - unnecessary_null_checks
211
    - unnecessary_null_in_if_null_operators
212
    - unnecessary_nullable_for_final_variable_declarations
213 214
    - unnecessary_overrides
    - unnecessary_parenthesis
215
    # - unnecessary_raw_strings # what's "necessary" is a matter of opinion; consistency across strings can help readability more than this lint
216
    - unnecessary_statements
217
    - unnecessary_string_escapes
218
    - unnecessary_string_interpolations
219
    - unnecessary_this
220
    - unnecessary_to_list_in_spreads
221
    - unrelated_type_equality_checks
222
    - unsafe_html
223
    - use_build_context_synchronously
224
    # - use_colored_box # not yet tested
225
    # - use_decorated_box # not yet tested
226
    # - use_enums # not yet tested
227
    - use_full_hex_values_for_flutter_colors
228
    - use_function_type_syntax_for_parameters
229
    - use_if_null_to_convert_nulls_to_bools
230
    - use_is_even_rather_than_modulo
231
    - use_key_in_widget_constructors
232
    - use_late_for_private_fields_and_variables
233
    - use_named_constants
234
    - use_raw_strings
235
    - use_rethrow_when_possible
236
    - use_setters_to_change_properties
237
    # - use_string_buffers # has false positives: https://github.com/dart-lang/sdk/issues/34182
238
    - use_super_parameters
239
    - use_test_throws_matchers
240 241
    # - use_to_and_as_if_applicable # has false positives, so we prefer to catch this by code-review
    - valid_regexps
242
    - void_checks