Merge pull request #444 from AhmedLSayed9/update_analysis_options

Update lint rules to match flutter's new lint set

Author: AhmedLSayed9

analysis_options.yaml

@@ -1,21 +1,23 @@
 # Lint rules of flutter/packages with some modifications.
 #
 # This file is a copy of analysis_options.yaml from flutter repo
-# as of 2022-07-27, but with some modifications marked with
+# as of 2023-12-18, but with some modifications marked with
 # "DIFFERENT FROM FLUTTER/FLUTTER" below. The file is expected to
 # be kept in sync with the master file from the flutter repo.
 
 analyzer:
   language:
     strict-casts: true
-    strict-raw-types: true
     strict-inference: true
+    strict-raw-types: true
   errors:
+    # deprecated_member_use: ignore # DIFFERENT FROM FLUTTER/FLUTTER: keep visible as migration signals.
     # allow self-reference to deprecated members (we do this because otherwise we have
     # to annotate every member in every test, assert, etc, when we deprecate something)
     deprecated_member_use_from_same_package: ignore
   exclude: # DIFFERENT FROM FLUTTER/FLUTTER
     # Ignore generated files
+    - "**/*.pb.dart"
     - "**/*.g.dart"
     - "**/*.mocks.dart" # Mockito @GenerateMocks
 
@@ -27,18 +29,18 @@ formatter:
 linter:
   rules:
     # This list is derived from the list of all available lints located at
-    # https://github.com/dart-lang/linter/blob/master/example/all.yaml
+    # https://github.com/dart-lang/linter/blob/main/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_specify_types # removed for redundancy: https://github.com/dart-lang/linter/issues/1848
+    # - always_specify_types  # removed for redundancy: https://github.com/dart-lang/linter/issues/1848
     # - always_use_package_imports # we do this commonly
     - annotate_overrides
     # - avoid_annotating_with_dynamic # conflicts with always_specify_types
     - avoid_bool_literals_in_conditional_expressions
     # - avoid_catches_without_on_clauses # blocked on https://github.com/dart-lang/linter/issues/3023
     # - avoid_catching_errors # blocked on https://github.com/dart-lang/linter/issues/3023
-    # - avoid_classes_with_only_static_members: false # False positive for custom enum-like classes (such as Flutter's "Colors")
+    # - avoid_classes_with_only_static_members # we do this commonly for `abstract final class`es
     - avoid_double_and_int_checks
     - avoid_dynamic_calls
     - avoid_empty_else
@@ -47,11 +49,10 @@ linter:
     - avoid_field_initializers_in_const_classes
     # - avoid_final_parameters # incompatible with prefer_final_parameters
     - avoid_function_literals_in_foreach_calls
-    - avoid_implementing_value_types
+    # - avoid_implementing_value_types # see https://github.com/dart-lang/linter/issues/4558
     - avoid_init_to_null
     - avoid_js_rounded_ints
     # - avoid_multiple_declarations_per_line # seems to be a stylistic choice we don't subscribe to
-    - avoid_null_checks_in_equality_operators
     # - avoid_positional_boolean_parameters # would have been nice to enable this but by now there's too many places that break it
     - avoid_print
     # - avoid_private_typedef_functions # we prefer having typedef (discussion in https://github.com/flutter/flutter/pull/16356)
@@ -79,17 +80,20 @@ linter:
     # - cascade_invocations # doesn't match the typical style of this repo
     - cast_nullable_to_non_nullable
     # - close_sinks # not reliable enough
-    # - combinators_ordering # DIFFERENT FROM FLUTTER/FLUTTER: This isn't available on stable yet.
+    - collection_methods_unrelated_type
+    - combinators_ordering
     # - comment_references # blocked on https://github.com/dart-lang/linter/issues/1142
     - conditional_uri_does_not_exist
     # - 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
+    - dangling_library_doc_comments
     - depend_on_referenced_packages
     - deprecated_consistency
+    # - deprecated_member_use_from_same_package # we allow self-references to deprecated members
     # - diagnostic_describe_all_properties # enabled only at the framework level (packages/flutter/lib)
     - directives_ordering
-    # - discarded_futures # not yet tested
+    # - discarded_futures # too many false positives, similar to unawaited_futures
     # - do_not_use_environment # there are appropriate times to use the environment, especially in our tests and build logic
     - empty_catches
     - empty_constructor_bodies
@@ -100,30 +104,40 @@ linter:
     - flutter_style_todos
     - hash_and_equals
     - implementation_imports
