|
1 | | -# Specify analysis options. |
2 | | -# |
3 | | -# For a list of lints, see: http://dart-lang.github.io/linter/lints/ |
4 | | -# See the configuration guide for more |
5 | | -# https://github.com/dart-lang/sdk/tree/main/pkg/analyzer#configuring-the-analyzer |
6 | | -# |
7 | | -# There are other similar analysis options files in the flutter repos, |
8 | | -# which should be kept in sync with this file: |
9 | | -# |
10 | | -# - analysis_options.yaml (this file) |
11 | | -# - https://github.com/flutter/plugins/blob/master/analysis_options.yaml |
12 | | -# - https://github.com/flutter/engine/blob/master/analysis_options.yaml |
13 | | -# - https://github.com/flutter/packages/blob/master/analysis_options.yaml |
14 | | -# |
15 | | -# This file contains the analysis options used for code in the flutter/flutter |
16 | | -# repository. |
| 1 | +include: package:flutter_lints/flutter.yaml |
17 | 2 |
|
18 | 3 | analyzer: |
19 | | - language: |
20 | | - strict-casts: true |
21 | | - strict-raw-types: true |
22 | 4 | errors: |
23 | | - # allow self-reference to deprecated members (we do this because otherwise we have |
24 | | - # to annotate every member in every test, assert, etc, when we deprecate something) |
25 | 5 | deprecated_member_use_from_same_package: ignore |
26 | 6 | exclude: |
27 | | - - "lib/*.g.dart" |
28 | 7 | - "lib/**/*.g.dart" |
29 | 8 |
|
| 9 | +formatter: |
| 10 | + trailing_commas: preserve |
| 11 | + |
30 | 12 | linter: |
31 | 13 | rules: |
32 | | - # This list is derived from the list of all available lints located at |
33 | | - # https://github.com/dart-lang/linter/blob/master/example/all.yaml |
34 | | - - always_declare_return_types |
35 | | - - always_put_control_body_on_new_line |
36 | | - # - always_put_required_named_parameters_first # we prefer having parameters in the same order as fields https://github.com/flutter/flutter/issues/10219 |
37 | | - - always_specify_types |
38 | | - # - always_use_package_imports # we do this commonly |
39 | | - - annotate_overrides |
40 | | - # - avoid_annotating_with_dynamic # conflicts with always_specify_types |
41 | | - - avoid_bool_literals_in_conditional_expressions |
42 | | - # - avoid_catches_without_on_clauses # blocked on https://github.com/dart-lang/linter/issues/3023 |
43 | | - # - avoid_catching_errors # blocked on https://github.com/dart-lang/linter/issues/3023 |
44 | | - # avoid_classes_with_only_static_members # # we do this commonly for `abstract final class`es |
45 | | - - avoid_double_and_int_checks |
46 | | - - avoid_dynamic_calls |
47 | | - - avoid_empty_else |
48 | | - - avoid_equals_and_hash_code_on_mutable_classes |
49 | | - - avoid_escaping_inner_quotes |
50 | | - - avoid_field_initializers_in_const_classes |
51 | | - # - avoid_final_parameters # incompatible with prefer_final_parameters |
52 | | - - avoid_function_literals_in_foreach_calls |
53 | | - - avoid_implementing_value_types |
54 | | - - avoid_init_to_null |
55 | | - - avoid_js_rounded_ints |
56 | | - # - avoid_multiple_declarations_per_line # seems to be a stylistic choice we don't subscribe to |
57 | | - - avoid_null_checks_in_equality_operators |
58 | | - # - avoid_positional_boolean_parameters # would have been nice to enable this but by now there's too many places that break it |
59 | | - - avoid_print |
60 | | - # - avoid_private_typedef_functions # we prefer having typedef (discussion in https://github.com/flutter/flutter/pull/16356) |
61 | | - - avoid_redundant_argument_values |
62 | | - - avoid_relative_lib_imports |
63 | | - - avoid_renaming_method_parameters |
64 | | - - avoid_return_types_on_setters |
65 | | - - avoid_returning_null_for_void |
66 | | - # - avoid_returning_this # there are enough valid reasons to return `this` that this lint ends up with too many false positives |
67 | | - - avoid_setters_without_getters |
68 | | - - avoid_shadowing_type_parameters |
69 | | - - avoid_single_cascade_in_expression_statements |
70 | | - - avoid_slow_async_io |
71 | | - - avoid_type_to_string |
72 | | - - avoid_types_as_parameter_names |
73 | | - # - avoid_types_on_closure_parameters # conflicts with always_specify_types |
74 | | - - avoid_unnecessary_containers |
75 | | - - avoid_unused_constructor_parameters |
76 | | - - avoid_void_async |
77 | | - # - avoid_web_libraries_in_flutter # we use web libraries in web-specific code, and our tests prevent us from using them elsewhere |
78 | | - - await_only_futures |
79 | | - - camel_case_extensions |
80 | | - - camel_case_types |
81 | | - - cancel_subscriptions |
82 | | - # - cascade_invocations # doesn't match the typical style of this repo |
83 | | - - cast_nullable_to_non_nullable |
84 | | - # - close_sinks # not reliable enough |
85 | | - - collection_methods_unrelated_type |
86 | | - - combinators_ordering |
87 | | - # - comment_references # blocked on https://github.com/dart-lang/linter/issues/1142 |
88 | | - - conditional_uri_does_not_exist |
89 | | - # - constant_identifier_names # needs an opt-out https://github.com/dart-lang/linter/issues/204 |
90 | | - - control_flow_in_finally |
91 | | - - curly_braces_in_flow_control_structures |
92 | | - - dangling_library_doc_comments |
93 | | - - depend_on_referenced_packages |
94 | | - - deprecated_consistency |
95 | | - # - diagnostic_describe_all_properties # enabled only at the framework level (packages/flutter/lib) |
96 | | - - directives_ordering |
97 | | - # - discarded_futures # too many false positives, similar to unawaited_futures |
98 | | - # - do_not_use_environment # there are appropriate times to use the environment, especially in our tests and build logic |
99 | | - - empty_catches |
100 | | - - empty_constructor_bodies |
101 | | - - empty_statements |
102 | | - - eol_at_end_of_file |
103 | | - - exhaustive_cases |
104 | | - - file_names |
105 | | - - flutter_style_todos |
106 | | - - hash_and_equals |
107 | | - - implementation_imports |
108 | | - - implicit_call_tearoffs |
109 | | - - invalid_case_patterns |
110 | | - - iterable_contains_unrelated_type |
111 | | - # - join_return_with_assignment # not required by flutter style |
112 | | - - leading_newlines_in_multiline_strings |
113 | | - - library_annotations |
114 | | - - library_names |
115 | | - - library_prefixes |
116 | | - - library_private_types_in_public_api |
117 | | - # - lines_longer_than_80_chars # not required by flutter style |
118 | | - - list_remove_unrelated_type |
119 | | - # - literal_only_boolean_expressions # too many false positives: https://github.com/dart-lang/linter/issues/453 |
120 | | - - missing_whitespace_between_adjacent_strings |
121 | | - - no_adjacent_strings_in_list |
122 | | - - no_default_cases |
123 | | - - no_duplicate_case_values |
124 | | - - no_leading_underscores_for_library_prefixes |
125 | | - - no_leading_underscores_for_local_identifiers |
126 | | - - no_logic_in_create_state |
127 | | - # - no_runtimeType_toString # ok in tests; we enable this only in packages/ |
128 | | - - non_constant_identifier_names |
129 | | - - noop_primitive_operations |
130 | | - - null_check_on_nullable_type_parameter |
131 | | - - null_closures |
132 | | - # - omit_local_variable_types # opposite of always_specify_types |
133 | | - # - one_member_abstracts # too many false positives |
134 | | - - only_throw_errors # this does get disabled in a few places where we have legacy code that uses strings et al |
135 | | - - overridden_fields |
136 | | - - package_api_docs |
137 | | - - package_names |
138 | | - - package_prefixed_library_names |
139 | | - # - parameter_assignments # we do this commonly |
140 | | - - prefer_adjacent_string_concatenation |
141 | | - - prefer_asserts_in_initializer_lists |
142 | | - # - prefer_asserts_with_message # not required by flutter style |
143 | | - - prefer_collection_literals |
144 | | - - prefer_conditional_assignment |
145 | | - # - prefer_const_constructors |
146 | | - - prefer_const_constructors_in_immutables |
147 | | - - prefer_const_declarations |
148 | | - - prefer_const_literals_to_create_immutables |
149 | | - # - prefer_constructors_over_static_methods # far too many false positives |
150 | | - - prefer_contains |
151 | | - # - prefer_double_quotes # opposite of prefer_single_quotes |
152 | | - # - prefer_expression_function_bodies # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#consider-using--for-short-functions-and-methods |
153 | | - - prefer_final_fields |
154 | | - - prefer_final_in_for_each |
155 | | - - prefer_final_locals |
156 | | - # - 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 |
157 | | - - prefer_for_elements_to_map_fromIterable |
158 | | - - prefer_foreach |
159 | | - - prefer_function_declarations_over_variables |
160 | | - - prefer_generic_function_type_aliases |
161 | | - - prefer_if_elements_to_conditional_expressions |
162 | | - - prefer_if_null_operators |
163 | | - - prefer_initializing_formals |
164 | | - - prefer_inlined_adds |
165 | | - # - prefer_int_literals # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#use-double-literals-for-double-constants |
166 | | - - prefer_interpolation_to_compose_strings |
167 | | - - prefer_is_empty |
168 | | - - prefer_is_not_empty |
169 | | - - prefer_is_not_operator |
170 | | - - prefer_iterable_whereType |
171 | | - # - prefer_mixin |
172 | | - # - prefer_null_aware_method_calls # "call()" is confusing to people new to the language since it's not documented anywhere |
173 | | - - prefer_null_aware_operators |
174 | | - # - prefer_relative_imports |
175 | | - - prefer_single_quotes |
176 | | - - prefer_spread_collections |
177 | | - - prefer_typing_uninitialized_variables |
178 | | - - prefer_void_to_null |
179 | | - - provide_deprecation_message |
180 | | - # - public_member_api_docs # enabled on a case-by-case basis; see e.g. packages/analysis_options.yaml |
181 | | - - recursive_getters |
182 | | - # - require_trailing_commas # would be nice, but requires a lot of manual work: 10,000+ code locations would need to be reformatted by hand after bulk fix is applied |
183 | | - - secure_pubspec_urls |
184 | | - - sized_box_for_whitespace |
185 | | - - sized_box_shrink_expand |
186 | | - - slash_for_doc_comments |
187 | | - - sort_child_properties_last |
188 | | - - sort_constructors_first |
189 | | - # - sort_pub_dependencies # prevents separating pinned transitive dependencies |
190 | | - - sort_unnamed_constructors_first |
191 | | - - test_types_in_equals |
192 | | - - throw_in_finally |
193 | | - - tighten_type_of_initializing_formals |
194 | | - # - type_annotate_public_apis # subset of always_specify_types |
195 | | - - type_init_formals |
196 | | - # - unawaited_futures # too many false positives, especially with the way AnimationController works |
197 | | - - unnecessary_await_in_return |
198 | | - - unnecessary_brace_in_string_interps |
199 | | - - unnecessary_breaks |
200 | | - - unnecessary_const |
201 | | - - unnecessary_constructor_name |
202 | | - # - unnecessary_final # conflicts with prefer_final_locals |
203 | | - - unnecessary_getters_setters |
204 | | - # - unnecessary_lambdas # has false positives: https://github.com/dart-lang/linter/issues/498 |
205 | | - - unnecessary_late |
206 | | - - unnecessary_library_directive |
207 | | - - unnecessary_new |
208 | | - - 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 | | - - unnecessary_overrides |
214 | | - - 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 | | - # - unreachable_from_main # Do not enable this rule until it is un-marked as "experimental" and carefully re-evaluated. |
222 | | - - unrelated_type_equality_checks |
223 | | - - unsafe_html |
224 | | - - use_build_context_synchronously |
225 | | - - use_colored_box |
226 | | - # - use_decorated_box # leads to bugs: DecoratedBox and Container are not equivalent (Container inserts extra padding) |
227 | | - - use_enums |
228 | | - - use_full_hex_values_for_flutter_colors |
229 | | - - use_function_type_syntax_for_parameters |
230 | | - - use_if_null_to_convert_nulls_to_bools |
231 | | - - use_is_even_rather_than_modulo |
232 | | - - use_key_in_widget_constructors |
233 | | - - use_late_for_private_fields_and_variables |
234 | | - - use_named_constants |
235 | | - - use_raw_strings |
236 | | - - use_rethrow_when_possible |
237 | | - - use_setters_to_change_properties |
238 | | - # - use_string_buffers # has false positives: https://github.com/dart-lang/sdk/issues/34182 |
239 | | - - use_string_in_part_of_directives |
240 | | - - use_super_parameters |
241 | | - - use_test_throws_matchers |
242 | | - # - use_to_and_as_if_applicable # has false positives, so we prefer to catch this by code-review |
243 | | - - valid_regexps |
244 | | - - void_checks |
| 14 | + always_declare_return_types: true |
| 15 | + always_put_control_body_on_new_line: true |
| 16 | + avoid_print: true |
| 17 | + avoid_renaming_method_parameters: true |
| 18 | + avoid_unnecessary_containers: true |
| 19 | + avoid_void_async: true |
| 20 | + curly_braces_in_flow_control_structures: true |
| 21 | + directives_ordering: true |
| 22 | + flutter_style_todos: true |
| 23 | + library_private_types_in_public_api: false |
| 24 | + overridden_fields: false |
| 25 | + prefer_const_constructors: true |
| 26 | + prefer_const_constructors_in_immutables: false |
| 27 | + prefer_final_fields: true |
| 28 | + prefer_final_in_for_each: true |
| 29 | + prefer_final_locals: true |
| 30 | + prefer_single_quotes: true |
| 31 | + sort_child_properties_last: true |
| 32 | + sort_constructors_first: true |
| 33 | + sort_unnamed_constructors_first: true |
| 34 | + unnecessary_await_in_return: true |
| 35 | + unnecessary_breaks: true |
| 36 | + unnecessary_late: true |
| 37 | + unnecessary_parenthesis: true |
| 38 | + use_build_context_synchronously: false |
| 39 | + void_checks: true |
0 commit comments