mirror of
https://github.com/flutter/flutter.git
synced 2026-01-09 07:51:35 +08:00
9d96df2364
WIP Commits separated as follows: - Update lints in analysis_options files - Run `dart fix --apply` - Clean up leftover analysis issues - Run `dart format .` in the right places. Local analysis and testing passes. Checking CI now. Part of https://github.com/flutter/flutter/issues/178827 - Adoption of flutter_lints in examples/api coming in a separate change (cc @loic-sharma) ## Pre-launch Checklist - [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [ ] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [ ] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [ ] I signed the [CLA]. - [ ] I listed at least one issue that this PR fixes in the description above. - [ ] I updated/added relevant documentation (doc comments with `///`). - [ ] I added new tests to check the change I am making, or this PR is [test-exempt]. - [ ] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [ ] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. **Note**: The Flutter team is currently trialing the use of [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from the `gemini-code-assist` bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed. <!-- Links --> [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
271 lines
12 KiB
YAML
271 lines
12 KiB
YAML
# Specify analysis options.
|
|
#
|
|
# For a list of lints, see: https://dart.dev/tools/linter-rules
|
|
# For guidelines on configuring static analysis, see:
|
|
# https://dart.dev/tools/analysis
|
|
#
|
|
# 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/packages/blob/main/analysis_options.yaml
|
|
#
|
|
# This file contains the analysis options used for code in the flutter/flutter
|
|
# repository.
|
|
|
|
analyzer:
|
|
language:
|
|
strict-casts: true
|
|
strict-inference: true
|
|
strict-raw-types: true
|
|
errors:
|
|
# allow deprecated members (we do this because otherwise we have to annotate
|
|
# every member in every test, assert, etc, when we or the Dart SDK deprecates
|
|
# something (https://github.com/flutter/flutter/issues/143312)
|
|
deprecated_member_use: ignore
|
|
deprecated_member_use_from_same_package: ignore
|
|
exclude:
|
|
- "bin/cache/**"
|
|
# Ignore protoc generated files
|
|
- "dev/conductor/lib/proto/*"
|
|
- "engine/**"
|
|
|
|
formatter:
|
|
page_width: 100
|
|
|
|
linter:
|
|
rules:
|
|
# This list is derived from the list of all available lints located at
|
|
# https://github.com/dart-lang/sdk/blob/main/pkg/linter/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_specify_types # conflicts with omit_obvious_local_variable_types
|
|
# - always_use_package_imports # we do this commonly
|
|
- annotate_overrides
|
|
- annotate_redeclares
|
|
# - avoid_annotating_with_dynamic # conflicts with type_annotate_public_apis
|
|
- avoid_bool_literals_in_conditional_expressions
|
|
# - avoid_catches_without_on_clauses # blocked on https://github.com/dart-lang/linter/issues/3023
|
|
# - avoid_catching_errors # blocked on https://github.com/dart-lang/linter/issues/4998
|
|
# - avoid_classes_with_only_static_members # we do this commonly for `abstract final class`es
|
|
- avoid_double_and_int_checks
|
|
- avoid_dynamic_calls
|
|
- avoid_empty_else
|
|
- avoid_equals_and_hash_code_on_mutable_classes
|
|
- avoid_escaping_inner_quotes
|
|
- avoid_field_initializers_in_const_classes
|
|
# - avoid_final_parameters # incompatible with prefer_final_parameters
|
|
- avoid_function_literals_in_foreach_calls
|
|
# - avoid_futureor_void # not yet tested
|
|
# - avoid_implementing_value_types # see https://github.com/dart-lang/linter/issues/4558
|
|
- avoid_init_to_null
|
|
- avoid_js_rounded_ints
|
|
# - avoid_multiple_declarations_per_line # seems to be a stylistic choice we don't subscribe to
|
|
- avoid_null_checks_in_equality_operators
|
|
# - avoid_positional_boolean_parameters # would have been nice to enable this but by now there's too many places that break it
|
|
- avoid_print
|
|
# - avoid_private_typedef_functions # we prefer having typedef (discussion in https://github.com/flutter/flutter/pull/16356)
|
|
- avoid_redundant_argument_values
|
|
- avoid_relative_lib_imports
|
|
- avoid_renaming_method_parameters
|
|
- avoid_return_types_on_setters
|
|
- avoid_returning_null_for_void
|
|
# - avoid_returning_this # there are enough valid reasons to return `this` that this lint ends up with too many false positives
|
|
- avoid_setters_without_getters
|
|
- avoid_shadowing_type_parameters
|
|
- avoid_single_cascade_in_expression_statements
|
|
- avoid_slow_async_io
|
|
- avoid_type_to_string
|
|
- avoid_types_as_parameter_names
|
|
# - avoid_types_on_closure_parameters # not yet tested
|
|
- avoid_unnecessary_containers
|
|
- avoid_unused_constructor_parameters
|
|
- avoid_void_async
|
|
# - avoid_web_libraries_in_flutter # we use web libraries in web-specific code, and our tests prevent us from using them elsewhere
|
|
- await_only_futures
|
|
- camel_case_extensions
|
|
- camel_case_types
|
|
- cancel_subscriptions
|
|
# - cascade_invocations # doesn't match the typical style of this repo
|
|
- cast_nullable_to_non_nullable
|
|
# - close_sinks # not reliable enough
|
|
- collection_methods_unrelated_type
|
|
- combinators_ordering
|
|
# - comment_references # blocked on https://github.com/dart-lang/linter/issues/1142
|
|
- conditional_uri_does_not_exist
|
|
# - constant_identifier_names # needs an opt-out https://github.com/dart-lang/linter/issues/204
|
|
- control_flow_in_finally
|
|
- curly_braces_in_flow_control_structures
|
|
- dangling_library_doc_comments
|
|
- depend_on_referenced_packages
|
|
- deprecated_consistency
|
|
# - deprecated_member_use_from_same_package # we allow self-references to deprecated members
|
|
# - diagnostic_describe_all_properties # enabled only at the framework level (packages/flutter/lib)
|
|
- directives_ordering
|
|
# - discarded_futures # too many false positives, similar to unawaited_futures
|
|
# - do_not_use_environment # there are appropriate times to use the environment, especially in our tests and build logic
|
|
# - document_ignores # not yet tested
|
|
- empty_catches
|
|
- empty_constructor_bodies
|
|
- empty_statements
|
|
- eol_at_end_of_file
|
|
- exhaustive_cases
|
|
- file_names
|
|
- flutter_style_todos
|
|
- hash_and_equals
|
|
- implementation_imports
|
|
- implicit_call_tearoffs
|
|
- implicit_reopen
|
|
- invalid_case_patterns
|
|
- invalid_runtime_check_with_js_interop_types
|
|
# - join_return_with_assignment # not required by flutter style
|
|
- leading_newlines_in_multiline_strings
|
|
- library_annotations
|
|
- library_names
|
|
- library_prefixes
|
|
- library_private_types_in_public_api
|
|
# - lines_longer_than_80_chars # not required by flutter style
|
|
- literal_only_boolean_expressions
|
|
# - matching_super_parameters # blocked on https://github.com/dart-lang/language/issues/2509
|
|
- missing_code_block_language_in_doc_comment
|
|
- missing_whitespace_between_adjacent_strings
|
|
- no_adjacent_strings_in_list
|
|
- no_default_cases
|
|
- no_duplicate_case_values
|
|
- no_leading_underscores_for_library_prefixes
|
|
- no_leading_underscores_for_local_identifiers
|
|
- no_literal_bool_comparisons
|
|
- no_logic_in_create_state
|
|
# - no_runtimeType_toString # ok in tests; we enable this only in packages/
|
|
- no_self_assignments
|
|
- no_wildcard_variable_uses
|
|
- non_constant_identifier_names
|
|
- noop_primitive_operations
|
|
- null_check_on_nullable_type_parameter
|
|
- null_closures
|
|
# - omit_local_variable_types # superset of omit_obvious_local_variable_types
|
|
- omit_obvious_local_variable_types # not yet tested
|
|
# - omit_obvious_property_types # conflicts with type_annotate_public_apis
|
|
# - one_member_abstracts # too many false positives
|
|
- only_throw_errors # this does get disabled in a few places where we have legacy code that uses strings et al
|
|
- overridden_fields
|
|
- package_names
|
|
- package_prefixed_library_names
|
|
# - parameter_assignments # we do this commonly
|
|
- prefer_adjacent_string_concatenation
|
|
- prefer_asserts_in_initializer_lists
|
|
# - prefer_asserts_with_message # not required by flutter style
|
|
- 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 # far too many false positives
|
|
- prefer_contains
|
|
# - prefer_double_quotes # opposite of prefer_single_quotes
|
|
# - prefer_expression_function_bodies # conflicts with ./docs/contributing/Style-guide-for-Flutter-repo.md#consider-using--for-short-functions-and-methods
|
|
- prefer_final_fields
|
|
- prefer_final_in_for_each
|
|
- prefer_final_locals
|
|
# - prefer_final_parameters # adds too much verbosity
|
|
- 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 # conflicts with ./docs/contributing/Style-guide-for-Flutter-repo.md#use-double-literals-for-double-constants
|
|
- prefer_interpolation_to_compose_strings
|
|
- prefer_is_empty
|
|
- prefer_is_not_empty
|
|
- prefer_is_not_operator
|
|
- prefer_iterable_whereType
|
|
- prefer_mixin
|
|
# - prefer_null_aware_method_calls # "call()" is confusing to people new to the language since it's not documented anywhere
|
|
- prefer_null_aware_operators
|
|
- prefer_relative_imports
|
|
- prefer_single_quotes
|
|
- prefer_spread_collections
|
|
- prefer_typing_uninitialized_variables
|
|
- prefer_void_to_null
|
|
- provide_deprecation_message
|
|
# - public_member_api_docs # enabled on a case-by-case basis; see e.g. packages/analysis_options.yaml
|
|
- recursive_getters
|
|
# - require_trailing_commas # would be nice, but requires a lot of manual work: 10,000+ code locations would need to be reformatted by hand after bulk fix is applied
|
|
- secure_pubspec_urls
|
|
- sized_box_for_whitespace
|
|
- sized_box_shrink_expand
|
|
- slash_for_doc_comments
|
|
- sort_child_properties_last
|
|
- sort_constructors_first
|
|
# - sort_pub_dependencies # prevents separating pinned transitive dependencies
|
|
- sort_unnamed_constructors_first
|
|
- specify_nonobvious_local_variable_types
|
|
- specify_nonobvious_property_types
|
|
- strict_top_level_inference
|
|
- test_types_in_equals
|
|
- throw_in_finally
|
|
- tighten_type_of_initializing_formals
|
|
- type_annotate_public_apis
|
|
- type_init_formals
|
|
- type_literal_in_constant_pattern
|
|
# - unawaited_futures # too many false positives, especially with the way AnimationController works
|
|
# - unintended_html_in_doc_comment # blocked on https://github.com/dart-lang/linter/issues/5065
|
|
# - unnecessary_async # not yet tested
|
|
- unnecessary_await_in_return
|
|
- unnecessary_brace_in_string_interps
|
|
- unnecessary_breaks
|
|
- unnecessary_const
|
|
- unnecessary_constructor_name
|
|
# - unnecessary_final # conflicts with prefer_final_locals
|
|
- unnecessary_getters_setters
|
|
# - unnecessary_ignore # Disabled by default to simplify migrations; should be periodically enabled locally to clean up offenders
|
|
# - unnecessary_lambdas # has false positives: https://github.com/dart-lang/linter/issues/498
|
|
- unnecessary_late
|
|
- unnecessary_library_directive
|
|
# - unnecessary_library_name # blocked on https://github.com/dart-lang/dartdoc/issues/3882
|
|
- unnecessary_new
|
|
- unnecessary_null_aware_assignments
|
|
- unnecessary_null_aware_operator_on_extension_on_nullable
|
|
- unnecessary_null_checks
|
|
- unnecessary_null_in_if_null_operators
|
|
- unnecessary_nullable_for_final_variable_declarations
|
|
- unnecessary_overrides
|
|
- unnecessary_parenthesis
|
|
# - unnecessary_raw_strings # what's "necessary" is a matter of opinion; consistency across strings can help readability more than this lint
|
|
- unnecessary_statements
|
|
- unnecessary_string_escapes
|
|
- unnecessary_string_interpolations
|
|
- unnecessary_this
|
|
- unnecessary_to_list_in_spreads
|
|
- unnecessary_underscores
|
|
- unreachable_from_main
|
|
- unrelated_type_equality_checks
|
|
# - unsafe_variance # not yet tested
|
|
- use_build_context_synchronously
|
|
- use_colored_box
|
|
# - use_decorated_box # leads to bugs: DecoratedBox and Container are not equivalent (Container inserts extra padding)
|
|
- use_enums
|
|
- use_full_hex_values_for_flutter_colors
|
|
- use_function_type_syntax_for_parameters
|
|
- use_if_null_to_convert_nulls_to_bools
|
|
- use_is_even_rather_than_modulo
|
|
- use_key_in_widget_constructors
|
|
- use_late_for_private_fields_and_variables
|
|
- use_named_constants
|
|
- use_raw_strings
|
|
- use_rethrow_when_possible
|
|
- use_setters_to_change_properties
|
|
# - use_string_buffers # has false positives: https://github.com/dart-lang/sdk/issues/34182
|
|
- use_string_in_part_of_directives
|
|
- use_super_parameters
|
|
- use_test_throws_matchers
|
|
# - use_to_and_as_if_applicable # has false positives, so we prefer to catch this by code-review
|
|
- use_truncating_division
|
|
- valid_regexps
|
|
- void_checks
|