-    - collection_methods_unrelated_type
+    - implicit_call_tearoffs
+    - implicit_reopen
+    - invalid_case_patterns
     # - join_return_with_assignment # not required by flutter style
     - leading_newlines_in_multiline_strings
+    - library_annotations
     - library_names
     - library_prefixes
     - library_private_types_in_public_api
     # - lines_longer_than_80_chars # not required by flutter style
-    # - literal_only_boolean_expressions # too many false positives: https://github.com/dart-lang/linter/issues/453
+    - literal_only_boolean_expressions
+    # - matching_super_parameters # blocked on https://github.com/dart-lang/language/issues/2509
+    - missing_code_block_language_in_doc_comment
     - missing_whitespace_between_adjacent_strings
-    - no_adjacent_strings_in_list
+    # - no_adjacent_strings_in_list # conflicts with prefer_adjacent_string_concatenation
     - no_default_cases
     - no_duplicate_case_values
     - no_leading_underscores_for_library_prefixes
     - no_leading_underscores_for_local_identifiers
+    - no_literal_bool_comparisons
     - no_logic_in_create_state
     - no_runtimeType_toString # DIFFERENT FROM FLUTTER/FLUTTER
+    - no_self_assignments
+    - no_wildcard_variable_uses
     - non_constant_identifier_names
     - noop_primitive_operations
     - null_check_on_nullable_type_parameter
     - null_closures
-    # - omit_local_variable_types # opposite of always_specify_types
+    # - omit_local_variable_types # conflicts with specify_nonobvious_local_variable_types
+    - omit_obvious_local_variable_types
     # - one_member_abstracts # too many false positives
     - only_throw_errors # this does get disabled in a few places where we have legacy code that uses strings et al
     - overridden_fields
+    # - package_api_docs # Deprecated (https://github.com/dart-lang/linter/issues/5107)
     - package_names
     - package_prefixed_library_names
     # - parameter_assignments # we do this commonly
@@ -139,11 +153,11 @@ linter:
     # - prefer_constructors_over_static_methods # far too many false positives
     - prefer_contains
     # - prefer_double_quotes # opposite of prefer_single_quotes
-    # - 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_expression_function_bodies # conflicts with https://github.com/flutter/flutter/blob/master/docs/contributing/Style-guide-for-Flutter-repo.md#consider-using--for-short-functions-and-methods
     - prefer_final_fields
     - prefer_final_in_for_each
     - prefer_final_locals
-    # - prefer_final_parameters # we should enable this one day when it can be auto-fixed (https://github.com/dart-lang/linter/issues/3104), see also parameter_assignments
+    # - prefer_final_parameters # adds too much verbosity
     - prefer_for_elements_to_map_fromIterable
     - prefer_foreach
     - prefer_function_declarations_over_variables
@@ -152,13 +166,13 @@ linter:
     - prefer_if_null_operators
     - prefer_initializing_formals
     - prefer_inlined_adds
-    # - prefer_int_literals # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#use-double-literals-for-double-constants
+    # - prefer_int_literals # conflicts with https://github.com/flutter/flutter/blob/master/docs/contributing/Style-guide-for-Flutter-repo.md#use-double-literals-for-double-constants
     - prefer_interpolation_to_compose_strings
     - prefer_is_empty
     - prefer_is_not_empty
     - prefer_is_not_operator
     - prefer_iterable_whereType
-    # - prefer_mixin # Has false positives, see https://github.com/dart-lang/linter/issues/3018
+    - prefer_mixin
     # - prefer_null_aware_method_calls # "call()" is confusing to people new to the language since it's not documented anywhere
     - prefer_null_aware_operators
     - prefer_relative_imports
@@ -169,28 +183,35 @@ linter:
     - provide_deprecation_message
     - public_member_api_docs # DIFFERENT FROM FLUTTER/FLUTTER
     - recursive_getters
-    # - require_trailing_commas # blocked on https://github.com/dart-lang/sdk/issues/47441
+    # - require_trailing_commas # would be nice, but requires a lot of manual work: 10,000+ code locations would need to be reformatted by hand after bulk fix is applied
     - secure_pubspec_urls
     - sized_box_for_whitespace
-    # - sized_box_shrink_expand # not yet tested
+    - sized_box_shrink_expand
     - slash_for_doc_comments
     - sort_child_properties_last
     - sort_constructors_first
+    # - sort_pub_dependencies
     - sort_unnamed_constructors_first
