dart-lang / linter

Linter for Dart.
https://dart.dev/tools/linter-rules
BSD 3-Clause "New" or "Revised" License
632 stars 170 forks source link

[proposal] remove prescriptive language from lint names #3872

Open pq opened 1 year ago

pq commented 1 year ago

Following up from #3827, this issue scopes the conversation to removing prescriptive language from lint names. Such a change (in bulk) would affect 88 (or just over 40%) of our 218 rules.

The applied replacements are:

but other ideas are welcome.

Note that this is is very much a proposal and it's not obvious that the benefits would outweigh the churn (even with an automated migration path via dart fix). Please chime in!

lint new name
always_declare_return_types declare_return_types
always_put_control_body_on_new_line put_control_body_on_new_line
always_put_required_named_parameters_first put_required_named_parameters_first
always_require_non_null_named_parameters require_non_null_named_parameters
always_specify_types specify_types
always_use_package_imports use_package_imports
avoid_annotating_with_dynamic no_annotating_with_dynamic
avoid_as no_as
avoid_bool_literals_in_conditional_expressions no_bool_literals_in_conditional_expressions
avoid_catches_without_on_clauses no_catches_without_on_clauses
avoid_catching_errors no_catching_errors
avoid_classes_with_only_static_members no_classes_with_only_static_members
avoid_double_and_int_checks no_double_and_int_checks
avoid_dynamic_calls no_dynamic_calls
avoid_empty_else no_empty_else
avoid_escaping_inner_quotes no_escaping_inner_quotes
avoid_field_initializers_in_const_classes no_field_initializers_in_const_classes
avoid_final_parameters no_final_parameters
avoid_function_literals_in_foreach_calls no_function_literals_in_foreach_calls
avoid_implementing_value_types no_implementing_value_types
avoid_init_to_null no_init_to_null
avoid_js_rounded_ints no_js_rounded_ints
avoid_multiple_declarations_per_line no_multiple_declarations_per_line
avoid_null_checks_in_equality_operators no_null_checks_in_equality_operators
avoid_equals_and_hash_code_on_mutable_classes no_equals_and_hash_code_on_mutable_classes
avoid_positional_boolean_parameters no_positional_boolean_parameters
avoid_print no_print
avoid_private_typedef_functions no_private_typedef_functions
avoid_redundant_argument_values no_redundant_argument_values
avoid_relative_lib_imports no_relative_lib_imports
avoid_renaming_method_parameters no_renaming_method_parameters
avoid_returning_null no_returning_null
avoid_returning_null_for_future no_returning_null_for_future
avoid_returning_null_for_void no_returning_null_for_void
avoid_returning_this no_returning_this
avoid_return_types_on_setters no_return_types_on_setters
avoid_setters_without_getters no_setters_without_getters
avoid_shadowing_type_parameters no_shadowing_type_parameters
avoid_single_cascade_in_expression_statements no_single_cascade_in_expression_statements
avoid_slow_async_io no_slow_async_io
avoid_type_to_string no_type_to_string
avoid_types_as_parameter_names no_types_as_parameter_names
avoid_types_on_closure_parameters no_types_on_closure_parameters
avoid_unnecessary_containers no_unnecessary_containers
avoid_unused_constructor_parameters no_unused_constructor_parameters
avoid_void_async no_void_async
avoid_web_libraries_in_flutter no_web_libraries_in_flutter
prefer_adjacent_string_concatenation use_adjacent_string_concatenation
prefer_asserts_in_initializer_lists use_asserts_in_initializer_lists
prefer_asserts_with_message use_asserts_with_message
prefer_bool_in_asserts use_bool_in_asserts
prefer_collection_literals use_collection_literals
prefer_conditional_assignment use_conditional_assignment
prefer_const_constructors use_const_constructors
prefer_const_constructors_in_immutables use_const_constructors_in_immutables
prefer_const_declarations use_const_declarations
prefer_const_literals_to_create_immutables use_const_literals_to_create_immutables
prefer_constructors_over_static_methods use_constructors_over_static_methods
prefer_contains use_contains
prefer_double_quotes use_double_quotes
prefer_equal_for_default_values use_equal_for_default_values
prefer_expression_function_bodies use_expression_function_bodies
prefer_final_fields use_final_fields
prefer_final_in_for_each use_final_in_for_each
prefer_final_locals use_final_locals
prefer_final_parameters use_final_parameters
prefer_foreach use_foreach
prefer_for_elements_to_map_fromIterable use_for_elements_to_map_fromIterable
prefer_function_declarations_over_variables use_function_declarations_over_variables
prefer_generic_function_type_aliases use_generic_function_type_aliases
prefer_if_elements_to_conditional_expressions use_if_elements_to_conditional_expressions
prefer_if_null_operators use_if_null_operators
prefer_initializing_formals use_initializing_formals
prefer_inlined_adds use_inlined_adds
prefer_interpolation_to_compose_strings use_interpolation_to_compose_strings
prefer_int_literals use_int_literals
prefer_is_empty use_is_empty
prefer_is_not_empty use_is_not_empty
prefer_is_not_operator use_is_not_operator
prefer_iterable_whereType use_iterable_whereType
prefer_mixin use_mixin
prefer_null_aware_operators use_null_aware_operators
prefer_null_aware_method_calls use_null_aware_method_calls
prefer_relative_imports use_relative_imports
prefer_single_quotes use_single_quotes
prefer_spread_collections use_spread_collections
prefer_typing_uninitialized_variables use_typing_uninitialized_variables
prefer_void_to_null use_void_to_null
bwilkerson commented 1 year ago

The conversion from "always_" => "" works well.

The conversion from "avoid" => "no" seems like we're making a stronger statement than the style guide currently makes, so we might want to try to find something a little less absolute.

The conversion from "prefer" => "use" works well most of the time (like use_single_quotes), but sometimes it doesn't (like use_typing_uninitialized_variables and use_void_to_null). Some of these names will need a bit more work.

It probably isn't worth renaming avoid_as and prefer_bool_in_asserts because they're deprecated, and there's a good chance that they'll be removed before they're renamed.

Similarly, we have discussed deprecating always_require_non_null_named_parameters, avoid_returning_null, avoid_returning_null_for_future, and prefer_equal_for_default_values, so those might or might not be worth renaming.

pq commented 1 year ago

Given what we have on deck already for 3.0 I think this is out of scope. Removing (for now).