Fix doc comment references among other new lints (#253)

Bump min SDK to 2.18

Author: kevmoo

.github/workflows/ci.yml

@@ -46,7 +46,7 @@ jobs:
       matrix:
         # Add macos-latest and/or windows-latest if relevant for this package.
         os: [ubuntu-latest]
-        sdk: [2.12.0, dev]
+        sdk: [2.18.0, dev]
     steps:
       - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
       - uses: dart-lang/setup-dart@6a218f2413a3e78e9087f638a238f6b40893203d

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.17.1-dev
+
+* Require Dart 2.18
+
 ## 1.17.0
 
 * Add `Iterable.elementAtOrNull` and `List.elementAtOrNull` extension methods.

analysis_options.yaml

@@ -1,14 +1,29 @@
 include: package:lints/recommended.yaml
 
+analyzer:
+  language:
+    strict-casts: true
+
 linter:
   rules:
+    - always_declare_return_types
     - avoid_dynamic_calls
-
-    # Errors
+    - avoid_unused_constructor_parameters
+    - cancel_subscriptions
+    - directives_ordering
+    - lines_longer_than_80_chars
+    - literal_only_boolean_expressions
+    - missing_whitespace_between_adjacent_strings
+    - no_adjacent_strings_in_list
+    - no_runtimeType_toString
+    - omit_local_variable_types
+    - package_api_docs
+    - prefer_relative_imports
+    - prefer_single_quotes
     - test_types_in_equals
     - throw_in_finally
-
-    # Style
-    - avoid_private_typedef_functions
-    - directives_ordering
-    - only_throw_errors
+    - type_annotate_public_apis
+    - unawaited_futures
+    - unnecessary_await_in_return
+    - unnecessary_lambdas
+    - use_super_parameters

lib/src/algorithms.dart

@@ -65,8 +65,8 @@ int binarySearchBy<E, K>(List<E> sortedList, K Function(E element) keyOf,
 /// If [compare] is omitted, this defaults to calling [Comparable.compareTo] on
 /// the objects. In this case, the objects must be [Comparable].
 ///
-/// Returns [sortedList.length] if all the items in [sortedList] compare less
-/// than [value].
+/// Returns the length of [sortedList] if all the items in [sortedList] compare
+/// less than [value].
 int lowerBound<E>(List<E> sortedList, E value, {int Function(E, E)? compare}) {
   compare ??= defaultCompare;
   return lowerBoundBy<E, E>(sortedList, identity, compare, value);
@@ -76,11 +76,13 @@ int lowerBound<E>(List<E> sortedList, E value, {int Function(E, E)? compare}) {
 ///
 /// Uses binary search to find the location of [value].
 /// This takes on the order of `log(n)` comparisons.
-/// Elements are compared using the [compare] function of the [keyOf] property of
-/// the elements.
-/// If the list isn't sorted according to this order, the result is unpredictable.
+/// Elements are compared using the [compare] function of the [keyOf] property
+/// of the elements.
+/// If the list isn't sorted according to this order, the result is
+/// unpredictable.
 ///
-/// Returns [sortedList.length] if all the items in [sortedList] are before [value].
+/// Returns the length of [sortedList] if all the items in [sortedList] are
+/// before [value].
 ///
 /// If [start] and [end] are supplied, only that range is searched,
 /// and only that range need to be sorted.
@@ -231,12 +233,12 @@ void mergeSort<E>(List<E> elements,
   var secondLength = end - middle;
   // secondLength is always the same as firstLength, or one greater.
   var scratchSpace = List<E>.filled(secondLength, elements[start]);
-  E Function(E) id = identity;
-  _mergeSort(elements, id, compare, middle, end, scratchSpace, 0);
+  _mergeSort(elements, identity<E>, compare, middle, end, scratchSpace, 0);
   var firstTarget = end - firstLength;
-  _mergeSort(elements, id, compare, start, middle, elements, firstTarget);
-  _merge(id, compare, elements, firstTarget, end, scratchSpace, 0, secondLength,
-      elements, start);
+  _mergeSort(
+      elements, identity<E>, compare, start, middle, elements, firstTarget);
+  _merge(identity<E>, compare, elements, firstTarget, end, scratchSpace, 0,
+      secondLength, elements, start);
 }
 
 /// Sort [elements] using a merge-sort algorithm.
@@ -408,7 +410,7 @@ void quickSort<E>(List<E> elements, int Function(E a, E b) compare,
   _quickSort<E, E>(elements, identity, compare, Random(), start, end);
 }
 
-/// Sort [elements] using a quick-sort algorithm.
+/// Sort [list] using a quick-sort algorithm.
 ///
 /// The elements are compared using [compare] on the value provided by [keyOf]
 /// on the element.

lib/src/boollist.dart

@@ -74,8 +74,9 @@ abstract class BoolList with ListMixin<bool> {
 
   /// Generates a [BoolList] of values.
   ///
-  /// Creates a [BoolList] with [length] positions and fills it with values created by
-  /// calling [generator] for each index in the range `0` .. `length - 1` in increasing order.
+  /// Creates a [BoolList] with [length] positions and fills it with values
+  /// created by calling [generator] for each index in the range
+  /// `0` .. `length - 1` in increasing order.
   ///
   /// The created list is fixed-length unless [growable] is true.
   factory BoolList.generate(

lib/src/canonicalized_map.dart

@@ -129,7 +129,7 @@ class CanonicalizedMap<C, K, V> implements Map<K, V> {
   void removeWhere(bool Function(K key, V value) test) =>
       _base.removeWhere((_, pair) => test(pair.key, pair.value));
 
-  @Deprecated("Use cast instead")
+  @Deprecated('Use cast instead')
   Map<K2, V2> retype<K2, V2>() => cast<K2, V2>();
 
   @override

lib/src/combined_wrappers/combined_iterable.dart

@@ -17,7 +17,7 @@ class CombinedIterableView<T> extends IterableBase<T> {
   /// The iterables that this combines.
   final Iterable<Iterable<T>> _iterables;
 
-  /// Creates a combined view of [iterables].
+  /// Creates a combined view of [_iterables].
   const CombinedIterableView(this._iterables);
 
   @override

lib/src/combined_wrappers/combined_list.dart

@@ -24,7 +24,7 @@ class CombinedListView<T> extends ListBase<T>
   /// The lists that this combines.
   final List<List<T>> _lists;
 
-  /// Creates a combined view of [lists].
+  /// Creates a combined view of [_lists].
   CombinedListView(this._lists);
 
   @override

lib/src/combined_wrappers/combined_map.dart

@@ -40,11 +40,11 @@ class CombinedMapView<K, V> extends UnmodifiableMapBase<K, V> {
     return null;
   }
 
-  /// The keys of [this].
+  /// The keys of `this`.
   ///
   /// The returned iterable has efficient `contains` operations, assuming the
-  /// iterables returned by the wrapped maps have efficient `contains` operations
-  /// for their `keys` iterables.
+  /// iterables returned by the wrapped maps have efficient `contains`
+  /// operations for their `keys` iterables.
   ///
   /// The `length` must do deduplication and thus is not optimized.
   ///

lib/src/empty_unmodifiable_set.dart

@@ -4,7 +4,8 @@
 
 import 'dart:collection';
 
-import 'package:collection/collection.dart';
+import 'unmodifiable_wrappers.dart';
+import 'wrappers.dart';
 
 /// An unmodifiable, empty set which can be constant.
 class EmptyUnmodifiableSet<E> extends IterableBase<E>
@@ -26,7 +27,7 @@ class EmptyUnmodifiableSet<E> extends IterableBase<E>
   Iterable<E> followedBy(Iterable<E> other) => DelegatingIterable(other);
   @override
   E? lookup(Object? element) => null;
-  @Deprecated("Use cast instead")
+  @Deprecated('Use cast instead')
   @override
   EmptyUnmodifiableSet<T> retype<T>() => EmptyUnmodifiableSet<T>();
   @override