From 8af3e480a947ab2e8619b3613c67c5fcbfbb5b68 Mon Sep 17 00:00:00 2001 From: Dan Field Date: Fri, 11 Jan 2019 13:38:02 -0800 Subject: [PATCH] Revert "move analysis_options to package" (#26436) * Revert "move analysis_options to package (#26244)" This reverts commit d4d1b29a35d7ab83bae77890ac8f46863adfbd37. --- analysis_options.yaml | 170 +++++++++++++++++- .../flutter/lib/analysis_options_user.yaml | 81 ++++++++- packages/flutter/pubspec.yaml | 2 - .../flutter_analysis_options/CHANGELOG.md | 6 - packages/flutter_analysis_options/README.md | 30 ---- .../lib/analysis_options.yaml | 168 ----------------- .../lib/analysis_options_base.yaml | 56 ------ .../flutter_analysis_options/pubspec.yaml | 13 -- 8 files changed, 248 insertions(+), 278 deletions(-) delete mode 100644 packages/flutter_analysis_options/CHANGELOG.md delete mode 100644 packages/flutter_analysis_options/README.md delete mode 100644 packages/flutter_analysis_options/lib/analysis_options.yaml delete mode 100644 packages/flutter_analysis_options/lib/analysis_options_base.yaml delete mode 100644 packages/flutter_analysis_options/pubspec.yaml diff --git a/analysis_options.yaml b/analysis_options.yaml index 71760e57ef..9fa618bf57 100644 --- a/analysis_options.yaml +++ b/analysis_options.yaml @@ -1,7 +1,33 @@ -include: packages/flutter_analysis_options/lib/analysis_options.yaml +# Specify analysis options. +# +# Until there are meta linter rules, each desired lint must be explicitly enabled. +# See: https://github.com/dart-lang/linter/issues/288 +# +# For a list of lints, see: http://dart-lang.github.io/linter/lints/ +# See the configuration guide for more +# https://github.com/dart-lang/sdk/tree/master/pkg/analyzer#configuring-the-analyzer +# +# There are other similar analysis options files in the flutter repos, +# which should be kept in sync with this file: +# +# - analysis_options.yaml (this file) +# - packages/flutter/lib/analysis_options_user.yaml +# - https://github.com/flutter/plugins/blob/master/analysis_options.yaml +# - https://github.com/flutter/engine/blob/master/analysis_options.yaml +# +# This file contains the analysis options used by Flutter tools, such as IntelliJ, +# Android Studio, and the `flutter analyze` command. analyzer: + strong-mode: + implicit-dynamic: false errors: + # treat missing required parameters as a warning (not a hint) + missing_required_param: warning + # treat missing returns as a warning (not a hint) + missing_return: warning + # allow having TODOs in the code + todo: ignore # Ignore analyzer hints for updating pubspecs when using Future or # Stream and not importing dart:async # Please see https://github.com/flutter/flutter/pull/24528 for details. @@ -10,4 +36,144 @@ analyzer: - 'bin/cache/**' # the following two are relative to the stocks example and the flutter package respectively # see https://github.com/dart-lang/sdk/issues/28463 - - 'lib/i18n/stock_messages_*.dart' \ No newline at end of file + - 'lib/i18n/stock_messages_*.dart' + - 'lib/src/http/**' + +linter: + rules: + # these rules are documented on and in the same order as + # the Dart Lint rules page to make maintenance easier + # https://github.com/dart-lang/linter/blob/master/example/all.yaml + - always_declare_return_types + - always_put_control_body_on_new_line + # - always_put_required_named_parameters_first # we prefer having parameters in the same order as fields https://github.com/flutter/flutter/issues/10219 + - always_require_non_null_named_parameters + - always_specify_types + - annotate_overrides + # - avoid_annotating_with_dynamic # conflicts with always_specify_types + - avoid_as + # - avoid_bool_literals_in_conditional_expressions # not yet tested + # - avoid_catches_without_on_clauses # we do this commonly + # - avoid_catching_errors # we do this commonly + - avoid_classes_with_only_static_members + # - avoid_double_and_int_checks # only useful when targeting JS runtime + - avoid_empty_else + - avoid_field_initializers_in_const_classes + - avoid_function_literals_in_foreach_calls + # - avoid_implementing_value_types # not yet tested + - avoid_init_to_null + # - avoid_js_rounded_ints # only useful when targeting JS runtime + - avoid_null_checks_in_equality_operators + # - avoid_positional_boolean_parameters # not yet tested + # - avoid_private_typedef_functions # we prefer having typedef (discussion in https://github.com/flutter/flutter/pull/16356) + - avoid_relative_lib_imports + - avoid_renaming_method_parameters + - avoid_return_types_on_setters + # - avoid_returning_null # there are plenty of valid reasons to return null + # - avoid_returning_null_for_future # not yet tested + - avoid_returning_null_for_void + # - avoid_returning_this # there are plenty of valid reasons to return this + # - avoid_setters_without_getters # not yet tested + # - avoid_shadowing_type_parameters # not yet tested + # - avoid_single_cascade_in_expression_statements # not yet tested + - avoid_slow_async_io + - avoid_types_as_parameter_names + # - avoid_types_on_closure_parameters # conflicts with always_specify_types + - avoid_unused_constructor_parameters + - avoid_void_async + - await_only_futures + - camel_case_types + - cancel_subscriptions + # - cascade_invocations # not yet tested + # - close_sinks # not reliable enough + # - comment_references # blocked on https://github.com/flutter/flutter/issues/20765 + # - constant_identifier_names # needs an opt-out https://github.com/dart-lang/linter/issues/204 + - control_flow_in_finally + # - curly_braces_in_flow_control_structures # not yet tested + - directives_ordering + - empty_catches + - empty_constructor_bodies + - empty_statements + # - file_names # not yet tested + - flutter_style_todos + - hash_and_equals + - implementation_imports + # - invariant_booleans # too many false positives: https://github.com/dart-lang/linter/issues/811 + - iterable_contains_unrelated_type + # - join_return_with_assignment # not yet tested + - library_names + - library_prefixes + # - lines_longer_than_80_chars # not yet tested + - list_remove_unrelated_type + # - literal_only_boolean_expressions # too many false positives: https://github.com/dart-lang/sdk/issues/34181 + - no_adjacent_strings_in_list + - no_duplicate_case_values + - non_constant_identifier_names + # - null_closures # not yet tested + # - omit_local_variable_types # opposite of always_specify_types + # - one_member_abstracts # too many false positives + # - only_throw_errors # https://github.com/flutter/flutter/issues/5792 + - overridden_fields + - package_api_docs + - package_names + - package_prefixed_library_names + # - parameter_assignments # we do this commonly + - prefer_adjacent_string_concatenation + - prefer_asserts_in_initializer_lists + - 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 # not yet tested + - prefer_contains + - prefer_equal_for_default_values + # - prefer_expression_function_bodies # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#consider-using--for-short-functions-and-methods + - prefer_final_fields + - prefer_final_locals + - prefer_foreach + # - prefer_function_declarations_over_variables # not yet tested + - prefer_generic_function_type_aliases + - prefer_initializing_formals + # - prefer_int_literals # not yet tested + # - prefer_interpolation_to_compose_strings # not yet tested + - prefer_is_empty + - prefer_is_not_empty + - prefer_iterable_whereType + # - prefer_mixin # https://github.com/dart-lang/language/issues/32 + - prefer_single_quotes + - prefer_typing_uninitialized_variables + - prefer_void_to_null + # - public_member_api_docs # enabled on a case-by-case basis; see e.g. packages/analysis_options.yaml + - recursive_getters + - slash_for_doc_comments + - sort_constructors_first + - sort_pub_dependencies + - sort_unnamed_constructors_first + - super_goes_last + - test_types_in_equals + - throw_in_finally + # - type_annotate_public_apis # subset of always_specify_types + - type_init_formals + # - unawaited_futures # too many false positives + # - unnecessary_await_in_return # not yet tested + - unnecessary_brace_in_string_interps + - unnecessary_const + - unnecessary_getters_setters + # - unnecessary_lambdas # has false positives: https://github.com/dart-lang/linter/issues/498 + - unnecessary_new + - unnecessary_null_aware_assignments + - unnecessary_null_in_if_null_operators + - unnecessary_overrides + - unnecessary_parenthesis + - unnecessary_statements + - unnecessary_this + - unrelated_type_equality_checks + # - use_function_type_syntax_for_parameters # not yet tested + - use_rethrow_when_possible + # - use_setters_to_change_properties # not yet tested + # - use_string_buffers # has false positives: https://github.com/dart-lang/sdk/issues/34182 + # - use_to_and_as_if_applicable # has false positives, so we prefer to catch this by code-review + - valid_regexps + # - void_checks # not yet tested diff --git a/packages/flutter/lib/analysis_options_user.yaml b/packages/flutter/lib/analysis_options_user.yaml index dc77061ba6..01c274a8b1 100644 --- a/packages/flutter/lib/analysis_options_user.yaml +++ b/packages/flutter/lib/analysis_options_user.yaml @@ -1 +1,80 @@ -include: package:flutter_analysis_options/analysis_options_base.yaml +# Specify analysis options. +# +# Until there are meta linter rules, each desired lint must be explicitly enabled. +# See: https://github.com/dart-lang/linter/issues/288 +# +# For a list of lints, see: http://dart-lang.github.io/linter/lints/ +# See the configuration guide for more +# https://github.com/dart-lang/sdk/tree/master/pkg/analyzer#configuring-the-analyzer +# +# There are four similar analysis options files in the flutter repos: +# - analysis_options.yaml +# - packages/flutter/lib/analysis_options_user.yaml (this file) +# - https://github.com/flutter/plugins/blob/master/analysis_options.yaml +# - https://github.com/flutter/engine/blob/master/analysis_options.yaml +# +# This file contains the analysis options used by "flutter analyze" and the +# dartanalyzer when analyzing code outside the flutter repository. It isn't named +# 'analysis_options.yaml' because otherwise editors would use it when analyzing +# the flutter tool itself. +# +# When editing, make sure you keep this and /analysis_options.yaml consistent. + +analyzer: + errors: + # treat missing required parameters as a warning (not a hint) + missing_required_param: warning + +linter: + rules: + # these rules are documented on and in the same order as + # the Dart Lint rules page to make maintenance easier + # https://github.com/dart-lang/linter/blob/master/example/all.yaml + # - always_declare_return_types + # - always_specify_types + # - annotate_overrides + # - avoid_as + - avoid_empty_else + - avoid_init_to_null + - avoid_return_types_on_setters + - await_only_futures + - camel_case_types + - cancel_subscriptions + - close_sinks + # - comment_references # we do not presume as to what people want to reference in their dartdocs + # - constant_identifier_names # https://github.com/dart-lang/linter/issues/204 + - control_flow_in_finally + - empty_constructor_bodies + - empty_statements + - hash_and_equals + - implementation_imports + # - invariant_booleans + # - iterable_contains_unrelated_type + - library_names + # - library_prefixes + # - list_remove_unrelated_type + # - literal_only_boolean_expressions + - non_constant_identifier_names + # - one_member_abstracts + # - only_throw_errors + # - overridden_fields + - package_api_docs + - package_names + - package_prefixed_library_names + - prefer_is_not_empty + # - prefer_mixin # https://github.com/dart-lang/language/issues/32 + # - public_member_api_docs + - slash_for_doc_comments + # - sort_constructors_first + # - sort_unnamed_constructors_first + - super_goes_last + - test_types_in_equals + - throw_in_finally + # - type_annotate_public_apis # subset of always_specify_types + - type_init_formals + # - unawaited_futures + - unnecessary_brace_in_string_interps + - unnecessary_getters_setters + - unnecessary_statements + - unrelated_type_equality_checks + - valid_regexps diff --git a/packages/flutter/pubspec.yaml b/packages/flutter/pubspec.yaml index 8655023d43..63428637f7 100644 --- a/packages/flutter/pubspec.yaml +++ b/packages/flutter/pubspec.yaml @@ -10,8 +10,6 @@ environment: dependencies: # To update these, use "flutter update-packages --force-upgrade". collection: 1.14.11 - flutter_analysis_options: - sdk: flutter meta: 1.1.6 typed_data: 1.1.6 vector_math: 2.0.8 diff --git a/packages/flutter_analysis_options/CHANGELOG.md b/packages/flutter_analysis_options/CHANGELOG.md deleted file mode 100644 index f0d9778d9b..0000000000 --- a/packages/flutter_analysis_options/CHANGELOG.md +++ /dev/null @@ -1,6 +0,0 @@ -# CHANGELOG - -## v 1.0.0 - -- Initial creation of package from flutter/flutter's analsyis_options.yaml and - analysis_options_user.yaml \ No newline at end of file diff --git a/packages/flutter_analysis_options/README.md b/packages/flutter_analysis_options/README.md deleted file mode 100644 index 57578ee367..0000000000 --- a/packages/flutter_analysis_options/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# Flutter Analysis Options - -This package contains the analysis lints used by the Flutter repositories: - -- [The Flutter framework](https://github.com/flutter/flutter) -- [The Flutter engine](https://github.com/flutter/engine) -- [Flutter plugins](https://github.com/flutter/plugins) -- [Flutter packages](https://github.com/flutter/packages) - -Other projects are welcome to consume and use these rules as well. It contains -two files: - -## analysis_options_base.yaml - -This is a subset of rules suitable for most Flutter projects. - -## analysis_options.yaml - -This imports all of the rules in `analysis_options_base.yaml`, plus additional -rules that conform to the style guidelines for the Flutter repository. - -## Consumption - -This package can be consumed from the Flutter SDK like so: - -```yaml -dependencies: - flutter_analysis_options: - sdk: flutter -``` diff --git a/packages/flutter_analysis_options/lib/analysis_options.yaml b/packages/flutter_analysis_options/lib/analysis_options.yaml deleted file mode 100644 index 37ee9f824d..0000000000 --- a/packages/flutter_analysis_options/lib/analysis_options.yaml +++ /dev/null @@ -1,168 +0,0 @@ -# Specify analysis options. -# -# Until there are meta linter rules, each desired lint must be explicitly enabled. -# See: https://github.com/dart-lang/linter/issues/288 -# -# For a list of lints, see: http://dart-lang.github.io/linter/lints/ -# See the configuration guide for more -# https://github.com/dart-lang/sdk/tree/master/pkg/analyzer#configuring-the-analyzer -# -# When editing, keep in mind that this package will be used by at least the following -# repositories: -# -# - https://github.com/flutter/plugins/blob/master/analysis_options.yaml -# - https://github.com/flutter/packages/blob/master/analysis_options.yaml -# - https://github.com/flutter/engine/blob/master/analysis_options.yaml -# -# This file contains the analysis options used by Flutter tools, such as IntelliJ, -# Android Studio, and the `flutter analyze` command. - -include: analysis_options_base.yaml - -analyzer: - strong-mode: - implicit-dynamic: false - errors: - # treat missing returns as a warning (not a hint) - missing_return: warning - # allow having TODOs in the code - todo: ignore - -linter: - rules: - # these rules are documented on and in the same order as - # the Dart Lint rules page to make maintenance easier - # https://github.com/dart-lang/linter/blob/master/example/all.yaml - - always_declare_return_types - - always_put_control_body_on_new_line - # - always_put_required_named_parameters_first # we prefer having parameters in the same order as fields https://github.com/flutter/flutter/issues/10219 - - always_require_non_null_named_parameters - - always_specify_types - - annotate_overrides - # - avoid_annotating_with_dynamic # conflicts with always_specify_types - - avoid_as - # - avoid_bool_literals_in_conditional_expressions # not yet tested - # - avoid_catches_without_on_clauses # we do this commonly - # - avoid_catching_errors # we do this commonly - - avoid_classes_with_only_static_members - # - avoid_double_and_int_checks # only useful when targeting JS runtime - # - avoid_empty_else # specified in analysis_options_base.yaml - - avoid_field_initializers_in_const_classes - - avoid_function_literals_in_foreach_calls - # - avoid_implementing_value_types # not yet tested - # - avoid_init_to_null # specified in analysis_options_base.yaml - # - avoid_js_rounded_ints # only useful when targeting JS runtime - - avoid_null_checks_in_equality_operators - # - avoid_positional_boolean_parameters # not yet tested - # - avoid_private_typedef_functions # we prefer having typedef (discussion in https://github.com/flutter/flutter/pull/16356) - - avoid_relative_lib_imports - - avoid_renaming_method_parameters - # - avoid_return_types_on_setters # specified in analysis_options_base.yaml - # - avoid_returning_null # there are plenty of valid reasons to return null - # - avoid_returning_null_for_future # not yet tested - - avoid_returning_null_for_void - # - avoid_returning_this # there are plenty of valid reasons to return this - # - avoid_setters_without_getters # not yet tested - # - avoid_shadowing_type_parameters # not yet tested - # - avoid_single_cascade_in_expression_statements # not yet tested - - avoid_slow_async_io - - avoid_types_as_parameter_names - # - avoid_types_on_closure_parameters # conflicts with always_specify_types - - avoid_unused_constructor_parameters - - avoid_void_async - # - await_only_futures # specified in analysis_options_base.yaml - # - camel_case_types # specified in analysis_options_base.yaml - # - cancel_subscriptions # specified in analysis_options_base.yaml - # - cascade_invocations # not yet tested - # - close_sinks # not reliable enough - # - comment_references # blocked on https://github.com/flutter/flutter/issues/20765 - # - constant_identifier_names # needs an opt-out https://github.com/dart-lang/linter/issues/204 - # - control_flow_in_finally # specified in analysis_options_base.yaml - # - curly_braces_in_flow_control_structures # not yet tested - - directives_ordering - - empty_catches - # - empty_constructor_bodies # specified in analysis_options_base.yaml - # - empty_statements # specified in analysis_options_base.yaml - # - file_names # not yet tested - - flutter_style_todos - # - hash_and_equals # specified in analysis_options_base.yaml - # - implementation_imports # specified in analysis_options_base.yaml - # - invariant_booleans # too many false positives: https://github.com/dart-lang/linter/issues/811 - - iterable_contains_unrelated_type - # - join_return_with_assignment # not yet tested - # - library_names # specified in analysis_options_base.yaml - - library_prefixes - # - lines_longer_than_80_chars # not yet tested - - list_remove_unrelated_type - # - literal_only_boolean_expressions # too many false positives: https://github.com/dart-lang/sdk/issues/34181 - - no_adjacent_strings_in_list - - no_duplicate_case_values - # - non_constant_identifier_names # specified in analysis_options_base.yaml - # - null_closures # not yet tested - # - omit_local_variable_types # opposite of always_specify_types - # - one_member_abstracts # too many false positives - # - only_throw_errors # https://github.com/flutter/flutter/issues/5792 - - overridden_fields - # - package_api_docs # specified in analysis_options_base.yaml - # - package_names # specified in analysis_options_base.yaml - # - package_prefixed_library_names # specified in analysis_options_base.yaml - # - parameter_assignments # we do this commonly - - prefer_adjacent_string_concatenation - - prefer_asserts_in_initializer_lists - - 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 # not yet tested - - prefer_contains - - prefer_equal_for_default_values - # - prefer_expression_function_bodies # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#consider-using--for-short-functions-and-methods - - prefer_final_fields - - prefer_final_locals - - prefer_foreach - # - prefer_function_declarations_over_variables # not yet tested - - prefer_generic_function_type_aliases - - prefer_initializing_formals - # - prefer_int_literals # not yet tested - # - prefer_interpolation_to_compose_strings # not yet tested - - prefer_is_empty - # - prefer_is_not_empty # specified in analysis_options_base.yaml - - prefer_iterable_whereType - # - prefer_mixin # https://github.com/dart-lang/language/issues/32 - - prefer_single_quotes - - prefer_typing_uninitialized_variables - - prefer_void_to_null - # - public_member_api_docs # enabled on a case-by-case basis; see e.g. packages/analysis_options.yaml - - recursive_getters - # - slash_for_doc_comments # specified in analysis_options_base.yaml - - sort_constructors_first - - sort_pub_dependencies - - sort_unnamed_constructors_first - # - super_goes_last # specified in analysis_options_base.yaml - # - test_types_in_equals # specified in analysis_options_base.yaml - - throw_in_finally - # - type_annotate_public_apis # subset of always_specify_types - # - type_init_formals # specified in analysis_options_base.yaml - # - unawaited_futures # too many false positives - # - unnecessary_await_in_return # not yet tested - # - unnecessary_brace_in_string_interps # specified in analysis_options_base.yaml - - unnecessary_const - # - unnecessary_getters_setters # specified in analysis_options_base.yaml - # - unnecessary_lambdas # has false positives: https://github.com/dart-lang/linter/issues/498 - - unnecessary_new - - unnecessary_null_aware_assignments - - unnecessary_null_in_if_null_operators - - unnecessary_overrides - - unnecessary_parenthesis - # - unnecessary_statements # specified in analysis_options_base.yaml - - unnecessary_this - # - unrelated_type_equality_checks # specified in analysis_options_base.yaml - # - use_function_type_syntax_for_parameters # not yet tested - - use_rethrow_when_possible - # - use_setters_to_change_properties # not yet tested - # - use_string_buffers # has false positives: https://github.com/dart-lang/sdk/issues/34182 - # - use_to_and_as_if_applicable # has false positives, so we prefer to catch this by code-review - # - valid_regexps # specified in analysis_options_base.yaml - # - void_checks # not yet tested diff --git a/packages/flutter_analysis_options/lib/analysis_options_base.yaml b/packages/flutter_analysis_options/lib/analysis_options_base.yaml deleted file mode 100644 index a8f4cbced1..0000000000 --- a/packages/flutter_analysis_options/lib/analysis_options_base.yaml +++ /dev/null @@ -1,56 +0,0 @@ -# Specify analysis options. -# -# Until there are meta linter rules, each desired lint must be explicitly enabled. -# See: https://github.com/dart-lang/linter/issues/288 -# -# For a list of lints, see: http://dart-lang.github.io/linter/lints/ -# See the configuration guide for more -# https://github.com/dart-lang/sdk/tree/master/pkg/analyzer#configuring-the-analyzer -# -# This file contains the analysis options used by "flutter analyze" and the -# dartanalyzer when analyzing code outside the flutter repository. It isn't named -# 'analysis_options.yaml' because otherwise editors would use it when analyzing -# the flutter tool itself. -# -# When editing, keep in mind that this is imported by analysis_options.yaml. -# This file is meant to be a less strict subset of rules appropriate for most -# Flutter projects, but does not contain all of the lints that are used by the -# core Flutter repositories. - -analyzer: - errors: - # treat missing required parameters as a warning (not a hint) - missing_required_param: warning - -linter: - rules: - # these rules are documented on and in the same order as - # the Dart Lint rules page to make maintenance easier - # https://github.com/dart-lang/linter/blob/master/example/all.yaml - - avoid_empty_else - - avoid_init_to_null - - avoid_return_types_on_setters - - await_only_futures - - camel_case_types - - cancel_subscriptions - - control_flow_in_finally - - empty_constructor_bodies - - empty_statements - - hash_and_equals - - implementation_imports - - library_names - - non_constant_identifier_names - - package_api_docs - - package_names - - package_prefixed_library_names - - prefer_is_not_empty - - slash_for_doc_comments - - super_goes_last - - test_types_in_equals - - throw_in_finally - - type_init_formals - - unnecessary_brace_in_string_interps - - unnecessary_getters_setters - - unnecessary_statements - - unrelated_type_equality_checks - - valid_regexps diff --git a/packages/flutter_analysis_options/pubspec.yaml b/packages/flutter_analysis_options/pubspec.yaml deleted file mode 100644 index 28e00a314e..0000000000 --- a/packages/flutter_analysis_options/pubspec.yaml +++ /dev/null @@ -1,13 +0,0 @@ -name: flutter_analysis_options -author: Flutter Authors -description: The base and strict analysis options for the Flutter project. -homepage: http://flutter.io - -version: 1.0.0 -publish_to: none - -environment: - # The pub client defaults to an <2.0.0 sdk constraint which we need to explicitly overwrite. - sdk: ">=2.1.0 <3.0.0" - -# PUBSPEC CHECKSUM: 0000