+    # - specify_nonobvious_local_variable_types # DIFFERENT FROM FLUTTER/FLUTTER: prefer not requiring explicit types for locals as hover/IDE shows them anyway.
+    - specify_nonobvious_property_types
     - test_types_in_equals
     - throw_in_finally
     - tighten_type_of_initializing_formals
-    - type_annotate_public_apis # subset of always_specify_types
+    - type_annotate_public_apis
     - type_init_formals
+    - type_literal_in_constant_pattern
+    - unintended_html_in_doc_comment # DIFFERENT FROM FLUTTER/FLUTTER: Disabled due to an issue that has been fixed, so just hasn't been adopted there yet.
     - unawaited_futures # DIFFERENT FROM FLUTTER/FLUTTER: It's disabled there for "too many false positives"; that's not an issue here, and missing awaits have caused production issues in plugins.
     - unnecessary_await_in_return
     - unnecessary_brace_in_string_interps
+    - unnecessary_breaks
     - unnecessary_const
     - unnecessary_constructor_name
     # - unnecessary_final # conflicts with prefer_final_locals
     - unnecessary_getters_setters
     # - unnecessary_lambdas # has false positives: https://github.com/dart-lang/linter/issues/498
     - unnecessary_late
+    - unnecessary_library_directive
     - unnecessary_new
     - unnecessary_null_aware_assignments
     - unnecessary_null_aware_operator_on_extension_on_nullable
@@ -205,11 +226,12 @@ linter:
     - unnecessary_string_interpolations
     - unnecessary_this
     - unnecessary_to_list_in_spreads
+    - unreachable_from_main
     - unrelated_type_equality_checks
     - use_build_context_synchronously
-    # - use_colored_box # not yet tested
-    # - use_decorated_box # not yet tested
-    # - use_enums # not yet tested
+    - use_colored_box
+    # - use_decorated_box # leads to bugs: DecoratedBox and Container are not equivalent (Container inserts extra padding)
+    - use_enums
     - use_full_hex_values_for_flutter_colors
     - use_function_type_syntax_for_parameters
     - use_if_null_to_convert_nulls_to_bools
@@ -221,6 +243,7 @@ linter:
     - use_rethrow_when_possible
     - use_setters_to_change_properties
     # - use_string_buffers # has false positives: https://github.com/dart-lang/sdk/issues/34182
+    - use_string_in_part_of_directives
     - use_super_parameters
     - use_test_throws_matchers
     # - use_to_and_as_if_applicable # has false positives, so we prefer to catch this by code-review

packages/dropdown_button2/lib/dropdown_button2.dart

@@ -1,3 +1 @@
-library dropdown_button2;
-
 export 'src/dropdown_button2.dart';

packages/dropdown_button2/lib/src/dropdown_button2.dart

@@ -448,7 +448,7 @@ class _DropdownButton2State<T> extends State<DropdownButton2<T>> with WidgetsBin
   // Using ValueNotifier for tracking when menu is open/close to update the button icon.
   final ValueNotifier<bool> _isMenuExpanded = ValueNotifier<bool>(false);
 
-  final _buttonRectKey = GlobalKey();
+  final GlobalKey<State<StatefulWidget>> _buttonRectKey = GlobalKey();
 
   // Using ValueNotifier for the Rect of DropdownButton so the dropdown menu listen and
   // update its position if DropdownButton's position has changed, as when keyboard open.
@@ -583,7 +583,7 @@ class _DropdownButton2State<T> extends State<DropdownButton2<T>> with WidgetsBin
       return;
     }
 
