如何配置Dart Linter:除Lambda外强制所有位置添加类型注解
需求:自定义Dart Linter类型注解警告规则
我想要让我的Dart Linter针对除Lambda表达式外的所有缺失类型注解情况发出警告——毕竟缺失类型注解会拉低代码可读性,好处却没多少。
需要触发警告的代码示例
以下这些语句应该触发类型缺失的警告:
const s = 'my string'; // 需指定类型注解 foo() => 'foo'; // foo缺少返回类型 List bar() => ['bar', 'baz']; // 需指定类型注解
无需触发警告的代码示例
而这类Lambda表达式的场景,不应该触发警告:
<String>['qux', 'quux', 'corge'].map((s) => s.toUpperCase());
对应的analysis_options.yaml配置调整
目前我的配置里已经启用了always_specify_types规则,但它会对Lambda表达式的参数也触发警告,这不是我想要的。我们可以通过调整规则组合来实现需求:
- 保留
always_specify_types规则,确保变量、函数返回值等场景的类型注解检查 - 启用
avoid_types_on_closure_parameters规则,让Linter忽略Lambda表达式的参数类型注解检查
关键配置部分如下:
analyzer: strong-mode: implicit-dynamic: false errors: missing_required_param: warning missing_return: warning # 其他错误配置... linter: rules: # 其他规则... - always_specify_types - avoid_types_on_closure_parameters # 其他规则...
完整的analysis_options.yaml配置
# 指定分析选项。 # # 在有元linter规则之前,必须显式启用每个所需的lint。 # # lint列表详见Dart Lint规则页面 # 更多配置指南请查看Dart分析器配置文档 # # Flutter仓库中有其他类似的分析选项文件, # 应与本文件保持同步: # # - analysis_options.yaml(本文件) # - packages/flutter/lib/analysis_options_user.yaml # - Flutter plugins仓库的analysis_options.yaml # - Flutter engine仓库的analysis_options.yaml # # 本文件包含Flutter工具(如IntelliJ、Android Studio和`flutter analyze`命令)使用的分析选项。 analyzer: strong-mode: implicit-dynamic: false errors: # 将缺少必填参数视为警告(而非提示) missing_required_param: warning # 将缺少返回值视为警告(而非提示) missing_return: warning # 允许代码中存在TODO todo: warning # 使用Future或Stream但未导入dart:async时,忽略分析器的pubspec更新提示 sdk_version_async_exported_from_core: ignore exclude: - "bin/cache/**" # 以下两个路径分别相对于stocks示例和flutter包 - "lib/i18n/stock_messages_*.dart" - "lib/src/http/**" linter: rules: # 这些规则按Dart Lint规则页面的顺序记录,便于维护 - always_declare_return_types # - always_put_control_body_on_new_line # - always_put_required_named_parameters_first # 我们更倾向于参数顺序与字段一致 - always_require_non_null_named_parameters - always_specify_types - annotate_overrides # - avoid_annotating_with_dynamic # 与always_specify_types冲突 - avoid_as - avoid_bool_literals_in_conditional_expressions # - avoid_catches_without_on_clauses # 我们经常这样做 # - avoid_catching_errors # 我们经常这样做 # - avoid_classes_with_only_static_members # - avoid_double_and_int_checks # 仅在针对JS运行时有用 - avoid_empty_else - avoid_field_initializers_in_const_classes - avoid_function_literals_in_foreach_calls # - avoid_implementing_value_types # 尚未测试 - avoid_init_to_null # - avoid_js_rounded_ints # 仅在针对JS运行时有用 - avoid_null_checks_in_equality_operators # - avoid_positional_boolean_parameters # 尚未测试 # - avoid_private_typedef_functions # 我们更倾向于使用typedef - avoid_relative_lib_imports - avoid_return_types_on_setters # - avoid_returning_null # 有很多合理的理由返回null # - avoid_returning_null_for_future # 尚未测试 - avoid_returning_null_for_void # - avoid_returning_this # 有很多合理的理由返回this # - avoid_setters_without_getters # 尚未测试 # - avoid_shadowing_type_parameters # 尚未测试 # - avoid_single_cascade_in_expression_statements # 尚未测试 - avoid_slow_async_io - avoid_types_as_parameter_names - avoid_types_on_closure_parameters # 新增:忽略Lambda表达式参数的类型注解检查 - avoid_unused_constructor_parameters - avoid_void_async - await_only_futures - camel_case_types - cancel_subscriptions # - cascade_invocations # 尚未测试 # - close_sinks # 不够可靠 # - comment_references # 被相关问题阻塞 # - constant_identifier_names # 需要退出选项 - control_flow_in_finally # - curly_braces_in_flow_control_structures # 尚未测试 # - diagnostic_describe_all_properties # 尚未测试 - directives_ordering - empty_catches - empty_constructor_bodies - empty_statements # - file_names # 尚未测试 - flutter_style_todos - hash_and_equals - implementation_imports # - invariant_booleans # 误报太多 - iterable_contains_unrelated_type # - join_return_with_assignment # 尚未测试 - library_names - library_prefixes # - lines_longer_than_80_chars # 尚未测试 - list_remove_unrelated_type # - literal_only_boolean_expressions # 误报太多 - no_adjacent_strings_in_list - no_duplicate_case_values - non_constant_identifier_names # - null_closures # 尚未测试 # - omit_local_variable_types # 与always_specify_types相反 # - one_member_abstracts # 误报太多 # - only_throw_errors # 相关问题待处理 - overridden_fields - package_api_docs - package_names - package_prefixed_library_names # - parameter_assignments # 我们经常这样做 - prefer_adjacent_string_concatenation - prefer_asserts_in_initializer_lists # - prefer_asserts_with_message # 尚未测试 - 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 # 与prefer_single_quotes相反 - prefer_equal_for_default_values # - prefer_expression_function_bodies # 与Flutter仓库风格指南冲突 - prefer_final_fields # - prefer_final_in_for_each # 尚未测试 - prefer_final_locals # - 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_iterable_whereType # - prefer_mixin # 相关语言特性待完善 # - prefer_null_aware_operators # 在NNBD之前禁用 - prefer_single_quotes - prefer_spread_collections - prefer_typing_uninitialized_variables - prefer_void_to_null # - provide_deprecation_message # 尚未测试 # - public_member_api_docs # 按情况启用;例如见packages/analysis_options.yaml - recursive_getters - slash_for_doc_comments # - sort_child_properties_last # 尚未测试 - sort_constructors_first - sort_pub_dependencies - sort_unnamed_constructors_first - test_types_in_equals - throw_in_finally # - type_annotate_public_apis # always_specify_types的子集 - type_init_formals # - unawaited_futures # 误报太多 # - unnecessary_await_in_return # 尚未测试 - unnecessary_brace_in_string_interps - unnecessary_const - unnecessary_getters_setters # - unnecessary_lambdas # 有误报 - unnecessary_new - unnecessary_null_aware_assignments - unnecessary_null_in_if_null_operators - unnecessary_overrides - unnecessary_parenthesis - unnecessary_statements - unnecessary_this - unrelated_type_equality_checks # - unsafe_html # 尚未测试 - use_full_hex_values_for_flutter_colors # - use_function_type_syntax_for_parameters # 尚未测试 - use_rethrow_when_possible # - use_setters_to_change_properties # 尚未测试 # - use_string_buffers # 有误报 # - use_to_and_as_if_applicable # 有误报,因此我们更倾向于通过代码审查发现 - valid_regexps # - void_checks # 尚未测试
内容的提问来源于stack exchange,提问作者Pado
相关产品推荐
相关产品推荐

