analysis_options.yaml

include: package:lint/analysis_options.yaml

analyzer:
  strong-mode:
    implicit-casts: true
    implicit-dynamic: true
  errors:
    avoid_print: ignore
    # 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
    # allow having TODOs in the code
    todo: ignore
    # 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
    # Ignore analyzer hints for updating pubspecs when using Future or
    # Stream and not importing dart:async
    # Please see https://github.com/flutter/flutter/pull/24528 for details.
    # sdk_version_async_exported_from_core: ignore
  exclude:
    - flutter/** # Do not analyze the Flutter repository in the CI environment

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: true
    always_put_control_body_on_new_line: true
    use_string_buffers: false
    # - always_put_required_named_parameters_first # we prefer having parameters in the same order as fields https://github.com/flutter/flutter/issues/10219
    always_specify_types: false
    always_use_package_imports: true
    annotate_overrides: true
    # - avoid_annotating_with_dynamic # conflicts with always_specify_types
    avoid_bool_literals_in_conditional_expressions: true
    # - avoid_catches_without_on_clauses # we do this commonly
    # - avoid_catching_errors # we do this commonly
    avoid_classes_with_only_static_members: false # <---Routes and AppColors classes are exceptions
    # - avoid_double_and_int_checks # only useful when targeting JS runtime
    avoid_dynamic_calls: false # <--this is a good one to check in future
    avoid_empty_else: true
    avoid_equals_and_hash_code_on_mutable_classes: true
    avoid_escaping_inner_quotes: true
    avoid_field_initializers_in_const_classes: false
    avoid_function_literals_in_foreach_calls: true
    # - avoid_implementing_value_types # not yet tested
    avoid_init_to_null: true
    # - avoid_js_rounded_ints # only useful when targeting JS runtime
    avoid_null_checks_in_equality_operators: true
    avoid_positional_boolean_parameters: false
    # - avoid_private_typedef_functions # we prefer having typedef (discussion in https://github.com/flutter/flutter/pull/16356)
    avoid_redundant_argument_values: true
    avoid_relative_lib_imports: true
    avoid_renaming_method_parameters: true
    avoid_return_types_on_setters: true
    # - avoid_returning_null # there are plenty of valid reasons to return null
    # - avoid_returning_null_for_future # not yet tested
    avoid_returning_null_for_void: true
    # - avoid_returning_this # there are plenty of valid reasons to return this
    avoid_setters_without_getters: true
    avoid_shadowing_type_parameters: true
    avoid_single_cascade_in_expression_statements: true
    avoid_slow_async_io: true
    avoid_type_to_string: true
    avoid_types_as_parameter_names: true
    # - avoid_types_on_closure_parameters # conflicts with always_specify_types
    avoid_unnecessary_containers: true
    avoid_unused_constructor_parameters: true
    avoid_void_async: true
    # - avoid_web_libraries_in_flutter # not yet tested
    await_only_futures: true
    camel_case_extensions: true
    camel_case_types: true
    cancel_subscriptions: true
    # - cascade_invocations # not yet tested
    cast_nullable_to_non_nullable: true
    # - close_sinks # not reliable enough
    # - comment_references # blocked on https://github.com/flutter/flutter/issues/20765
    constant_identifier_names: true
    control_flow_in_finally: true
    # - curly_braces_in_flow_control_structures # not required by flutter style
    depend_on_referenced_packages: false
    # - diagnostic_describe_all_properties # not yet tested
    directives_ordering: true
    # - do_not_use_environment # we do this commonly
    empty_catches: true
    empty_constructor_bodies: true
    empty_statements: true
    exhaustive_cases: true
    file_names: false
    flutter_style_todos: true
    hash_and_equals: true
    implementation_imports: true
    # - invariant_booleans # too many false positives: https://github.com/dart-lang/linter/issues/811
    # - join_return_with_assignment # not required by flutter style
    leading_newlines_in_multiline_strings: true
    library_names: true
    library_prefixes: true
    # - literal_only_boolean_expressions # too many false positives: https://github.com/dart-lang/sdk/issues/34181
    missing_whitespace_between_adjacent_strings: true
    no_adjacent_strings_in_list: true
    # - no_default_cases # too many false positives
    no_duplicate_case_values: true
    no_logic_in_create_state: true
    # - no_runtimeType_toString # ok in tests; we enable this only in packages/
    non_constant_identifier_names: true
    null_check_on_nullable_type_parameter: true
    # - null_closures # not required by flutter style
    omit_local_variable_types: false
    # - one_member_abstracts # too many false positives
    # - only_throw_errors # https://github.com/flutter/flutter/issues/5792
    overridden_fields: true
    package_api_docs: true
    package_names: true
    package_prefixed_library_names: true
    # - parameter_assignments # we do this commonly
    prefer_adjacent_string_concatenation: true
    prefer_asserts_in_initializer_lists: true
    # - prefer_asserts_with_message # not required by flutter style
    prefer_collection_literals: true
    prefer_conditional_assignment: true
    prefer_const_constructors: true
    prefer_const_constructors_in_immutables: true
    prefer_const_declarations: false
    prefer_const_literals_to_create_immutables: false
    prefer_constructors_over_static_methods: true
    prefer_contains: true
    # - prefer_double_quotes # opposite of prefer_single_quotes
    # - 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: true
    prefer_final_in_for_each: true
    prefer_final_locals: true
    prefer_for_elements_to_map_fromIterable: true
    prefer_foreach: true
    prefer_function_declarations_over_variables: true
    prefer_generic_function_type_aliases: true
    prefer_if_elements_to_conditional_expressions: true
    prefer_if_null_operators: true
    prefer_initializing_formals: true
    prefer_inlined_adds: true
    # - prefer_int_literals # not yet tested
    prefer_interpolation_to_compose_strings: true
    prefer_is_empty: true
    prefer_is_not_empty: true
    prefer_is_not_operator: true
    prefer_iterable_whereType: true
    # - prefer_mixin # https://github.com/dart-lang/language/issues/32
    prefer_null_aware_operators: true
    # - prefer_relative_imports # not yet tested
    prefer_single_quotes: false
    prefer_spread_collections: true
    prefer_typing_uninitialized_variables: true
    prefer_void_to_null: true
    provide_deprecation_message: true
    # - public_member_api_docs # enabled on a case-by-case basis; see e.g. packages/analysis_options.yaml
    recursive_getters: true
    require_trailing_commas: false
    sized_box_for_whitespace: false
    slash_for_doc_comments: true
    sort_child_properties_last: true
    sort_constructors_first: false
    sort_pub_dependencies: false
    sort_unnamed_constructors_first: true
    test_types_in_equals: true
    throw_in_finally: true
    tighten_type_of_initializing_formals: true
    # - type_annotate_public_apis # subset of always_specify_types
    type_init_formals: true
    unawaited_futures: true
    unnecessary_await_in_return: true
    unnecessary_brace_in_string_interps: true
    unnecessary_const: true
    # - unnecessary_final # conflicts with prefer_final_locals
    unnecessary_getters_setters: true
    # - unnecessary_lambdas # has false positives: https://github.com/dart-lang/linter/issues/498
    unnecessary_new: true
    unnecessary_null_aware_assignments: true
    unnecessary_null_checks: true
    unnecessary_null_in_if_null_operators: true
    unnecessary_nullable_for_final_variable_declarations: true
    unnecessary_overrides: true
    unnecessary_parenthesis: true
    # - unnecessary_raw_strings # not yet tested
    unnecessary_statements: true
    unnecessary_string_escapes: true
    unnecessary_string_interpolations: true
    unnecessary_this: true
    unrelated_type_equality_checks: true
    # - unsafe_html # not yet tested
    use_full_hex_values_for_flutter_colors: true
    use_function_type_syntax_for_parameters: true
    use_is_even_rather_than_modulo: true
    use_key_in_widget_constructors: true
    use_late_for_private_fields_and_variables: true
    use_raw_strings: true
    use_rethrow_when_possible: true
    # - use_setters_to_change_properties # not yet tested
    # - use_string_buffers # has false positives: https://github.com/dart-lang/sdk/issues/34182
    use_test_throws_matchers: true
    # - use_to_and_as_if_applicable # has false positives, so we prefer to catch this by code-review
    valid_regexps: true
    void_checks: true