|
| 1 | +# Specify analysis options. |
| 2 | +# |
| 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 | +analyzer: |
| 22 | + strong-mode: |
| 23 | + implicit-dynamic: false |
| 24 | + errors: |
| 25 | + # treat missing required parameters as a warning (not a hint) |
| 26 | + missing_required_param: warning |
| 27 | + # treat missing returns as a warning (not a hint) |
| 28 | + missing_return: warning |
| 29 | + # allow having TODOs in the code |
| 30 | + todo: ignore |
| 31 | + # Ignore analyzer hints for updating pubspecs when using Future or |
| 32 | + # Stream and not importing dart:async |
| 33 | + # Please see https://github.com/flutter/flutter/pull/24528 for details. |
| 34 | + sdk_version_async_exported_from_core: ignore |
| 35 | + exclude: |
| 36 | + - 'bin/cache/**' |
| 37 | + # the following two are relative to the stocks example and the flutter package respectively |
| 38 | + # see https://github.com/dart-lang/sdk/issues/28463 |
| 39 | + - 'lib/i18n/stock_messages_*.dart' |
| 40 | + - 'lib/src/http/**' |
| 41 | + |
| 42 | +linter: |
| 43 | + rules: |
| 44 | + # these rules are documented on and in the same order as |
| 45 | + # the Dart Lint rules page to make maintenance easier |
| 46 | + # https://github.com/dart-lang/linter/blob/master/example/all.yaml |
| 47 | + - always_declare_return_types |
| 48 | + - always_put_control_body_on_new_line |
| 49 | + # - always_put_required_named_parameters_first # we prefer having parameters in the same order as fields https://github.com/flutter/flutter/issues/10219 |
| 50 | + - always_require_non_null_named_parameters |
| 51 | + - always_specify_types |
| 52 | + - annotate_overrides |
| 53 | + # - avoid_annotating_with_dynamic # conflicts with always_specify_types |
| 54 | + # - avoid_bool_literals_in_conditional_expressions # not yet tested |
| 55 | + # - avoid_catches_without_on_clauses # we do this commonly |
| 56 | + # - avoid_catching_errors # we do this commonly |
| 57 | + - avoid_classes_with_only_static_members |
| 58 | + # - avoid_double_and_int_checks # only useful when targeting JS runtime |
| 59 | + - avoid_empty_else |
| 60 | + - avoid_field_initializers_in_const_classes |
| 61 | + - avoid_function_literals_in_foreach_calls |
| 62 | + # - avoid_implementing_value_types # not yet tested |
| 63 | + - avoid_init_to_null |
| 64 | + # - avoid_js_rounded_ints # only useful when targeting JS runtime |
| 65 | + - avoid_null_checks_in_equality_operators |
| 66 | + # - avoid_positional_boolean_parameters # not yet tested |
| 67 | + # - avoid_private_typedef_functions # we prefer having typedef (discussion in https://github.com/flutter/flutter/pull/16356) |
| 68 | + - avoid_relative_lib_imports |
| 69 | + - avoid_renaming_method_parameters |
| 70 | + - avoid_return_types_on_setters |
| 71 | + # - avoid_returning_null # there are plenty of valid reasons to return null |
| 72 | + # - avoid_returning_null_for_future # not yet tested |
| 73 | + - avoid_returning_null_for_void |
| 74 | + # - avoid_returning_this # there are plenty of valid reasons to return this |
| 75 | + # - avoid_setters_without_getters # not yet tested |
| 76 | + # - avoid_shadowing_type_parameters # not yet tested |
| 77 | + # - avoid_single_cascade_in_expression_statements # not yet tested |
| 78 | + - avoid_slow_async_io |
| 79 | + - avoid_types_as_parameter_names |
| 80 | + # - avoid_types_on_closure_parameters # conflicts with always_specify_types |
| 81 | + - avoid_unused_constructor_parameters |
| 82 | + - avoid_void_async |
| 83 | + - await_only_futures |
| 84 | + - camel_case_types |
| 85 | + - cancel_subscriptions |
| 86 | + # - cascade_invocations # not yet tested |
| 87 | + # - close_sinks # not reliable enough |
| 88 | + # - comment_references # blocked on https://github.com/flutter/flutter/issues/20765 |
| 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 # not yet tested |
| 92 | + - directives_ordering |
| 93 | + - empty_catches |
| 94 | + - empty_constructor_bodies |
| 95 | + - empty_statements |
| 96 | + # - file_names # not yet tested |
| 97 | + - flutter_style_todos |
| 98 | + - hash_and_equals |
| 99 | + - implementation_imports |
| 100 | + # - invariant_booleans # too many false positives: https://github.com/dart-lang/linter/issues/811 |
| 101 | + - iterable_contains_unrelated_type |
| 102 | + # - join_return_with_assignment # not yet tested |
| 103 | + - library_names |
| 104 | + - library_prefixes |
| 105 | + # - lines_longer_than_80_chars # not yet tested |
| 106 | + - list_remove_unrelated_type |
| 107 | + # - literal_only_boolean_expressions # too many false positives: https://github.com/dart-lang/sdk/issues/34181 |
| 108 | + - no_adjacent_strings_in_list |
| 109 | + - no_duplicate_case_values |
| 110 | + - non_constant_identifier_names |
| 111 | + # - null_closures # not yet tested |
| 112 | + # - omit_local_variable_types # opposite of always_specify_types |
| 113 | + # - one_member_abstracts # too many false positives |
| 114 | + # - only_throw_errors # https://github.com/flutter/flutter/issues/5792 |
| 115 | + - overridden_fields |
| 116 | + - package_api_docs |
| 117 | + - package_names |
| 118 | + - package_prefixed_library_names |
| 119 | + # - parameter_assignments # we do this commonly |
| 120 | + - prefer_adjacent_string_concatenation |
| 121 | + - prefer_asserts_in_initializer_lists |
| 122 | + - prefer_collection_literals |
| 123 | + - prefer_conditional_assignment |
| 124 | + - prefer_const_constructors |
| 125 | + - prefer_const_constructors_in_immutables |
| 126 | + - prefer_const_declarations |
| 127 | + - prefer_const_literals_to_create_immutables |
| 128 | + # - prefer_constructors_over_static_methods # not yet tested |
| 129 | + - prefer_contains |
| 130 | + - prefer_equal_for_default_values |
| 131 | + # - prefer_expression_function_bodies # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#consider-using--for-short-functions-and-methods |
| 132 | + - prefer_final_fields |
| 133 | + - prefer_final_locals |
| 134 | + - prefer_foreach |
| 135 | + # - prefer_function_declarations_over_variables # not yet tested |
| 136 | + - prefer_generic_function_type_aliases |
| 137 | + - prefer_initializing_formals |
| 138 | + # - prefer_int_literals # not yet tested |
| 139 | + # - prefer_interpolation_to_compose_strings # not yet tested |
| 140 | + - prefer_is_empty |
| 141 | + - prefer_is_not_empty |
| 142 | + - prefer_iterable_whereType |
| 143 | + # - prefer_mixin # https://github.com/dart-lang/language/issues/32 |
| 144 | + - prefer_single_quotes |
| 145 | + - prefer_typing_uninitialized_variables |
| 146 | + - prefer_void_to_null |
| 147 | + # - public_member_api_docs # enabled on a case-by-case basis; see e.g. packages/analysis_options.yaml |
| 148 | + - recursive_getters |
| 149 | + - slash_for_doc_comments |
| 150 | + - sort_constructors_first |
| 151 | + - sort_pub_dependencies |
| 152 | + - sort_unnamed_constructors_first |
| 153 | + # - super_goes_last # no longer needed w/ Dart 2 |
| 154 | + - test_types_in_equals |
| 155 | + - throw_in_finally |
| 156 | + # - type_annotate_public_apis # subset of always_specify_types |
| 157 | + - type_init_formals |
| 158 | + # - unawaited_futures # too many false positives |
| 159 | + # - unnecessary_await_in_return # not yet tested |
| 160 | + - unnecessary_brace_in_string_interps |
| 161 | + - unnecessary_const |
| 162 | + - unnecessary_getters_setters |
| 163 | + # - unnecessary_lambdas # has false positives: https://github.com/dart-lang/linter/issues/498 |
| 164 | + - unnecessary_new |
| 165 | + - unnecessary_null_aware_assignments |
| 166 | + - unnecessary_null_in_if_null_operators |
| 167 | + - unnecessary_overrides |
| 168 | + - unnecessary_parenthesis |
| 169 | + - unnecessary_statements |
| 170 | + - unnecessary_this |
| 171 | + - unrelated_type_equality_checks |
| 172 | + # - use_function_type_syntax_for_parameters # not yet tested |
| 173 | + - use_rethrow_when_possible |
| 174 | + # - use_setters_to_change_properties # not yet tested |
| 175 | + # - use_string_buffers # has false positives: https://github.com/dart-lang/sdk/issues/34182 |
| 176 | + # - use_to_and_as_if_applicable # has false positives, so we prefer to catch this by code-review |
| 177 | + - valid_regexps |
| 178 | + # - void_checks # not yet tested |
0 commit comments