analysis_options.yaml 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207
  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. analyzer:
  21. strong-mode:
  22. implicit-casts: false
  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/messages_*.dart"
  40. # - "lib/src/http/**"
  41. linter:
  42. rules:
  43. # these rules are documented on and in the same order as
  44. # the Dart Lint rules page to make maintenance easier
  45. # https://github.com/dart-lang/linter/blob/master/example/all.yaml
  46. - always_declare_return_types
  47. - always_put_control_body_on_new_line
  48. # - always_put_required_named_parameters_first # we prefer having parameters in the same order as fields https://github.com/flutter/flutter/issues/10219
  49. - always_require_non_null_named_parameters
  50. - always_specify_types
  51. - annotate_overrides
  52. # - avoid_annotating_with_dynamic # conflicts with always_specify_types
  53. # - avoid_as # required for implicit-casts: true
  54. - avoid_bool_literals_in_conditional_expressions
  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_equals_and_hash_code_on_mutable_classes # not yet tested
  61. - avoid_field_initializers_in_const_classes
  62. - avoid_function_literals_in_foreach_calls
  63. # - avoid_implementing_value_types # not yet tested
  64. - avoid_init_to_null
  65. # - avoid_js_rounded_ints # only useful when targeting JS runtime
  66. - avoid_null_checks_in_equality_operators
  67. # - avoid_positional_boolean_parameters # not yet tested
  68. # - avoid_print # not yet tested
  69. # - avoid_private_typedef_functions # we prefer having typedef (discussion in https://github.com/flutter/flutter/pull/16356)
  70. # - avoid_redundant_argument_values # not yet tested
  71. - avoid_relative_lib_imports
  72. - avoid_renaming_method_parameters
  73. - avoid_return_types_on_setters
  74. # - avoid_returning_null # there are plenty of valid reasons to return null
  75. # - avoid_returning_null_for_future # not yet tested
  76. - avoid_returning_null_for_void
  77. # - avoid_returning_this # there are plenty of valid reasons to return this
  78. # - avoid_setters_without_getters # not yet tested
  79. # - avoid_shadowing_type_parameters # not yet tested
  80. - avoid_single_cascade_in_expression_statements
  81. - avoid_slow_async_io
  82. - avoid_types_as_parameter_names
  83. # - avoid_types_on_closure_parameters # conflicts with always_specify_types
  84. # - avoid_unnecessary_containers # not yet tested
  85. - avoid_unused_constructor_parameters
  86. - avoid_void_async
  87. # - avoid_web_libraries_in_flutter # not yet tested
  88. - await_only_futures
  89. - camel_case_extensions
  90. - camel_case_types
  91. - cancel_subscriptions
  92. # - cascade_invocations # not yet tested
  93. # - close_sinks # not reliable enough
  94. # - comment_references # blocked on https://github.com/flutter/flutter/issues/20765
  95. # - constant_identifier_names # needs an opt-out https://github.com/dart-lang/linter/issues/204
  96. - control_flow_in_finally
  97. # - curly_braces_in_flow_control_structures # not yet tested
  98. # - diagnostic_describe_all_properties # not yet tested
  99. - directives_ordering
  100. - empty_catches
  101. - empty_constructor_bodies
  102. - empty_statements
  103. # - file_names # not yet tested
  104. - flutter_style_todos
  105. - hash_and_equals
  106. - implementation_imports
  107. # - invariant_booleans # too many false positives: https://github.com/dart-lang/linter/issues/811
  108. - iterable_contains_unrelated_type
  109. # - join_return_with_assignment # not yet tested
  110. - library_names
  111. - library_prefixes
  112. # - lines_longer_than_80_chars # not yet tested
  113. - list_remove_unrelated_type
  114. # - literal_only_boolean_expressions # too many false positives: https://github.com/dart-lang/sdk/issues/34181
  115. # - missing_whitespace_between_adjacent_strings # not yet tested
  116. - no_adjacent_strings_in_list
  117. - no_duplicate_case_values
  118. # - no_logic_in_create_state # not yet tested
  119. # - no_runtimeType_toString # not yet tested
  120. - non_constant_identifier_names
  121. # - null_closures # not yet tested
  122. # - omit_local_variable_types # opposite of always_specify_types
  123. # - one_member_abstracts # too many false positives
  124. # - only_throw_errors # https://github.com/flutter/flutter/issues/5792
  125. - overridden_fields
  126. - package_api_docs
  127. - package_names
  128. - package_prefixed_library_names
  129. # - parameter_assignments # we do this commonly
  130. - prefer_adjacent_string_concatenation
  131. - prefer_asserts_in_initializer_lists
  132. # - prefer_asserts_with_message # not yet tested
  133. - prefer_collection_literals
  134. - prefer_conditional_assignment
  135. - prefer_const_constructors
  136. - prefer_const_constructors_in_immutables
  137. - prefer_const_declarations
  138. - prefer_const_literals_to_create_immutables
  139. # - prefer_constructors_over_static_methods # not yet tested
  140. - prefer_contains
  141. # - prefer_double_quotes # opposite of prefer_single_quotes
  142. - prefer_equal_for_default_values
  143. # - prefer_expression_function_bodies # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#consider-using--for-short-functions-and-methods
  144. - prefer_final_fields
  145. - prefer_final_in_for_each
  146. - prefer_final_locals
  147. - prefer_for_elements_to_map_fromIterable
  148. - prefer_foreach
  149. # - prefer_function_declarations_over_variables # not yet tested
  150. - prefer_generic_function_type_aliases
  151. - prefer_if_elements_to_conditional_expressions
  152. - prefer_if_null_operators
  153. - prefer_initializing_formals
  154. - prefer_inlined_adds
  155. # - prefer_int_literals # not yet tested
  156. # - prefer_interpolation_to_compose_strings # not yet tested
  157. - prefer_is_empty
  158. - prefer_is_not_empty
  159. - prefer_is_not_operator
  160. - prefer_iterable_whereType
  161. # - prefer_mixin # https://github.com/dart-lang/language/issues/32
  162. # - prefer_null_aware_operators # disable until NNBD, see https://github.com/flutter/flutter/pull/32711#issuecomment-492930932
  163. # - prefer_relative_imports # not yet tested
  164. - prefer_single_quotes
  165. - prefer_spread_collections
  166. - prefer_typing_uninitialized_variables
  167. - prefer_void_to_null
  168. # - provide_deprecation_message # not yet tested
  169. # - public_member_api_docs # enabled on a case-by-case basis; see e.g. packages/analysis_options.yaml
  170. - recursive_getters
  171. - slash_for_doc_comments
  172. # - sort_child_properties_last # not yet tested
  173. - sort_constructors_first
  174. - sort_pub_dependencies
  175. - sort_unnamed_constructors_first
  176. - test_types_in_equals
  177. - throw_in_finally
  178. # - type_annotate_public_apis # subset of always_specify_types
  179. - type_init_formals
  180. # - unawaited_futures # too many false positives
  181. # - unnecessary_await_in_return # not yet tested
  182. - unnecessary_brace_in_string_interps
  183. - unnecessary_const
  184. # - unnecessary_final # conflicts with prefer_final_locals
  185. - unnecessary_getters_setters
  186. # - unnecessary_lambdas # has false positives: https://github.com/dart-lang/linter/issues/498
  187. - unnecessary_new
  188. - unnecessary_null_aware_assignments
  189. - unnecessary_null_in_if_null_operators
  190. - unnecessary_overrides
  191. - unnecessary_parenthesis
  192. - unnecessary_statements
  193. - unnecessary_string_interpolations
  194. - unnecessary_this
  195. - unrelated_type_equality_checks
  196. # - unsafe_html # not yet tested
  197. - use_full_hex_values_for_flutter_colors
  198. # - use_function_type_syntax_for_parameters # not yet tested
  199. # - use_key_in_widget_constructors # not yet tested
  200. - use_rethrow_when_possible
  201. # - use_setters_to_change_properties # not yet tested
  202. # - use_string_buffers # has false positives: https://github.com/dart-lang/sdk/issues/34182
  203. # - use_to_and_as_if_applicable # has false positives, so we prefer to catch this by code-review
  204. - valid_regexps
  205. - void_checks