analysis_options.yaml

# Updated according to
# https://dart-lang.github.io/linter/lints/index.html
# at 2020-08-10

include: package:pedantic/analysis_options.yaml

analyzer:

  strong-mode:
    implicit-casts: false
# TODO(zoechi) conflicts with some other rules and is subject to be reworked
# https://github.com/dart-lang/sdk/issues/33749
# but in general a useful setting to be enabled eventually
#    implicit-dynamic: false

#  language:
# TODO(zoechi) check if this is already available
# https://github.com/dart-lang/language/blob/master/resources/type-system/strict-raw-types.md
#    strict-raw-types: true

linter:
  rules:
    ## Error Rules

    # personal preference this conflicts with prefer_relative_imports
    # - always_use_package_imports
    - avoid_empty_else
    - avoid_print
    - avoid_relative_lib_imports
    - avoid_returning_null_for_future
    - avoid_slow_async_io
    # - avoid_type_to_string # not yet available
    - avoid_types_as_parameter_names
    - avoid_web_libraries_in_flutter
    # subject to false positives, perhaps worth suppressing in code in such cases
    - cancel_subscriptions
    # subject to false positives, perhaps worth suppressing in code in such cases
    - close_sinks
    - comment_references
    - control_flow_in_finally
    # This seems to be a lint for debugging widgets, not applicable to this plugin
    # - diagnostic_describe_all_properties
    - empty_statements
    - hash_and_equals
    - invariant_booleans
    - iterable_contains_unrelated_type
    - list_remove_unrelated_type
    - literal_only_boolean_expressions
    - no_adjacent_strings_in_list
    - no_duplicate_case_values
    - no_logic_in_create_state
    - prefer_relative_imports # personal preference
    - prefer_void_to_null
    - test_types_in_equals
    - throw_in_finally
    - unnecessary_statements
    - unrelated_type_equality_checks
    # - unsafe_html # not applicable to this plugin
    # - use_key_in_widget_constructors # not applicable to this plugin
    - valid_regexps

    ## Style Rules

    - always_declare_return_types
    # - always_put_control_body_on_new_line # works against dartfmt
    - always_put_required_named_parameters_first
    - always_require_non_null_named_parameters
    # - always_specify_types        # this works against general Dart style guides
    - annotate_overrides
    - avoid_annotating_with_dynamic
    # - avoid_as # obsolete - this was considered good practice in Dart 1
    - avoid_bool_literals_in_conditional_expressions
    - avoid_catches_without_on_clauses
    - avoid_catching_errors
    # Annoying rule when using classes as namespaces for constants which is discouraged by the Dart
    # style guide, but I prefer it over aliases in imports for disambiguation.
    # - avoid_classes_with_only_static_members
    - avoid_double_and_int_checks
    - avoid_equals_and_hash_code_on_mutable_classes
    - avoid_escaping_inner_quotes
    - avoid_field_initializers_in_const_classes
    - avoid_function_literals_in_foreach_calls
    - avoid_implementing_value_types
    - avoid_init_to_null
    - avoid_js_rounded_ints
    - avoid_null_checks_in_equality_operators
    - avoid_positional_boolean_parameters
    # - avoid_private_typedef_functions # There arent't strong arguments for this
    - avoid_redundant_argument_values
    - avoid_renaming_method_parameters
    - avoid_return_types_on_setters
    - avoid_returning_null
    - avoid_returning_null_for_void
    - avoid_returning_this
    - avoid_setters_without_getters
    - avoid_shadowing_type_parameters
    - avoid_single_cascade_in_expression_statements
    - avoid_types_on_closure_parameters
    # - avoid_unnecessary_containers # not applicable to this plugin
    # This is annoying as it shows hints to remove arguments from un-implemented spec
    # Can be enabled once the spec is completely implemented
    # - avoid_unused_constructor_parameters
    - avoid_void_async
    - await_only_futures
    - camel_case_extensions
    - camel_case_types
    - cascade_invocations
    # - cast_nullable_to_non_nullable # experimental, not yet available
    - constant_identifier_names
    - curly_braces_in_flow_control_structures
    - directives_ordering
    - do_not_use_environment
    - empty_catches
    - empty_constructor_bodies
    - exhaustive_cases
    - file_names
    # - flutter_style_todos # Not sure this is desired
    - implementation_imports
    - join_return_with_assignment
    - leading_newlines_in_multiline_strings
    - library_names
    - library_prefixes
    - lines_longer_than_80_chars
    - missing_whitespace_between_adjacent_strings
    - no_default_cases             # experimental
    - no_runtimeType_toString
    - non_constant_identifier_names
    # - null_check_on_nullable_type_parameter # experimental, not yet available
    - null_closures
    - omit_local_variable_types
    # - one_member_abstracts # Up for discussion
    - only_throw_errors
    - overridden_fields
    - package_api_docs
    - package_prefixed_library_names
    - parameter_assignments        # personal preference
    - prefer_adjacent_string_concatenation
    - prefer_asserts_in_initializer_lists
    # - prefer_asserts_with_message # personal preference
    - prefer_collection_literals
    - prefer_conditional_assignment
    - prefer_const_constructors
    - prefer_const_constructors_in_immutables
    - prefer_const_declarations
    - prefer_const_literals_to_create_immutables
    - prefer_constructors_over_static_methods
    - prefer_contains
    # - prefer_double_quotes # We prefer single quotes
    - prefer_equal_for_default_values
    - prefer_expression_function_bodies
    - prefer_final_fields          # personal preference
    - prefer_final_in_for_each     # personal preference
    - prefer_final_locals          # personal preference
    - prefer_for_elements_to_map_fromIterable
    - prefer_foreach
    - prefer_function_declarations_over_variables
    - prefer_generic_function_type_aliases
    - prefer_if_elements_to_conditional_expressions
    - prefer_if_null_operators
    - prefer_initializing_formals
    - prefer_inlined_adds
    - prefer_int_literals
    - prefer_interpolation_to_compose_strings
    - prefer_is_empty
    - prefer_is_not_empty
    - prefer_is_not_operator
    - prefer_iterable_whereType
    - prefer_mixin
    - prefer_null_aware_operators
    - prefer_single_quotes
    - prefer_spread_collections
    - prefer_typing_uninitialized_variables
    - provide_deprecation_message
    # - public_member_api_docs      # personal preference
    - recursive_getters
    - sized_box_for_whitespace
    - slash_for_doc_comments
    - sort_child_properties_last
    # - sort_constructors_first           # personal preference
    # - sort_unnamed_constructors_first   # personal preference
    # - super_goes_last # deprecated
    # - tighten_type_of_initializing_formals # not yet available
    - type_annotate_public_apis
    - type_init_formals
    - unawaited_futures
    - unnecessary_await_in_return
    - unnecessary_brace_in_string_interps
    - unnecessary_const
    # - unnecessary_final # conflicts with prefer_final_locals
    - unnecessary_getters_setters
    - unnecessary_lambdas
    - unnecessary_new
    - unnecessary_null_aware_assignments
    # - unnecessary_null_checks # experimental, not yet available
    - unnecessary_null_in_if_null_operators
    - unnecessary_nullable_for_final_variable_declarations # experimental
    - unnecessary_overrides
    - unnecessary_parenthesis
    - unnecessary_raw_strings
    - unnecessary_string_escapes
    - unnecessary_string_interpolations
    - unnecessary_this
    - use_full_hex_values_for_flutter_colors
    - use_function_type_syntax_for_parameters
    - use_is_even_rather_than_modulo
    - use_late_for_private_fields_and_variables # experimental
    - use_raw_strings
    - use_rethrow_when_possible
    - use_setters_to_change_properties
    - use_string_buffers
    - use_to_and_as_if_applicable
    - void_checks

    ## Pub Rules
    - package_names
    - sort_pub_dependencies