Fix comment reference issues, among other new lints (#119)

Author: kevmoo

analysis_options.yaml

@@ -1,3 +1,4 @@
+# https://dart.dev/guides/language/analysis-options
 include: package:lints/recommended.yaml
 
 analyzer:
@@ -8,9 +9,14 @@ analyzer:
 linter:
   rules:
     - always_declare_return_types
+    - avoid_catching_errors
+    - avoid_dynamic_calls
     - avoid_private_typedef_functions
+    - avoid_redundant_argument_values
     - avoid_unused_constructor_parameters
+    - avoid_void_async
     - cancel_subscriptions
+    - comment_references
     - directives_ordering
     - lines_longer_than_80_chars
     - literal_only_boolean_expressions
@@ -19,12 +25,20 @@ linter:
     - no_runtimeType_toString
     - omit_local_variable_types
     - package_api_docs
+    - prefer_asserts_in_initializer_lists
+    - prefer_const_constructors
+    - prefer_const_declarations
     - prefer_relative_imports
     - prefer_single_quotes
+    - sort_pub_dependencies
     - test_types_in_equals
     - throw_in_finally
     - type_annotate_public_apis
     - unawaited_futures
     - unnecessary_await_in_return
     - unnecessary_lambdas
+    - unnecessary_parenthesis
+    - unnecessary_statements
+    - use_is_even_rather_than_modulo
+    - use_string_buffers
     - use_super_parameters

example/example.dart

@@ -7,7 +7,7 @@ void main() {
 }
 
 void _scheduleAsync() {
-  Future.delayed(Duration(seconds: 1)).then((_) => _runAsync());
+  Future.delayed(const Duration(seconds: 1)).then((_) => _runAsync());
 }
 
 void _runAsync() {

lib/src/chain.dart

@@ -21,7 +21,7 @@ final _specKey = Object();
 /// A chain of stack traces.
 ///
 /// A stack chain is a collection of one or more stack traces that collectively
-/// represent the path from [main] through nested function calls to a particular
+/// represent the path from `main` through nested function calls to a particular
 /// code location, usually where an error was thrown. Multiple stack traces are
 /// necessary when using asynchronous functions, since the program's stack is
 /// reset before each asynchronous callback is run.
@@ -189,21 +189,19 @@ class Chain implements StackTrace {
   /// Returns a new [Chain] comprised of [traces].
   Chain(Iterable<Trace> traces) : traces = List<Trace>.unmodifiable(traces);
 
-  /// Returns a terser version of [this].
+  /// Returns a terser version of this chain.
   ///
   /// This calls [Trace.terse] on every trace in [traces], and discards any
   /// trace that contain only internal frames.
   ///
   /// This won't do anything with a raw JavaScript trace, since there's no way
   /// to determine which frames come from which Dart libraries. However, the
-  /// [`source_map_stack_trace`][source_map_stack_trace] package can be used to
-  /// convert JavaScript traces into Dart-style traces.
-  ///
-  /// [source_map_stack_trace]: https://pub.dev/packages/source_map_stack_trace
+  /// [`source_map_stack_trace`](https://pub.dev/packages/source_map_stack_trace)
+  /// package can be used to convert JavaScript traces into Dart-style traces.
   Chain get terse => foldFrames((_) => false, terse: true);
 
-  /// Returns a new [Chain] based on [this] where multiple stack frames matching
-  /// [predicate] are folded together.
+  /// Returns a new [Chain] based on this chain where multiple stack frames
+  /// matching [predicate] are folded together.
   ///
   /// This means that whenever there are multiple frames in a row that match
   /// [predicate], only the last one is kept. In addition, traces that are
@@ -239,7 +237,7 @@ class Chain implements StackTrace {
     return Chain(nonEmptyTraces);
   }
 
-  /// Converts [this] to a [Trace].
+  /// Converts this chain to a [Trace].
   ///
   /// The trace version of a chain is just the concatenation of all the traces
   /// in the chain.
@@ -248,18 +246,19 @@ class Chain implements StackTrace {
   @override
   String toString() {
     // Figure out the longest path so we know how much to pad.
-    var longest = traces.map((trace) {
-      return trace.frames
-          .map((frame) => frame.location.length)
-          .fold(0, math.max);
-    }).fold(0, math.max);
+    var longest = traces
+        .map((trace) => trace.frames
+            .map((frame) => frame.location.length)
+            .fold(0, math.max))
+        .fold(0, math.max);
 
     // Don't call out to [Trace.toString] here because that doesn't ensure that
     // padding is consistent across all traces.
-    return traces.map((trace) {
-      return trace.frames.map((frame) {
-        return '${frame.location.padRight(longest)}  ${frame.member}\n';
-      }).join();
-    }).join(chainGap);
+    return traces
+        .map((trace) => trace.frames
+            .map((frame) =>
+                '${frame.location.padRight(longest)}  ${frame.member}\n')
+            .join())
+        .join(chainGap);
   }
 }

lib/src/stack_zone_specification.dart

@@ -64,15 +64,13 @@ class StackZoneSpecification {
   StackZoneSpecification(this._onError, {bool errorZone = true})
       : _errorZone = errorZone;
 
-  /// Converts [this] to a real [ZoneSpecification].
-  ZoneSpecification toSpec() {
-    return ZoneSpecification(
-        handleUncaughtError: _errorZone ? _handleUncaughtError : null,
-        registerCallback: _registerCallback,
-        registerUnaryCallback: _registerUnaryCallback,
-        registerBinaryCallback: _registerBinaryCallback,
-        errorCallback: _errorCallback);
-  }
+  /// Converts this specification to a real [ZoneSpecification].
+  ZoneSpecification toSpec() => ZoneSpecification(
+      handleUncaughtError: _errorZone ? _handleUncaughtError : null,
+      registerCallback: _registerCallback,
+      registerUnaryCallback: _registerUnaryCallback,
+      registerBinaryCallback: _registerBinaryCallback,
+      errorCallback: _errorCallback);
 
   /// Returns the current stack chain.
   ///
@@ -107,7 +105,7 @@ class StackZoneSpecification {
     }
   }
 
-  /// Tracks the current stack chain so it can be set to [_currentChain] when
+  /// Tracks the current stack chain so it can be set to [_currentNode] when
   /// [f] is run.
   ZoneCallback<R> _registerCallback<R>(
       Zone self, ZoneDelegate parent, Zone zone, R Function() f) {
@@ -116,27 +114,25 @@ class StackZoneSpecification {
     return parent.registerCallback(zone, () => _run(f, node));
   }
 
-  /// Tracks the current stack chain so it can be set to [_currentChain] when
+  /// Tracks the current stack chain so it can be set to [_currentNode] when
   /// [f] is run.
   ZoneUnaryCallback<R, T> _registerUnaryCallback<R, T>(
       Zone self, ZoneDelegate parent, Zone zone, R Function(T) f) {
     if (_disabled) return parent.registerUnaryCallback(zone, f);
     var node = _createNode(1);
-    return parent.registerUnaryCallback(zone, (arg) {
-      return _run(() => f(arg), node);
-    });
+    return parent.registerUnaryCallback(
+        zone, (arg) => _run(() => f(arg), node));
   }
 
-  /// Tracks the current stack chain so it can be set to [_currentChain] when
+  /// Tracks the current stack chain so it can be set to [_currentNode] when
   /// [f] is run.
   ZoneBinaryCallback<R, T1, T2> _registerBinaryCallback<R, T1, T2>(
       Zone self, ZoneDelegate parent, Zone zone, R Function(T1, T2) f) {
     if (_disabled) return parent.registerBinaryCallback(zone, f);
 
     var node = _createNode(1);
-    return parent.registerBinaryCallback(zone, (arg1, arg2) {
-      return _run(() => f(arg1, arg2), node);
-    });
+    return parent.registerBinaryCallback(
+        zone, (arg1, arg2) => _run(() => f(arg1, arg2), node));
   }
 
   /// Looks up the chain associated with [stackTrace] and passes it either to

lib/src/trace.dart

@@ -94,12 +94,13 @@ class Trace implements StackTrace {
     }
 
     var trace = Trace.from(StackTrace.current);
-    return LazyTrace(() {
-      // JS includes a frame for the call to StackTrace.current, but the VM
-      // doesn't, so we skip an extra frame in a JS context.
-      return Trace(trace.frames.skip(level + (inJS ? 2 : 1)),
-          original: trace.original.toString());
-    });
+    return LazyTrace(
+      () =>
+          // JS includes a frame for the call to StackTrace.current, but the VM
+          // doesn't, so we skip an extra frame in a JS context.
+          Trace(trace.frames.skip(level + (inJS ? 2 : 1)),
+              original: trace.original.toString()),
+    );
   }
 
   /// Returns a new stack trace containing the same data as [trace].
@@ -250,7 +251,7 @@ class Trace implements StackTrace {
   /// platform is being used.
   StackTrace get vmTrace => VMTrace(frames);
 
-  /// Returns a terser version of [this].
+  /// Returns a terser version of this trace.
   ///
   /// This is accomplished by folding together multiple stack frames from the
   /// core library or from this package, as in [foldFrames]. Remaining core
@@ -260,15 +261,13 @@ class Trace implements StackTrace {
   ///
   /// This won't do anything with a raw JavaScript trace, since there's no way
   /// to determine which frames come from which Dart libraries. However, the
-  /// [`source_map_stack_trace`][source_map_stack_trace] package can be used to
-  /// convert JavaScript traces into Dart-style traces.
-  ///
-  /// [source_map_stack_trace]: https://pub.dev/packages/source_map_stack_trace
+  /// [`source_map_stack_trace`][https://pub.dev/packages/source_map_stack_trace]
+  /// package can be used to convert JavaScript traces into Dart-style traces.
   ///
   /// For custom folding, see [foldFrames].
   Trace get terse => foldFrames((_) => false, terse: true);
 
-  /// Returns a new [Trace] based on [this] where multiple stack frames matching
+  /// Returns a new [Trace] based on `this` where multiple stack frames matching
   /// [predicate] are folded together.
   ///
   /// This means that whenever there are multiple frames in a row that match

lib/src/utils.dart

@@ -12,4 +12,4 @@ final vmChainGap = RegExp(r'^<asynchronous suspension>\n?$', multiLine: true);
 
 // TODO(nweiz): When cross-platform imports work, use them to set this.
 /// Whether we're running in a JS context.
-final bool inJS = 0.0 is int;
+const bool inJS = 0.0 is int;

test/chain/chain_test.dart

@@ -103,7 +103,7 @@ void main() {
       test("doesn't enable chain-tracking", () {
         return Chain.disable(() {
           return Chain.capture(() {
-            var completer = Completer();
+            var completer = Completer<Chain>();
             inMicrotask(() {
               completer.complete(Chain.current());
             });
@@ -126,7 +126,7 @@ void main() {
   group('Chain.disable()', () {
     test('disables chain-tracking', () {
       return Chain.disable(() {
-        var completer = Completer();
+        var completer = Completer<Chain>();
         inMicrotask(() => completer.complete(Chain.current()));
 
         return completer.future.then((chain) {
@@ -138,7 +138,7 @@ void main() {
     test('Chain.capture() re-enables chain-tracking', () {
       return Chain.disable(() {
         return Chain.capture(() {
-          var completer = Completer();
+          var completer = Completer<Chain>();
           inMicrotask(() => completer.complete(Chain.current()));
 
           return completer.future.then((chain) {
@@ -173,7 +173,7 @@ void main() {
     test("with when: false doesn't disable", () {
       return Chain.capture(() {
         return Chain.disable(() {
-          var completer = Completer();
+          var completer = Completer<Chain>();
           inMicrotask(() => completer.complete(Chain.current()));
 
           return completer.future.then((chain) {