|
1 | | -# Specify analysis options. |
| 1 | +# This file configures the analyzer, which statically analyzes Dart code to |
| 2 | +# check for errors, warnings, and lints. |
2 | 3 | # |
3 | | -# Until there are meta linter rules, each desired lint must be explicitly enabled. |
4 | | -# See: https://github.com/dart-lang/linter/issues/288 |
5 | | -# |
6 | | -# For a list of lints, see: http://dart-lang.github.io/linter/lints/ |
7 | | -# See the configuration guide for more |
8 | | -# https://github.com/dart-lang/sdk/tree/master/pkg/analyzer#configuring-the-analyzer |
9 | | -# |
10 | | -# There are other similar analysis options files in the flutter repos, |
11 | | -# which should be kept in sync with this file: |
12 | | -# |
13 | | -# - analysis_options.yaml (this file) |
14 | | -# - packages/flutter/lib/analysis_options_user.yaml |
15 | | -# - https://github.com/flutter/plugins/blob/master/analysis_options.yaml |
16 | | -# - https://github.com/flutter/engine/blob/master/analysis_options.yaml |
17 | | -# |
18 | | -# This file contains the analysis options used by Flutter tools, such as IntelliJ, |
19 | | -# Android Studio, and the `flutter analyze` command. |
20 | | - |
21 | | -include: package:pedantic/analysis_options.yaml |
| 4 | +# The issues identified by the analyzer are surfaced in the UI of Dart-enabled |
| 5 | +# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be |
| 6 | +# invoked from the command line by running `flutter analyze`. |
22 | 7 |
|
23 | | -analyzer: |
24 | | - strong-mode: |
25 | | - implicit-casts: false |
26 | | - implicit-dynamic: true |
27 | | - errors: |
28 | | - # treat missing required parameters as a warning (not a hint) |
29 | | - missing_required_param: warning |
30 | | - # treat missing returns as a warning (not a hint) |
31 | | - missing_return: warning |
32 | | - # allow having TODOs in the code |
33 | | - todo: ignore |
34 | | - # allow self-reference to deprecated members (we do this because otherwise we have |
35 | | - # to annotate every member in every test, assert, etc, when we deprecate something) |
36 | | - deprecated_member_use_from_same_package: ignore |
37 | | - # Ignore analyzer hints for updating pubspecs when using Future or |
38 | | - # Stream and not importing dart:async |
39 | | - # Please see https://github.com/flutter/flutter/pull/24528 for details. |
40 | | - sdk_version_async_exported_from_core: ignore |
41 | | - # Turned off until null-safe rollout is complete. |
42 | | - unnecessary_null_comparison: ignore |
43 | | - exclude: |
44 | | - - "bin/cache/**" |
| 8 | +# The following line activates a set of recommended lints for Flutter apps, |
| 9 | +# packages, and plugins designed to encourage good coding practices. |
| 10 | +include: package:flutter_lints/flutter.yaml |
45 | 11 |
|
46 | 12 | linter: |
| 13 | + # The lint rules applied to this project can be customized in the |
| 14 | + # section below to disable rules from the `package:flutter_lints/flutter.yaml` |
| 15 | + # included above or to enable additional rules. A list of all available lints |
| 16 | + # and their documentation is published at |
| 17 | + # https://dart-lang.github.io/linter/lints/index.html. |
| 18 | + # |
| 19 | + # Instead of disabling a lint rule for the entire project in the |
| 20 | + # section below, it can also be suppressed for a single line of code |
| 21 | + # or a specific dart file by using the `// ignore: name_of_lint` and |
| 22 | + # `// ignore_for_file: name_of_lint` syntax on the line or in the file |
| 23 | + # producing the lint. |
47 | 24 | rules: |
48 | | - # these rules are documented on and in the same order as |
49 | | - # the Dart Lint rules page to make maintenance easier |
50 | | - # https://github.com/dart-lang/linter/blob/master/example/all.yaml |
51 | | - - always_declare_return_types |
52 | | - # - always_put_control_body_on_new_line |
53 | | - # - always_put_required_named_parameters_first # we prefer having parameters in the same order as fields https://github.com/flutter/flutter/issues/10219 |
54 | | - - always_require_non_null_named_parameters |
55 | | - # - always_specify_types |
56 | | - # - always_use_package_imports # we do this commonly |
57 | | - - annotate_overrides |
58 | | - # - avoid_annotating_with_dynamic # conflicts with always_specify_types |
59 | | - - avoid_bool_literals_in_conditional_expressions |
60 | | - # - avoid_catches_without_on_clauses # we do this commonly |
61 | | - # - avoid_catching_errors # we do this commonly |
62 | | - - avoid_classes_with_only_static_members |
63 | | - # - avoid_double_and_int_checks # only useful when targeting JS runtime |
64 | | - # - avoid_dynamic_calls # not yet tested |
65 | | - - avoid_empty_else |
66 | | - - avoid_equals_and_hash_code_on_mutable_classes |
67 | | - # - avoid_escaping_inner_quotes # not yet tested |
68 | | - - avoid_field_initializers_in_const_classes |
69 | | - # - avoid_function_literals_in_foreach_calls |
70 | | - # - avoid_implementing_value_types # not yet tested |
71 | | - - avoid_init_to_null |
72 | | - # - avoid_js_rounded_ints # only useful when targeting JS runtime |
73 | | - - avoid_null_checks_in_equality_operators |
74 | | - # - avoid_positional_boolean_parameters # not yet tested |
75 | | - # - avoid_print # not yet tested |
76 | | - # - avoid_private_typedef_functions # we prefer having typedef (discussion in https://github.com/flutter/flutter/pull/16356) |
77 | | - # - avoid_redundant_argument_values # not yet tested |
78 | | - - avoid_relative_lib_imports |
79 | | - - avoid_renaming_method_parameters |
80 | | - - avoid_return_types_on_setters |
81 | | - # - avoid_returning_null # there are plenty of valid reasons to return null |
82 | | - # - avoid_returning_null_for_future # not yet tested |
83 | | - - avoid_returning_null_for_void |
84 | | - # - avoid_returning_this # there are plenty of valid reasons to return this |
85 | | - # - avoid_setters_without_getters # not yet tested |
86 | | - - avoid_shadowing_type_parameters |
87 | | - - avoid_single_cascade_in_expression_statements |
88 | | - - avoid_slow_async_io |
89 | | - - avoid_type_to_string |
90 | | - - avoid_types_as_parameter_names |
91 | | - # - avoid_types_on_closure_parameters # conflicts with always_specify_types |
92 | | - - avoid_unnecessary_containers |
93 | | - - avoid_unused_constructor_parameters |
94 | | - # - avoid_void_async |
95 | | - # - avoid_web_libraries_in_flutter # not yet tested |
96 | | - - await_only_futures |
97 | | - - camel_case_extensions |
98 | | - - camel_case_types |
99 | | - - cancel_subscriptions |
100 | | - # - cascade_invocations # not yet tested |
101 | | - - cast_nullable_to_non_nullable |
102 | | - # - close_sinks # not reliable enough |
103 | | - # - comment_references # blocked on https://github.com/dart-lang/linter/issues/1142 |
104 | | - # - constant_identifier_names # needs an opt-out https://github.com/dart-lang/linter/issues/204 |
105 | | - - control_flow_in_finally |
106 | | - # - curly_braces_in_flow_control_structures # not required by flutter style |
107 | | - # - deprecated_consistency # not yet tested |
108 | | - # - diagnostic_describe_all_properties # not yet tested |
109 | | - - directives_ordering |
110 | | - # - do_not_use_environment # we do this commonly |
111 | | - - empty_catches |
112 | | - - empty_constructor_bodies |
113 | | - - empty_statements |
114 | | - - exhaustive_cases |
115 | | - - file_names |
116 | | - - flutter_style_todos |
117 | | - - hash_and_equals |
118 | | - # - implementation_imports |
119 | | - # - invariant_booleans # too many false positives: https://github.com/dart-lang/linter/issues/811 |
120 | | - - iterable_contains_unrelated_type |
121 | | - # - join_return_with_assignment # not required by flutter style |
122 | | - - leading_newlines_in_multiline_strings |
123 | | - - library_names |
124 | | - - library_prefixes |
125 | | - # - lines_longer_than_80_chars # not required by flutter style |
126 | | - - list_remove_unrelated_type |
127 | | - # - literal_only_boolean_expressions # too many false positives: https://github.com/dart-lang/sdk/issues/34181 |
128 | | - - missing_whitespace_between_adjacent_strings |
129 | | - - no_adjacent_strings_in_list |
130 | | - # - no_default_cases # too many false positives |
131 | | - - no_duplicate_case_values |
132 | | - - no_logic_in_create_state |
133 | | - # - no_runtimeType_toString # ok in tests; we enable this only in packages/ |
134 | | - - non_constant_identifier_names |
135 | | - - null_check_on_nullable_type_parameter |
136 | | - - null_closures |
137 | | - # - omit_local_variable_types # opposite of always_specify_types |
138 | | - # - one_member_abstracts # too many false positives |
139 | | - # - only_throw_errors # https://github.com/flutter/flutter/issues/5792 |
140 | | - - overridden_fields |
141 | | - - package_api_docs |
142 | | - - package_names |
143 | | - - package_prefixed_library_names |
144 | | - # - parameter_assignments # we do this commonly |
145 | | - - prefer_adjacent_string_concatenation |
146 | | - - prefer_asserts_in_initializer_lists |
147 | | - # - prefer_asserts_with_message # not required by flutter style |
148 | | - - prefer_collection_literals |
149 | | - - prefer_conditional_assignment |
150 | | - - prefer_const_constructors |
151 | | - - prefer_const_constructors_in_immutables |
152 | | - - prefer_const_declarations |
153 | | - - prefer_const_literals_to_create_immutables |
154 | | - # - prefer_constructors_over_static_methods # far too many false positives |
155 | | - - prefer_contains |
156 | | - # - prefer_double_quotes # opposite of prefer_single_quotes |
157 | | - - prefer_equal_for_default_values |
158 | | - # - prefer_expression_function_bodies # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#consider-using--for-short-functions-and-methods |
159 | | - - prefer_final_fields |
160 | | - - prefer_final_in_for_each |
161 | | - - prefer_final_locals |
162 | | - - prefer_for_elements_to_map_fromIterable |
163 | | - - prefer_foreach |
164 | | - # - prefer_function_declarations_over_variables # not yet tested |
165 | | - - prefer_generic_function_type_aliases |
166 | | - - prefer_if_elements_to_conditional_expressions |
167 | | - - prefer_if_null_operators |
168 | | - - prefer_initializing_formals |
169 | | - - prefer_inlined_adds |
170 | | - # - prefer_int_literals # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#use-double-literals-for-double-constants |
171 | | - # - prefer_interpolation_to_compose_strings # doesn't work with raw strings, see https://github.com/dart-lang/linter/issues/2490 |
172 | | - - prefer_is_empty |
173 | | - - prefer_is_not_empty |
174 | | - - prefer_is_not_operator |
175 | | - - prefer_iterable_whereType |
176 | | - # - prefer_mixin # https://github.com/dart-lang/language/issues/32 |
177 | | - - prefer_null_aware_operators |
178 | | - # - prefer_relative_imports # not yet tested |
179 | | - - prefer_single_quotes |
180 | | - - prefer_spread_collections |
181 | | - - prefer_typing_uninitialized_variables |
182 | | - - prefer_void_to_null |
183 | | - - provide_deprecation_message |
184 | | - # - public_member_api_docs # enabled on a case-by-case basis; see e.g. packages/analysis_options.yaml |
185 | | - - recursive_getters |
186 | | - - sized_box_for_whitespace |
187 | | - - slash_for_doc_comments |
188 | | - # - sort_child_properties_last # not yet tested |
189 | | - - sort_constructors_first |
190 | | - # - sort_pub_dependencies # prevents separating pinned transitive dependencies |
191 | | - - sort_unnamed_constructors_first |
192 | | - - test_types_in_equals |
193 | | - - throw_in_finally |
194 | | - - tighten_type_of_initializing_formals |
195 | | - # - type_annotate_public_apis # subset of always_specify_types |
196 | | - - type_init_formals |
197 | | - # - unawaited_futures # too many false positives |
198 | | - # - unnecessary_await_in_return # not yet tested |
199 | | - - unnecessary_brace_in_string_interps |
200 | | - - unnecessary_const |
201 | | - # - unnecessary_final # conflicts with prefer_final_locals |
202 | | - - unnecessary_getters_setters |
203 | | - # - unnecessary_lambdas # has false positives: https://github.com/dart-lang/linter/issues/498 |
204 | | - - unnecessary_new |
205 | | - - unnecessary_null_aware_assignments |
206 | | - # - unnecessary_null_checks # not yet tested |
207 | | - - unnecessary_null_in_if_null_operators |
208 | | - - unnecessary_nullable_for_final_variable_declarations |
209 | | - - unnecessary_overrides |
210 | | - - unnecessary_parenthesis |
211 | | - # - unnecessary_raw_strings # not yet tested |
212 | | - - unnecessary_statements |
213 | | - - unnecessary_string_escapes |
214 | | - - unnecessary_string_interpolations |
215 | | - - unnecessary_this |
216 | | - - unrelated_type_equality_checks |
217 | | - # - unsafe_html # not yet tested |
218 | | - - use_full_hex_values_for_flutter_colors |
219 | | - - use_function_type_syntax_for_parameters |
220 | | - # - use_if_null_to_convert_nulls_to_bools # not yet tested |
221 | | - - use_is_even_rather_than_modulo |
222 | | - - use_key_in_widget_constructors |
223 | | - - use_late_for_private_fields_and_variables |
224 | | - # - use_named_constants # not yet yested |
225 | | - - use_raw_strings |
226 | | - - use_rethrow_when_possible |
227 | | - # - use_setters_to_change_properties # not yet tested |
228 | | - # - use_string_buffers # has false positives: https://github.com/dart-lang/sdk/issues/34182 |
229 | | - # - use_to_and_as_if_applicable # has false positives, so we prefer to catch this by code-review |
230 | | - - valid_regexps |
231 | | - - void_checks |
| 25 | + # avoid_print: false # Uncomment to disable the `avoid_print` rule |
| 26 | + # prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule |
| 27 | + |
| 28 | +# Additional information about this file can be found at |
| 29 | +# https://dart.dev/guides/language/analysis-options |
0 commit comments