2019-01-11 21:38:02 +00:00
# Specify analysis options.
#
# Until there are meta linter rules, each desired lint must be explicitly enabled.
# See: https://github.com/dart-lang/linter/issues/288
#
# For a list of lints, see: http://dart-lang.github.io/linter/lints/
# See the configuration guide for more
2021-09-10 22:42:03 +00:00
# https://github.com/dart-lang/sdk/tree/main/pkg/analyzer#configuring-the-analyzer
2019-01-11 21:38:02 +00:00
#
# 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
2021-05-11 06:44:02 +00:00
# - https://github.com/flutter/packages/blob/master/analysis_options.yaml
2019-01-11 21:38:02 +00:00
#
# This file contains the analysis options used by Flutter tools, such as IntelliJ,
# Android Studio, and the `flutter analyze` command.
2016-05-04 17:15:15 +00:00
analyzer :
2019-01-11 21:38:02 +00:00
strong-mode :
2019-12-19 10:23:01 +00:00
implicit-casts : false
2019-01-11 21:38:02 +00:00
implicit-dynamic : false
2016-05-04 17:15:15 +00:00
errors :
2019-01-11 21:38:02 +00:00
# treat missing required parameters as a warning (not a hint)
missing_required_param : warning
# treat missing returns as a warning (not a hint)
missing_return : warning
2021-10-06 07:10:37 +00:00
# allow having TODO/HACK comments in the code
2019-01-11 21:38:02 +00:00
todo : ignore
2021-10-06 07:10:37 +00:00
hack : ignore
2020-06-19 19:03:38 +00:00
# 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
2021-09-14 22:32:02 +00:00
# TODO(https://github.com/flutter/flutter/issues/74381):
# Clean up existing unnecessary imports, and remove line to ignore.
unnecessary_import : ignore
2021-03-03 05:14:03 +00:00
# Turned off until null-safe rollout is complete.
unnecessary_null_comparison : ignore
2016-08-19 02:11:39 +00:00
exclude :
2019-06-27 19:23:16 +00:00
- "bin/cache/**"
2021-04-19 22:04:04 +00:00
# Ignore protoc generated files
2021-05-25 23:12:53 +00:00
- "dev/conductor/lib/proto/*"
2019-01-11 21:38:02 +00:00
linter :
rules :
# these rules are documented on and in the same order as
# the Dart Lint rules page to make maintenance easier
# 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
2020-10-15 22:37:04 +00:00
# - always_use_package_imports # we do this commonly
2019-01-11 21:38:02 +00:00
- annotate_overrides
# - avoid_annotating_with_dynamic # conflicts with always_specify_types
2019-06-25 15:40:05 +00:00
- avoid_bool_literals_in_conditional_expressions
2019-01-11 21:38:02 +00:00
# - avoid_catches_without_on_clauses # we do this commonly
# - avoid_catching_errors # we do this commonly
- avoid_classes_with_only_static_members
# - avoid_double_and_int_checks # only useful when targeting JS runtime
2021-06-14 21:16:57 +00:00
- avoid_dynamic_calls
2019-01-11 21:38:02 +00:00
- avoid_empty_else
2020-04-06 20:36:01 +00:00
- avoid_equals_and_hash_code_on_mutable_classes
2021-05-19 16:54:02 +00:00
- avoid_escaping_inner_quotes
2019-01-11 21:38:02 +00:00
- avoid_field_initializers_in_const_classes
- avoid_function_literals_in_foreach_calls
2021-10-04 20:48:04 +00:00
- avoid_implementing_value_types
2019-01-11 21:38:02 +00:00
- avoid_init_to_null
# - avoid_js_rounded_ints # only useful when targeting JS runtime
- avoid_null_checks_in_equality_operators
2021-10-07 23:48:04 +00:00
# - avoid_positional_boolean_parameters # would have been nice to enable this but by now there's too many places that break it
- avoid_print
2019-01-11 21:38:02 +00:00
# - avoid_private_typedef_functions # we prefer having typedef (discussion in https://github.com/flutter/flutter/pull/16356)
2021-10-08 04:11:07 +00:00
# - avoid_redundant_argument_values # not yet tested
2019-01-11 21:38:02 +00:00
- avoid_relative_lib_imports
- avoid_renaming_method_parameters
- avoid_return_types_on_setters
2021-10-01 07:58:05 +00:00
# - avoid_returning_null # still violated by some pre-nnbd code that we haven't yet migrated
- avoid_returning_null_for_future
2019-01-11 21:38:02 +00:00
- avoid_returning_null_for_void
# - avoid_returning_this # there are plenty of valid reasons to return this
2021-10-01 07:58:05 +00:00
- avoid_setters_without_getters
2020-11-16 19:07:37 +00:00
- avoid_shadowing_type_parameters
2020-03-05 07:03:26 +00:00
- avoid_single_cascade_in_expression_statements
2019-01-11 21:38:02 +00:00
- avoid_slow_async_io
2021-03-01 23:50:04 +00:00
- avoid_type_to_string
2019-01-11 21:38:02 +00:00
- avoid_types_as_parameter_names
# - avoid_types_on_closure_parameters # conflicts with always_specify_types
2021-03-04 23:29:03 +00:00
- avoid_unnecessary_containers
2019-01-11 21:38:02 +00:00
- avoid_unused_constructor_parameters
- avoid_void_async
2019-12-23 17:40:56 +00:00
# - avoid_web_libraries_in_flutter # not yet tested
2019-01-11 21:38:02 +00:00
- await_only_futures
2019-12-23 17:40:56 +00:00
- camel_case_extensions
2019-01-11 21:38:02 +00:00
- camel_case_types
- cancel_subscriptions
# - cascade_invocations # not yet tested
2020-10-08 19:05:43 +00:00
- cast_nullable_to_non_nullable
2019-01-11 21:38:02 +00:00
# - close_sinks # not reliable enough
2021-03-02 16:34:03 +00:00
# - comment_references # blocked on https://github.com/dart-lang/linter/issues/1142
2019-01-11 21:38:02 +00:00
# - constant_identifier_names # needs an opt-out https://github.com/dart-lang/linter/issues/204
- control_flow_in_finally
2020-11-16 19:07:37 +00:00
# - curly_braces_in_flow_control_structures # not required by flutter style
2021-03-08 20:49:03 +00:00
- deprecated_consistency
2019-06-25 13:59:15 +00:00
# - diagnostic_describe_all_properties # not yet tested
2021-05-01 00:29:04 +00:00
- directives_ordering
2020-10-15 22:37:04 +00:00
# - do_not_use_environment # we do this commonly
2019-01-11 21:38:02 +00:00
- empty_catches
- empty_constructor_bodies
- empty_statements
2020-10-15 22:37:04 +00:00
- exhaustive_cases
2021-03-02 23:24:04 +00:00
- file_names
2019-01-11 21:38:02 +00:00
- flutter_style_todos
- hash_and_equals
- implementation_imports
# - invariant_booleans # too many false positives: https://github.com/dart-lang/linter/issues/811
- iterable_contains_unrelated_type
2020-11-16 19:07:37 +00:00
# - join_return_with_assignment # not required by flutter style
2020-10-15 22:37:04 +00:00
- leading_newlines_in_multiline_strings
2019-01-11 21:38:02 +00:00
- library_names
- library_prefixes
2021-05-10 23:26:16 +00:00
- library_private_types_in_public_api
2020-11-16 19:07:37 +00:00
# - lines_longer_than_80_chars # not required by flutter style
2019-01-11 21:38:02 +00:00
- list_remove_unrelated_type
# - literal_only_boolean_expressions # too many false positives: https://github.com/dart-lang/sdk/issues/34181
2021-03-02 02:30:17 +00:00
- missing_whitespace_between_adjacent_strings
2019-01-11 21:38:02 +00:00
- no_adjacent_strings_in_list
2020-10-15 22:37:04 +00:00
# - no_default_cases # too many false positives
2019-01-11 21:38:02 +00:00
- no_duplicate_case_values
2020-11-16 19:07:37 +00:00
- no_logic_in_create_state
# - no_runtimeType_toString # ok in tests; we enable this only in packages/
2021-06-04 00:34:10 +00:00
- noop_primitive_operations
2019-01-11 21:38:02 +00:00
- non_constant_identifier_names
2020-10-08 07:39:13 +00:00
- null_check_on_nullable_type_parameter
2021-03-02 23:25:31 +00:00
- null_closures
2019-01-11 21:38:02 +00:00
# - omit_local_variable_types # opposite of always_specify_types
# - one_member_abstracts # too many false positives
# - only_throw_errors # https://github.com/flutter/flutter/issues/5792
- overridden_fields
- package_api_docs
2021-03-02 23:24:04 +00:00
- package_names
2019-01-11 21:38:02 +00:00
- package_prefixed_library_names
# - parameter_assignments # we do this commonly
- prefer_adjacent_string_concatenation
- prefer_asserts_in_initializer_lists
2020-11-16 19:07:37 +00:00
# - prefer_asserts_with_message # not required by flutter style
2019-03-06 19:05:16 +00:00
- prefer_collection_literals
2019-01-11 21:38:02 +00:00
- prefer_conditional_assignment
2019-04-29 23:02:42 +00:00
- prefer_const_constructors
2019-01-11 21:38:02 +00:00
- prefer_const_constructors_in_immutables
- prefer_const_declarations
- prefer_const_literals_to_create_immutables
2020-11-16 19:07:37 +00:00
# - prefer_constructors_over_static_methods # far too many false positives
2019-01-11 21:38:02 +00:00
- prefer_contains
2019-06-25 13:59:15 +00:00
# - prefer_double_quotes # opposite of prefer_single_quotes
2019-01-11 21:38:02 +00:00
- 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
2020-01-07 15:32:04 +00:00
- prefer_final_in_for_each
2019-01-11 21:38:02 +00:00
- prefer_final_locals
2020-01-08 16:03:02 +00:00
- prefer_for_elements_to_map_fromIterable
2019-01-11 21:38:02 +00:00
- prefer_foreach
2021-03-06 02:29:04 +00:00
- prefer_function_declarations_over_variables
2019-01-11 21:38:02 +00:00
- prefer_generic_function_type_aliases
2019-09-17 14:23:44 +00:00
- prefer_if_elements_to_conditional_expressions
2019-07-09 08:53:35 +00:00
- prefer_if_null_operators
2019-01-11 21:38:02 +00:00
- prefer_initializing_formals
2019-06-27 19:23:16 +00:00
- prefer_inlined_adds
2021-03-02 18:14:02 +00:00
# - prefer_int_literals # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#use-double-literals-for-double-constants
2021-06-01 18:14:06 +00:00
- prefer_interpolation_to_compose_strings
2019-01-11 21:38:02 +00:00
- prefer_is_empty
2019-05-20 15:00:45 +00:00
- prefer_is_not_empty
2019-12-23 17:40:56 +00:00
- prefer_is_not_operator
2019-01-11 21:38:02 +00:00
- prefer_iterable_whereType
# - prefer_mixin # https://github.com/dart-lang/language/issues/32
2021-03-03 00:14:03 +00:00
- prefer_null_aware_operators
2021-03-06 02:38:15 +00:00
# - prefer_relative_imports # incompatible with sub-package imports
2019-01-11 21:38:02 +00:00
- prefer_single_quotes
2019-06-27 19:23:16 +00:00
- prefer_spread_collections
2019-01-11 21:38:02 +00:00
- prefer_typing_uninitialized_variables
- prefer_void_to_null
2021-03-03 00:34:05 +00:00
- provide_deprecation_message
2019-01-11 21:38:02 +00:00
# - public_member_api_docs # enabled on a case-by-case basis; see e.g. packages/analysis_options.yaml
- recursive_getters
2021-03-04 01:29:02 +00:00
- sized_box_for_whitespace
2019-01-11 21:38:02 +00:00
- slash_for_doc_comments
2019-06-25 13:59:15 +00:00
# - sort_child_properties_last # not yet tested
2019-01-11 21:38:02 +00:00
- sort_constructors_first
2020-09-24 04:37:08 +00:00
# - sort_pub_dependencies # prevents separating pinned transitive dependencies
2019-01-11 21:38:02 +00:00
- sort_unnamed_constructors_first
- test_types_in_equals
- throw_in_finally
2020-10-08 07:39:13 +00:00
- tighten_type_of_initializing_formals
2019-01-11 21:38:02 +00:00
# - type_annotate_public_apis # subset of always_specify_types
- type_init_formals
# - unawaited_futures # too many false positives
2021-03-06 02:38:15 +00:00
- unnecessary_await_in_return
2019-01-11 21:38:02 +00:00
- unnecessary_brace_in_string_interps
- unnecessary_const
2019-12-23 17:40:56 +00:00
# - unnecessary_final # conflicts with prefer_final_locals
2019-01-11 21:38:02 +00:00
- unnecessary_getters_setters
# - unnecessary_lambdas # has false positives: https://github.com/dart-lang/linter/issues/498
- unnecessary_new
- unnecessary_null_aware_assignments
2021-05-14 17:44:03 +00:00
- unnecessary_null_checks
2019-01-11 21:38:02 +00:00
- unnecessary_null_in_if_null_operators
2020-09-23 04:39:47 +00:00
- unnecessary_nullable_for_final_variable_declarations
2019-01-11 21:38:02 +00:00
- unnecessary_overrides
- unnecessary_parenthesis
2020-10-15 22:37:04 +00:00
# - unnecessary_raw_strings # not yet tested
2019-01-11 21:38:02 +00:00
- unnecessary_statements
2020-10-26 19:42:05 +00:00
- unnecessary_string_escapes
2020-02-14 08:43:52 +00:00
- unnecessary_string_interpolations
2019-01-11 21:38:02 +00:00
- unnecessary_this
- unrelated_type_equality_checks
2019-06-25 13:59:15 +00:00
# - unsafe_html # not yet tested
2019-06-25 15:58:19 +00:00
- use_full_hex_values_for_flutter_colors
2021-03-04 16:59:17 +00:00
- use_function_type_syntax_for_parameters
2021-03-02 16:34:03 +00:00
# - use_if_null_to_convert_nulls_to_bools # not yet tested
2020-10-16 18:20:00 +00:00
- use_is_even_rather_than_modulo
2021-03-02 18:14:02 +00:00
- use_key_in_widget_constructors
2020-08-27 23:38:10 +00:00
- use_late_for_private_fields_and_variables
2021-05-13 20:29:06 +00:00
- use_named_constants
2020-10-26 19:42:05 +00:00
- use_raw_strings
2019-01-11 21:38:02 +00:00
- use_rethrow_when_possible
# - use_setters_to_change_properties # not yet tested
# - use_string_buffers # has false positives: https://github.com/dart-lang/sdk/issues/34182
2021-06-04 05:14:03 +00:00
- use_test_throws_matchers
2019-01-11 21:38:02 +00:00
# - use_to_and_as_if_applicable # has false positives, so we prefer to catch this by code-review
- valid_regexps
2020-01-13 18:03:01 +00:00
- void_checks