Merge remote-tracking branch 'upstream/master' into implement-avoid-unnecessary-setstate

Author: incendial

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.vscode/settings.json

@@ -1,14 +1,17 @@
 {
+    "files.eol": "\n",
+    "files.insertFinalNewline": true,
     "cSpell.words": [
         "Backport",
-        "McCabe's",
         "Gitlab",
+        "McCabe's",
         "SLOC",
         "ansicolor",
         "codecov",
         "cyclomatic",
         "dartanalyzer",
         "dartdocs",
+        "dependabot",
         "dkrutskikh",
         "incendial",
         "lcov",

analysis_options.yaml

@@ -38,18 +38,20 @@ linter:
     #    - always_specify_types
     #    - always_use_package_imports
     - avoid_annotating_with_dynamic
-    #    - avoid_as
     - avoid_bool_literals_in_conditional_expressions
     - avoid_catches_without_on_clauses
     - avoid_catching_errors
     - avoid_classes_with_only_static_members
     - 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_implementing_value_types
     - avoid_js_rounded_ints
+    - avoid_multiple_declarations_per_line
     - avoid_positional_boolean_parameters
     #    - avoid_print
     - avoid_private_typedef_functions
@@ -60,21 +62,22 @@ linter:
     - avoid_returning_null_for_void
     - avoid_returning_this
     - avoid_setters_without_getters
-    - avoid_single_cascade_in_expression_statements
     - avoid_slow_async_io
+    - avoid_type_to_string
     - avoid_types_on_closure_parameters
     - avoid_unnecessary_containers
     - avoid_unused_constructor_parameters
     - avoid_void_async
     - avoid_web_libraries_in_flutter
-    - await_only_futures
     - camel_case_types
     - cancel_subscriptions
     - cascade_invocations
+    #    - cast_nullable_to_non_nullable
     - close_sinks
     - comment_references
     - constant_identifier_names
     - control_flow_in_finally
+    - deprecated_consistency
     - diagnostic_describe_all_properties
     - directives_ordering
     - do_not_use_environment
@@ -97,6 +100,7 @@ linter:
     - no_logic_in_create_state
     - no_runtimeType_toString
     - non_constant_identifier_names
+    - null_check_on_nullable_type_parameter
     #    - one_member_abstracts
     - only_throw_errors
     - overridden_fields
@@ -119,7 +123,6 @@ linter:
     - prefer_function_declarations_over_variables
     - prefer_if_elements_to_conditional_expressions
     - prefer_initializing_formals
-    - prefer_inlined_adds
     - prefer_int_literals
     - prefer_interpolation_to_compose_strings
     - prefer_is_not_operator
@@ -131,31 +134,31 @@ linter:
     - provide_deprecation_message
     #    - public_member_api_docs
     - sized_box_for_whitespace
-    - 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
     - unnecessary_await_in_return
-    - unnecessary_brace_in_string_interps
     #    - unnecessary_final
-    - unnecessary_getters_setters
     - unnecessary_lambdas
     - unnecessary_null_aware_assignments
+    - unnecessary_null_checks
     - unnecessary_nullable_for_final_variable_declarations
     - unnecessary_overrides
     - unnecessary_parenthesis
     - unnecessary_raw_strings
     - unnecessary_statements
     - unnecessary_string_escapes
     - unnecessary_string_interpolations
-    - unsafe_html
-    - use_full_hex_values_for_flutter_colors
+    - use_build_context_synchronously
+    - use_if_null_to_convert_nulls_to_bools
     - 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_setters_to_change_properties
     - use_string_buffers

doc/rules/avoid-returning-widgets.md

@@ -8,7 +8,10 @@ avoid-returning-widgets
 
 ## Description
 
-Warns when a method or function returns a Widget or subclass of a Widget (**Note** `build` method will not trigger the rule).
+Warns when a method or function returns a Widget or subclass of a Widget. The following patterns will not trigger the rule:
+
+- Widget `build` method overrides.
+- Functions with [functional_widget](https://pub.dev/packages/functional_widget) package annotations.
 
 Extracting widgets to a method is considered as a Flutter anti-pattern, because when Flutter rebuilds widget tree, it calls the function all the time, making more processor time for the operations.
 
@@ -21,7 +24,7 @@ Additional resources:
 * <https://www.reddit.com/r/FlutterDev/comments/avhvco/extracting_widgets_to_a_function_is_not_an/>
 * <https://medium.com/flutter-community/splitting-widgets-to-methods-is-a-performance-antipattern-16aa3fb4026c>
 
-Use `ignored-names` configuration, if you want to ignore a function or method name. For example:
+Use `ignored-names` configuration, if you want to ignore a function or method name. Use `ignored-annotations` configuration, if you want to override default ignored annotation list. For example:
 
 ### Config example
 
@@ -33,9 +36,11 @@ dart_code_metrics:
     - avoid-returning-widgets:
         ignored-names:
           - testFunction
+        ignored-annotations:
+          - allowedAnnotation
 ```
 
-will ignore all functions named `testFunction`.
+will ignore all functions named `testFunction` and all functions having `allowedAnnotation` annotation.
 
 ### Example
 

doc/rules/member-ordering-extended.md

@@ -1,4 +1,4 @@
-# Member ordering
+# Member ordering extended
 
 ![Configurable](https://img.shields.io/badge/-configurable-informational)
 

lib/src/analyzers/lint_analyzer/rules/rules_list/avoid_returning_widgets/avoid_returning_widgets.dart

@@ -20,9 +20,11 @@ class AvoidReturningWidgetsRule extends Rule {
   static const _warningMessage = 'Avoid returning widgets from a function.';
 
   final Iterable<String> _ignoredNames;
+  final Iterable<String> _ignoredAnnotations;
 
   AvoidReturningWidgetsRule([Map<String, Object> config = const {}])
       : _ignoredNames = _ConfigParser.getIgnoredNames(config),
+        _ignoredAnnotations = _ConfigParser.getIgnoredAnnotations(config),
         super(
           id: ruleId,
           documentation: const RuleDocumentation(
@@ -36,7 +38,7 @@ class AvoidReturningWidgetsRule extends Rule {
 
   @override
   Iterable<Issue> check(InternalResolvedUnitResult source) {
-    final _visitor = _Visitor(_ignoredNames);
+    final _visitor = _Visitor(_ignoredNames, _ignoredAnnotations);
 
     source.unit.visitChildren(_visitor);
 

lib/src/analyzers/lint_analyzer/rules/rules_list/avoid_returning_widgets/config_parser.dart

@@ -2,10 +2,26 @@ part of 'avoid_returning_widgets.dart';
 
 class _ConfigParser {
   static const _ignoredNamesConfig = 'ignored-names';
+  static const _ignoredAnnotationsConfig = 'ignored-annotations';
+
+  static const _defaultIgnoredAnnotations = [
+    'FunctionalWidget',
+    'swidget',
+    'hwidget',
+  ];
 
   static Iterable<String> getIgnoredNames(Map<String, Object> config) =>
-      config.containsKey(_ignoredNamesConfig) &&
-              config[_ignoredNamesConfig] is Iterable
-          ? List<String>.from(config[_ignoredNamesConfig] as Iterable)
-          : <String>[];
+      _getIterable(config, _ignoredNamesConfig) ?? [];
+
+  static Iterable<String> getIgnoredAnnotations(Map<String, Object> config) =>
+      _getIterable(config, _ignoredAnnotationsConfig) ??
+      _defaultIgnoredAnnotations;
+
+  static Iterable<String>? _getIterable(
+    Map<String, Object> config,
+    String name,
+  ) =>
+      config[name] is Iterable
+          ? List<String>.from(config[name] as Iterable)
+          : null;
 }

lib/src/analyzers/lint_analyzer/rules/rules_list/avoid_returning_widgets/visitor.dart

@@ -4,29 +4,51 @@ class _Visitor extends RecursiveAstVisitor<void> {
   final _declarations = <Declaration>[];
 
   final Iterable<String> _ignoredNames;
+  final Iterable<String> _ignoredAnnotations;
 
   Iterable<Declaration> get declarations => _declarations;
 
-  _Visitor(this._ignoredNames);
+  _Visitor(this._ignoredNames, this._ignoredAnnotations);
 
   @override
   void visitMethodDeclaration(MethodDeclaration node) {
     super.visitMethodDeclaration(node);
 
-    if (!node.isSetter && !_isIgnored(node.name.name)) {
-      final type = node.returnType?.type;
-      if (type != null && _hasWidgetType(type)) {
-        _declarations.add(node);
-      }
-    }
+    _visitDeclaration(
+      node,
+      node.name,
+      node.returnType,
+      isSetter: node.isSetter,
+    );
   }
 
   @override
   void visitFunctionDeclaration(FunctionDeclaration node) {
     super.visitFunctionDeclaration(node);
 
-    if (!node.isSetter && !_isIgnored(node.name.name)) {
-      final type = node.returnType?.type;
+    _visitDeclaration(
+      node,
+      node.name,
+      node.returnType,
+      isSetter: node.isSetter,
+    );
+  }
+
+  void _visitDeclaration(
+    Declaration node,
+    SimpleIdentifier name,
+    TypeAnnotation? returnType, {
+    required bool isSetter,
+  }) {
+    final hasIgnoredAnnotation = node.metadata.firstWhereOrNull(
+          (node) =>
+              _ignoredAnnotations.contains(node.name.name) &&
+              node.atSign.type.lexeme == '@',
+        ) !=
+        null;
+
+    if (!hasIgnoredAnnotation && !isSetter && !_isIgnored(name.name)) {
+      final type = returnType?.type;
       if (type != null && _hasWidgetType(type)) {
         _declarations.add(node);
       }

lib/src/analyzers/lint_analyzer/rules/rules_list/component_annotation_arguments_ordering/config_parser.dart

@@ -4,10 +4,9 @@ class _ConfigParser {
   static const _orderConfig = 'order';
 
   static List<_ArgumentGroup> parseOrder(Map<String, Object> config) {
-    final order =
-        config.containsKey(_orderConfig) && config[_orderConfig] is Iterable
-            ? List<String>.from(config[_orderConfig] as Iterable)
-            : <String>[];
+    final order = config[_orderConfig] is Iterable
+        ? List<String>.from(config[_orderConfig] as Iterable)
+        : <String>[];
 
     return order.isEmpty
         ? _ArgumentGroup._groupsOrder

lib/src/analyzers/lint_analyzer/rules/rules_list/member_ordering/config_parser.dart

@@ -4,10 +4,9 @@ class _ConfigParser {
   static const _orderConfig = 'order';
 
   static List<_MembersGroup> parseOrder(Map<String, Object> config) {
-    final order =
-        config.containsKey(_orderConfig) && config[_orderConfig] is Iterable
-            ? List<String>.from(config[_orderConfig] as Iterable)
-            : <String>[];
+    final order = config[_orderConfig] is Iterable
+        ? List<String>.from(config[_orderConfig] as Iterable)
+        : <String>[];
 
     return order.isEmpty
         ? _MembersGroup._groupsOrder

lib/src/analyzers/lint_analyzer/rules/rules_list/member_ordering_extended/config_parser.dart

@@ -20,7 +20,7 @@ class _ConfigParser {
   );
 
   static List<_MemberGroup> parseOrder(Map<String, Object> config) {
-    final order = config.containsKey('order') && config['order'] is Iterable
+    final order = config['order'] is Iterable
         ? List<String>.from(config['order'] as Iterable)
         : _defaultOrderList;
 

lib/src/config_builder/config_builder.dart

@@ -13,7 +13,7 @@ class ConfigBuilder {
   static const _defaultSkippedFolders = [
     'ios/',
     '.dart_tool/**',
-    'packages/**'
+    'packages/**',
   ];
 
   static Config getConfig(