-    for (int itemIndex = 0; itemIndex < widget.items!.length; itemIndex++) {
+    for (var itemIndex = 0; itemIndex < widget.items!.length; itemIndex++) {
       if (widget.items![itemIndex].value == _currentValue) {
         _selectedIndex = itemIndex;
         return;
@@ -623,7 +623,7 @@ class _DropdownButton2State<T> extends State<DropdownButton2<T>> with WidgetsBin
       rootNavigator: _dropdownStyle.isFullScreen ?? _dropdownStyle.useRootNavigator,
     );
 
-    final RenderBox itemBox = _buttonRectKey.currentContext!.findRenderObject()! as RenderBox;
+    final itemBox = _buttonRectKey.currentContext!.findRenderObject()! as RenderBox;
     final Rect itemRect =
         itemBox.localToGlobal(Offset.zero, ancestor: navigator.context.findRenderObject()) &
         itemBox.size;
@@ -850,7 +850,7 @@ class _DropdownButton2State<T> extends State<DropdownButton2<T>> with WidgetsBin
     // We should explicitly type the items list to be a list of <Widget>,
     // otherwise, no explicit type adding items maybe trigger a crash/failure
     // when hint and selectedItemBuilder are provided.
-    final List<Widget> buttonItems = widget.selectedItemBuilder == null
+    final buttonItems = widget.selectedItemBuilder == null
         ? (widget.items != null ? List<Widget>.of(widget.items!) : <Widget>[])
         : List<Widget>.of(widget.selectedItemBuilder!(context));
 
@@ -968,7 +968,7 @@ class _DropdownButton2State<T> extends State<DropdownButton2<T>> with WidgetsBin
     );
 
     if (!DropdownButtonHideUnderline.at(context)) {
-      final double bottom = widget.isDense ? 0.0 : 8.0;
+      final bottom = widget.isDense ? 0.0 : 8.0;
       result = Stack(
         children: <Widget>[
           result,
@@ -1160,8 +1160,7 @@ class DropdownButtonFormField2<T> extends FormField<T> {
              : multiValueListenable?.value.lastOrNull,
          autovalidateMode: autovalidateMode ?? AutovalidateMode.disabled,
          builder: (FormFieldState<T> field) {
-           final _DropdownButtonFormField2State<T> state =
-               field as _DropdownButtonFormField2State<T>;
+           final state = field as _DropdownButtonFormField2State<T>;
            InputDecoration effectiveDecoration = (decoration ?? const InputDecoration())
                .applyDefaults(Theme.of(field.context).inputDecorationTheme);
 

packages/dropdown_button2/lib/src/dropdown_menu.dart

@@ -294,19 +294,19 @@ class _DropdownMenuPainter extends CustomPainter {
 
   @override
   void paint(Canvas canvas, Size size) {
-    final Tween<double> top = Tween<double>(
+    final top = Tween<double>(
       //Begin at 0.0 instead of selectedItemOffset so that the menu open animation
       //always start from top to bottom instead of starting from the selected item
       begin: 0.0,
       end: 0.0,
     );
 
-    final Tween<double> bottom = Tween<double>(
+    final bottom = Tween<double>(
       begin: clampDouble(top.begin! + itemHeight, math.min(itemHeight, size.height), size.height),
       end: size.height,
     );
 
-    final Rect rect = Rect.fromLTRB(0.0, top.evaluate(resize), size.width, bottom.evaluate(resize));
+    final rect = Rect.fromLTRB(0.0, top.evaluate(resize), size.width, bottom.evaluate(resize));
 
     _painter.paint(
       canvas,

packages/dropdown_button2/lib/src/dropdown_route.dart

@@ -211,7 +211,7 @@ class _DropdownRoute<T> extends PopupRoute<_DropdownRouteResult<T>> {
     bool Function(DropdownItem<T> item)? itemPredicate,
   }) {
     var itemsHeight = 0.0;
-    for (int i = 0; i < index; i++) {
+    for (var i = 0; i < index; i++) {
       if (itemPredicate == null || itemPredicate(items[i])) {
         itemsHeight += _itemHeightWithSeparator(i);
       }
@@ -223,7 +223,7 @@ class _DropdownRoute<T> extends PopupRoute<_DropdownRouteResult<T>> {
     final double paddingTop = dropdownStyle.padding != null
         ? dropdownStyle.padding!.resolve(null).top
         : kMaterialListPadding.top;
-    double offset = paddingTop;
+    var offset = paddingTop;
 
     if (items.isNotEmpty && index > 0) {
       if (searchData?.searchController?.text case final searchText?) {
@@ -279,7 +279,7 @@ class _DropdownRoute<T> extends PopupRoute<_DropdownRouteResult<T>> {
     final double menuHeight = math.min(maxHeight, actualMenuHeight);
 
     // The computed top and bottom of the menu
-    double menuTop = menuAnchoredTop;
+    var menuTop = menuAnchoredTop;
     double menuBottom = menuTop + menuHeight;
 
     // If the computed top or bottom of the menu are outside of the range
@@ -633,7 +633,7 @@ class _DropdownBarrierPainter extends CustomPainter {
       canvas.saveLayer(pageRect, Paint());
       canvas.drawRect(pageRect, Paint()..color = barrierColor!);
 
-      final RRect buttonRRect = RRect.fromRectAndCorners(
+      final buttonRRect = RRect.fromRectAndCorners(
         buttonRect,
         topLeft: buttonBorderRadius.topLeft,
         topRight: buttonBorderRadius.topRight,