From f36f252ea7b0bb9b426025018662ee7d3e569bc9 Mon Sep 17 00:00:00 2001 From: Hugo Pointcheval Date: Tue, 19 Apr 2022 19:01:09 +0200 Subject: [PATCH] fix(release)!: remove unawaited() since its in Dart 2.15 --- packages/wyatt_analysis/example/README.md | 59 ------ .../example/analysis_options.yaml | 1 - .../example/lib/wyatt_analysis_exemple.dart | 14 -- packages/wyatt_analysis/example/pubspec.yaml | 10 - .../lib/analysis_options.2.0.0.yaml | 183 ++++++++++++++++++ .../lib/analysis_options.flutter.2.0.0.yaml | 33 ++++ .../lib/analysis_options.flutter.yaml | 2 +- .../wyatt_analysis/lib/analysis_options.yaml | 2 +- .../wyatt_analysis/lib/wyatt_analysis.dart | 11 +- 9 files changed, 219 insertions(+), 96 deletions(-) delete mode 100644 packages/wyatt_analysis/example/README.md delete mode 100644 packages/wyatt_analysis/example/analysis_options.yaml delete mode 100644 packages/wyatt_analysis/example/lib/wyatt_analysis_exemple.dart delete mode 100644 packages/wyatt_analysis/example/pubspec.yaml create mode 100644 packages/wyatt_analysis/lib/analysis_options.2.0.0.yaml create mode 100644 packages/wyatt_analysis/lib/analysis_options.flutter.2.0.0.yaml diff --git a/packages/wyatt_analysis/example/README.md b/packages/wyatt_analysis/example/README.md deleted file mode 100644 index 62fb3f8d..00000000 --- a/packages/wyatt_analysis/example/README.md +++ /dev/null @@ -1,59 +0,0 @@ - - -# Wyatt Analysis - Example - -```yaml -# If you use `package:wyatt_analysis/wyatt_analysis.dart`, add a normal dependency, you'll get unawaited function. -dependencies: - wyatt_analysis: - git: - url: ssh://git@git.wyatt-studio.fr:993/Wyatt-Campus/wyatt-analysis.git - ref: vX.X.X - -# Or, if you just want `analysis_options.yaml`, it can be a dev dependency. -dev_dependencies: - wyatt_analysis: - git: - url: ssh://git@git.wyatt-studio.fr:993/Wyatt-Campus/wyatt-analysis.git - ref: vX.X.X -``` - -Then, add an include in `analysis_options.yaml`: - -```yaml -include: package:wyatt_analysis/analysis_options.yaml -``` - -This will ensure you always use the latest **Dart** version of the lints. To get the latest **Flutter** superset: - -```yaml -include: package:wyatt_analysis/analysis_options.flutter.yaml -``` - -If you wish to restrict the lint version, specify a version of `analysis_options.yaml` instead: - -```yaml -include: package:wyatt_analysis/analysis_options.flutter.X.X.X.yaml -``` - -If you just want **Dart** version: - -```yaml -include: package:wyatt_analysis/analysis_options.X.X.X.yaml -``` \ No newline at end of file diff --git a/packages/wyatt_analysis/example/analysis_options.yaml b/packages/wyatt_analysis/example/analysis_options.yaml deleted file mode 100644 index 2f6092c4..00000000 --- a/packages/wyatt_analysis/example/analysis_options.yaml +++ /dev/null @@ -1 +0,0 @@ -include: package:wyatt_analysis/analysis_options.yaml \ No newline at end of file diff --git a/packages/wyatt_analysis/example/lib/wyatt_analysis_exemple.dart b/packages/wyatt_analysis/example/lib/wyatt_analysis_exemple.dart deleted file mode 100644 index 2dada6d2..00000000 --- a/packages/wyatt_analysis/example/lib/wyatt_analysis_exemple.dart +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:wyatt_analysis/wyatt_analysis.dart'; - -Future main() async { - /// Await async functions. - await asyncFunction(); - - /// Use [unawaited] to indicate that a [Future] is intentionally not awaited. - /// Otherwise you'll get a warning - unawaited(asyncFunction()); -} - -Future asyncFunction() { - return Future.value('hello, world!'); -} diff --git a/packages/wyatt_analysis/example/pubspec.yaml b/packages/wyatt_analysis/example/pubspec.yaml deleted file mode 100644 index bc9d424f..00000000 --- a/packages/wyatt_analysis/example/pubspec.yaml +++ /dev/null @@ -1,10 +0,0 @@ -name: wyatt_analysis_example -version: 0.0.1 -publish_to: none - -environment: - sdk: ">=2.12.0-0 <3.0.0" - -dependencies: - wyatt_analysis: - path: ../ \ No newline at end of file diff --git a/packages/wyatt_analysis/lib/analysis_options.2.0.0.yaml b/packages/wyatt_analysis/lib/analysis_options.2.0.0.yaml new file mode 100644 index 00000000..0a5a8b28 --- /dev/null +++ b/packages/wyatt_analysis/lib/analysis_options.2.0.0.yaml @@ -0,0 +1,183 @@ +# Copyright (C) 2022 WYATT GROUP +# Please see the AUTHORS file for details. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +analyzer: + exclude: + - lib/l10n/** + - lib/generated/** + - lib/generated_plugin_registrant.dart + - test/.test_coverage.dart + strong-mode: + implicit-casts: false + implicit-dynamic: false + errors: + todo: ignore + close_sinks: ignore + missing_required_param: error + missing_return: error + +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_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_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_unused_constructor_parameters + - avoid_void_async + - await_only_futures + - camel_case_extensions + - camel_case_types + - cancel_subscriptions + - cascade_invocations + - cast_nullable_to_non_nullable + - comment_references + - 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 + - invariant_booleans + - 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_runtimeType_toString + - non_constant_identifier_names + - noop_primitive_operations + - null_check_on_nullable_type_parameter + - null_closures + - 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_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_operators + - prefer_null_aware_method_calls + - prefer_single_quotes + - prefer_spread_collections + - prefer_typing_uninitialized_variables + - prefer_void_to_null + - provide_deprecation_message + - recursive_getters + - require_trailing_commas + - slash_for_doc_comments + - 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_getters_setters + - unnecessary_lambdas + - 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_function_type_syntax_for_parameters + - use_is_even_rather_than_modulo + - 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_to_and_as_if_applicable + - valid_regexps + - void_checks \ No newline at end of file diff --git a/packages/wyatt_analysis/lib/analysis_options.flutter.2.0.0.yaml b/packages/wyatt_analysis/lib/analysis_options.flutter.2.0.0.yaml new file mode 100644 index 00000000..2b3becd0 --- /dev/null +++ b/packages/wyatt_analysis/lib/analysis_options.flutter.2.0.0.yaml @@ -0,0 +1,33 @@ +# Copyright (C) 2022 WYATT GROUP +# Please see the AUTHORS file for details. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +include: package:wyatt_analysis/analysis_options.2.0.0.yaml + +linter: + rules: + - avoid_print + - avoid_unnecessary_containers + - avoid_web_libraries_in_flutter + - no_logic_in_create_state + - prefer_const_constructors + - prefer_const_constructors_in_immutables + - prefer_const_declarations + - prefer_const_literals_to_create_immutables + - sized_box_for_whitespace + - sort_child_properties_last + - use_build_context_synchronously + - use_full_hex_values_for_flutter_colors + - use_key_in_widget_constructors diff --git a/packages/wyatt_analysis/lib/analysis_options.flutter.yaml b/packages/wyatt_analysis/lib/analysis_options.flutter.yaml index 5e6cec32..9011befd 100644 --- a/packages/wyatt_analysis/lib/analysis_options.flutter.yaml +++ b/packages/wyatt_analysis/lib/analysis_options.flutter.yaml @@ -14,4 +14,4 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -include: package:wyatt_analysis/analysis_options.flutter.1.1.1.yaml +include: package:wyatt_analysis/analysis_options.flutter.2.0.0.yaml diff --git a/packages/wyatt_analysis/lib/analysis_options.yaml b/packages/wyatt_analysis/lib/analysis_options.yaml index f7d3851d..029e2244 100644 --- a/packages/wyatt_analysis/lib/analysis_options.yaml +++ b/packages/wyatt_analysis/lib/analysis_options.yaml @@ -14,4 +14,4 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -include: package:wyatt_analysis/analysis_options.1.1.1.yaml +include: package:wyatt_analysis/analysis_options.2.0.0.yaml diff --git a/packages/wyatt_analysis/lib/wyatt_analysis.dart b/packages/wyatt_analysis/lib/wyatt_analysis.dart index 9db2784f..c10c7494 100644 --- a/packages/wyatt_analysis/lib/wyatt_analysis.dart +++ b/packages/wyatt_analysis/lib/wyatt_analysis.dart @@ -19,13 +19,4 @@ /// and [Wyatt Studio](https://wyatt-studio.fr). library wyatt_analysis; -/// Indicates to tools that `Future` is intentionally not `await`-ed. -/// -/// In an `async` context, it is normally expected that all `Future`s are -/// awaited, and that is the basis of the lint `unawaited_futures`. However, -/// 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. -void unawaited(Future? future) {} - -const String wyattAnalysisVersion = '1.1.1'; +const String wyattAnalysisVersion = '2.0.0';