[macros] linter support #4881
Comments
pq
added
meta
new-language-feature
P1
github-actions
bot
added
set-core
I think this should ultimately be supported: https://github.com/dart-lang/language/blob/main/working/augmentation-libraries/feature-specification.md#augmenting-enum-values See also: dart-lang/linter#4881 Change-Id: Ibb8a175b40410599a28f06b2993ce9da92c1838c Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/352995 Commit-Queue: Phil Quitslund <pquitslund@google.com> Reviewed-by: Brian Wilkerson <brianwilkerson@google.com>
|
If this is about running lints on generated code, I assume lots of those probably should not apply. In particular, all the stylistic ones. For instance |
|
Thanks @rrousselGit. Partly yes, this is about generated code. We expect most lints to not apply[*] in that case for exactly the reasons you mention. Slightly more interesting are lints that might apply (in some potentially limited way) to macros and user created augmentation libraries. [*] Indeed, we're especially interested in the ones that should and we don't have a good categorization for those. (Security lints come to mind... Certain error-protecting ones too...) Feedback welcome! |
pq
added
P2
A meta-issue to discuss and track work on linter support for macros.
Existing Lints
Some existing lints will need tests (minimally) and possibly enhanced implementations.
always_declare_return_types#4951always_put_control_body_on_new_linealways_put_required_named_parameters_first#4943always_specify_types#4952always_use_package_importsannotate_overrides#4925annotate_redeclares#4927avoid_annotating_with_dynamic#4953avoid_bool_literals_in_conditional_expressionsavoid_catches_without_on_clausesavoid_catching_errorsavoid_classes_with_only_static_members#4931avoid_double_and_int_checksavoid_dynamic_callsavoid_empty_elseavoid_equals_and_hash_code_on_mutable_classes#4932avoid_escaping_inner_quotesavoid_field_initializers_in_const_classes#4926avoid_final_parametersavoid_function_literals_in_foreach_callsavoid_implementing_value_typesavoid_init_to_nullavoid_js_rounded_intsavoid_multiple_declarations_per_lineavoid_null_checks_in_equality_operatorsavoid_positional_boolean_parameters#4899avoid_printavoid_redundant_argument_valuesavoid_relative_lib_importsavoid_renaming_method_parametersavoid_return_types_on_settersavoid_returning_null_for_voidavoid_returning_thisavoid_setters_without_getters#4928avoid_shadowing_type_parametersavoid_single_cascade_in_expression_statementsavoid_slow_async_ioavoid_type_to_stringavoid_types_as_parameter_namesavoid_types_on_closure_parametersavoid_unnecessary_containersavoid_unused_constructor_parameters#4934avoid_void_asyncavoid_web_libraries_in_flutterawait_only_futurescamel_case_extensions#4898camel_case_types(augmented enums) #4882cancel_subscriptionscascade_invocationscast_nullable_to_non_nullableclose_sinkscollection_methods_unrelated_typecombinators_orderingcomment_referencesconditional_uri_does_not_existconstant_identifier_names#4933control_flow_in_finallycurly_braces_in_flow_control_structuresdangling_library_doc_commentsdepend_on_referenced_packagesdeprecated_consistencydeprecated_member_use_from_same_packagediagnostic_describe_all_propertiesdirectives_orderingdiscarded_futuresdo_not_use_environmentempty_catchesempty_constructor_bodiesempty_statementseol_at_end_of_fileerase_dart_type_extension_typesexhaustive_casesfile_namesflutter_style_todoshash_and_equals#4929implementation_importsimplicit_call_tearoffsimplicit_reopeninvalid_case_patternsjoin_return_with_assignmentleading_newlines_in_multiline_stringslibrary_annotationslibrary_nameslibrary_prefixeslibrary_private_types_in_public_apilines_longer_than_80_charsliteral_only_boolean_expressionsmatching_super_parametersmissing_whitespace_between_adjacent_stringsno_adjacent_strings_in_listno_default_casesno_duplicate_case_valuesno_leading_underscores_for_library_prefixesno_leading_underscores_for_local_identifiersno_literal_bool_comparisonsno_logic_in_create_stateno_runtimeType_toStringno_self_assignmentsno_wildcard_variable_usesnon_constant_identifier_names(variables and fields) #4883noop_primitive_operationsnull_check_on_nullable_type_parameternull_closuresomit_local_variable_typesone_member_abstracts#4924only_throw_errorsoverridden_fields#4930package_api_docs#4944package_namespackage_prefixed_library_namesparameter_assignmentsprefer_adjacent_string_concatenationprefer_asserts_in_initializer_listsprefer_asserts_with_messageprefer_collection_literalsprefer_conditional_assignmentprefer_const_constructors#4965prefer_const_constructors_in_immutables#4966prefer_const_declarationsprefer_const_literals_to_create_immutablesprefer_constructors_over_static_methodsprefer_containsprefer_double_quotesprefer_expression_function_bodiesprefer_final_in_for_eachprefer_final_localsprefer_final_parametersprefer_for_elements_to_map_fromIterableprefer_foreachprefer_function_declarations_over_variablesprefer_generic_function_type_aliases#4942prefer_if_elements_to_conditional_expressionsprefer_if_null_operatorsprefer_initializing_formalsprefer_inlined_addsprefer_int_literalsprefer_interpolation_to_compose_stringsprefer_is_emptyprefer_is_not_emptyprefer_is_not_operatorprefer_iterable_whereTypeprefer_mixinprefer_null_aware_method_callsprefer_null_aware_operatorsprefer_relative_importsprefer_single_quotesprefer_spread_collectionsprefer_typing_uninitialized_variables#4954prefer_void_to_nullon augmented declarations #4890provide_deprecation_messagepublic_member_api_docson augmentations #4903recursive_gettersrequire_trailing_commassecure_pubspec_urlssized_box_for_whitespacesized_box_shrink_expandslash_for_doc_commentssort_child_properties_lastsort_constructors_firstsort_pub_dependenciessort_unnamed_constructors_firsttest_types_in_equalsthrow_in_finallytighten_type_of_initializing_formalstype_annotate_public_apisfor augmented methods/functions/variables #4893type_init_formalstype_literal_in_constant_patternunawaited_futuresunnecessary_await_in_returnunnecessary_brace_in_string_interpsunnecessary_breaksunnecessary_constunnecessary_constructor_nameunnecessary_finalunnecessary_getters_setters#4935unnecessary_lambdasunnecessary_lateunnecessary_library_directiveunnecessary_newunnecessary_null_aware_assignmentsunnecessary_null_aware_operator_on_extension_on_nullableunnecessary_null_checksunnecessary_null_in_if_null_operatorsunnecessary_nullable_for_final_variable_declarationsunnecessary_overrides#4902unnecessary_parenthesisunnecessary_raw_stringsunnecessary_statementsunnecessary_string_escapesunnecessary_string_interpolationsunnecessary_thisunnecessary_to_list_in_spreadsunrelated_type_equality_checksunsafe_htmluse_build_context_synchronouslyuse_colored_boxuse_decorated_boxuse_enums#4900use_full_hex_values_for_flutter_colorsuse_function_type_syntax_for_parametersuse_if_null_to_convert_nulls_to_boolsuse_is_even_rather_than_modulouse_key_in_widget_constructorsuse_key_in_widget_constructorstriggers even though augmented class uses key #4936use_named_constantsuse_raw_stringsuse_rethrow_when_possibleuse_setters_to_change_propertiesuse_string_buffersuse_string_in_part_of_directivesuse_super_parametersuse_test_throws_matchersuse_to_and_as_if_applicablevalid_regexpsvoid_checksGeneral questions that have implications for a number of lints:
has{*}annotation getters to consider augmentations sdk#55579New Lints
Authors and users of macros (and augmentation classes) might benefit from some new lints.
avoid_renaming_method_parametersto check augmented functions #4891🚧 Feedback welcome! 🚧
Analyzer / Server Support
Visibility
To whom and under what circumstances should we display diagnostics produced in macro generated files?
/fyi @dart-lang/language-team @bwilkerson @keertip @scheglov @srawlins
The text was updated successfully, but these errors were encountered: