diff --git a/CHANGELOG.md b/CHANGELOG.md index 043e923..aee64d6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,8 @@ +# 3.0.2 + +- fix: remove deprecated `invariant_booleans` lint +- fix: deprecate `unawaited` (use `unawaited` from `dart:async` instead). + # 3.0.1 - feat: use analyzer language modes instead of deprecated `strong-mode` diff --git a/README.md b/README.md index f66b3d3..40b72fa 100644 --- a/README.md +++ b/README.md @@ -23,11 +23,11 @@ To use the lints, add a dependency in your `pubspec.yaml`: ```yaml # If you use `package:very_good_analysis/very_good_analysis.dart`, add a normal dependency. dependencies: - very_good_analysis: ^3.0.1 + very_good_analysis: ^3.0.2 # Or, if you just want `analysis_options.yaml`, it can be a dev dependency. dev_dependencies: - very_good_analysis: ^3.0.1 + very_good_analysis: ^3.0.2 ``` Then, add an include in `analysis_options.yaml`: diff --git a/example/lib/example.dart b/example/lib/example.dart index 5f342e5..cfd520d 100644 --- a/example/lib/example.dart +++ b/example/lib/example.dart @@ -1,12 +1,12 @@ -import 'package:very_good_analysis/very_good_analysis.dart'; +// The following syntax deactivates a lint for the entire file: +// ignore_for_file: avoid_print -Future main() async { - /// Await async functions. - await asyncFunction(); +void main() { + /// The following line would normally show a lint warning + /// but we can disable the lint rule for this line using the following syntax. + var greeting = 'hello world'; // ignore: prefer_final_locals - /// Use [unawaited] to indicate that a [Future] is intentionally not awaited. - /// Otherwise you'll get a warning - unawaited(asyncFunction()); + /// The following line would normally show a lint warning + /// but we can disable the lint rule for this file using `ignore_for_file`. + print(greeting); } - -Future asyncFunction() => Future.value('hello world!'); diff --git a/lib/analysis_options.3.0.2.yaml b/lib/analysis_options.3.0.2.yaml new file mode 100644 index 0000000..28ac0ba --- /dev/null +++ b/lib/analysis_options.3.0.2.yaml @@ -0,0 +1,193 @@ +analyzer: + language: + strict-casts: true + strict-inference: true + strict-raw-types: true + + errors: + close_sinks: ignore + missing_required_param: error + missing_return: error + + exclude: + - test/.test_coverage.dart + - lib/generated_plugin_registrant.dart + +linter: + rules: + - always_declare_return_types + - always_require_non_null_named_parameters + - always_use_package_imports + - annotate_overrides + - avoid_bool_literals_in_conditional_expressions + - avoid_catching_errors + - 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_function_literals_in_foreach_calls + - avoid_init_to_null + - avoid_js_rounded_ints + - avoid_null_checks_in_equality_operators + - avoid_positional_boolean_parameters + - avoid_print + - avoid_private_typedef_functions + - avoid_redundant_argument_values + - avoid_relative_lib_imports + - avoid_renaming_method_parameters + - avoid_return_types_on_setters + - avoid_returning_null + - avoid_returning_null_for_future + - avoid_returning_null_for_void + - avoid_returning_this + - 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_unnecessary_containers + - avoid_unused_constructor_parameters + - avoid_void_async + - avoid_web_libraries_in_flutter + - await_only_futures + - camel_case_extensions + - camel_case_types + - cancel_subscriptions + - cascade_invocations + - cast_nullable_to_non_nullable + - comment_references + - conditional_uri_does_not_exist + - constant_identifier_names + - control_flow_in_finally + - curly_braces_in_flow_control_structures + - deprecated_consistency + - directives_ordering + - empty_catches + - empty_constructor_bodies + - empty_statements + - eol_at_end_of_file + - exhaustive_cases + - file_names + - flutter_style_todos + - hash_and_equals + - implementation_imports + - iterable_contains_unrelated_type + - join_return_with_assignment + - leading_newlines_in_multiline_strings + - library_names + - library_prefixes + - library_private_types_in_public_api + - lines_longer_than_80_chars + - list_remove_unrelated_type + - literal_only_boolean_expressions + - missing_whitespace_between_adjacent_strings + - no_adjacent_strings_in_list + - no_default_cases + - no_duplicate_case_values + - no_logic_in_create_state + - no_runtimeType_toString + - non_constant_identifier_names + - noop_primitive_operations + - null_check_on_nullable_type_parameter + - null_closures + - omit_local_variable_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_equal_for_default_values + - prefer_final_fields + - prefer_final_in_for_each + - prefer_final_locals + - prefer_for_elements_to_map_fromIterable + - 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_null_aware_method_calls + - prefer_null_aware_operators + - prefer_single_quotes + - prefer_spread_collections + - prefer_typing_uninitialized_variables + - prefer_void_to_null + - provide_deprecation_message + - public_member_api_docs + - recursive_getters + - require_trailing_commas + - 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 + - sort_unnamed_constructors_first + - test_types_in_equals + - throw_in_finally + - tighten_type_of_initializing_formals + - type_annotate_public_apis + - type_init_formals + - unawaited_futures + - unnecessary_await_in_return + - unnecessary_brace_in_string_interps + - unnecessary_const + - unnecessary_constructor_name + - unnecessary_getters_setters + - unnecessary_lambdas + - unnecessary_late + - unnecessary_new + - unnecessary_null_aware_assignments + - unnecessary_null_checks + - unnecessary_null_in_if_null_operators + - unnecessary_nullable_for_final_variable_declarations + - unnecessary_overrides + - unnecessary_parenthesis + - unnecessary_raw_strings + - unnecessary_statements + - unnecessary_string_escapes + - unnecessary_string_interpolations + - unnecessary_this + - unrelated_type_equality_checks + - use_build_context_synchronously + - use_colored_box + - use_decorated_box + - use_enums + - use_full_hex_values_for_flutter_colors + - use_function_type_syntax_for_parameters + - 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 + - use_super_parameters + - use_to_and_as_if_applicable + - valid_regexps + - void_checks diff --git a/lib/analysis_options.yaml b/lib/analysis_options.yaml index d0fffaf..3e5b717 100644 --- a/lib/analysis_options.yaml +++ b/lib/analysis_options.yaml @@ -1 +1 @@ -include: package:very_good_analysis/analysis_options.3.0.1.yaml +include: package:very_good_analysis/analysis_options.3.0.2.yaml diff --git a/lib/very_good_analysis.dart b/lib/very_good_analysis.dart index e9f7de9..842ba99 100644 --- a/lib/very_good_analysis.dart +++ b/lib/very_good_analysis.dart @@ -9,4 +9,5 @@ library very_good_analysis; /// there are times where one or more futures are intentionally not awaited. /// This function may be used to ignore a particular future. It silences the /// `unawaited_futures` lint. +@Deprecated('Please use unawaited from dart:async.') void unawaited(Future? future) {} diff --git a/pubspec.yaml b/pubspec.yaml index 468e46b..44ade98 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,5 +1,5 @@ name: very_good_analysis -version: 3.0.1 +version: 3.0.2 description: Lint rules for Dart and Flutter used internally at Very Good Ventures. repository: https://github.com/VeryGoodOpenSource/very_good_analysis issue_tracker: https://github.com/VeryGoodOpenSource/very_good_analysis/issues