Update to and fix latest lints (#1335)

Author: kevmoo

analysis_options.yaml

@@ -1,6 +1,5 @@
-include: package:lints/recommended.yaml
-linter:
-  rules:
-    - avoid_dynamic_calls
-    - directives_ordering
-    - unawaited_futures
+include: package:dart_flutter_team_lints/analysis_options.yaml
+
+analyzer:
+  errors:
+    comment_references: ignore

benchmark/benchmark.dart

@@ -13,8 +13,8 @@ const _formatsPerTrial = 30;
 /// Note, these files use ".txt" because while they can be *parsed* correctly,
 /// they don't resolve without error. That's OK because the formatter doesn't
 /// care about that.
-final source = loadFile('before.dart.txt');
-final expected = loadFile('after.dart.txt');
+final source = _loadFile('before.dart.txt');
+final expected = _loadFile('after.dart.txt');
 
 void main(List<String> args) {
   var best = 99999999.0;
@@ -27,7 +27,7 @@ void main(List<String> args) {
     // For a single benchmark, format the source multiple times.
     String? result;
     for (var j = 0; j < _formatsPerTrial; j++) {
-      result = formatSource();
+      result = _formatSource();
     }
 
     var elapsed =
@@ -47,32 +47,23 @@ void main(List<String> args) {
     // Don't print the first run. It's always terrible since the VM hasn't
     // warmed up yet.
     if (i == 0) continue;
-    printResult("Run ${padLeft('#$i', 3)}", elapsed);
+    _printResult("Run ${'#$i'.padLeft(3)}", elapsed);
   }
 
-  printResult('Best   ', best);
+  _printResult('Best   ', best);
 }
 
-String loadFile(String name) {
+String _loadFile(String name) {
   var path = p.join(p.dirname(p.fromUri(Platform.script)), name);
   return File(path).readAsStringSync();
 }
 
-void printResult(String label, double time) {
-  print('$label: ${padLeft(time.toStringAsFixed(2), 4)}ms '
+void _printResult(String label, double time) {
+  print('$label: ${time.toStringAsFixed(2).padLeft(4)}ms '
       "${'=' * ((time * 5).toInt())}");
 }
 
-String padLeft(input, int length) {
-  var result = input.toString();
-  if (result.length < length) {
-    result = ' ' * (length - result.length) + result;
-  }
-
-  return result;
-}
-
-String formatSource() {
+String _formatSource() {
   var formatter = DartFormatter();
   return formatter.format(source);
 }

bin/format.dart

@@ -25,17 +25,17 @@ void main(List<String> args) async {
     usageError(parser, err.message);
   }
 
-  if (argResults['help']) {
+  if (argResults['help'] as bool) {
     printUsage(parser);
     return;
   }
 
-  if (argResults['version']) {
+  if (argResults['version'] as bool) {
     print(dartStyleVersion);
     return;
   }
 
-  if (argResults['verbose'] && !(argResults['help'] as bool)) {
+  if (argResults['verbose'] as bool && !(argResults['help'] as bool)) {
     usageError(parser, 'Can only use --verbose with --help.');
   }
 
@@ -46,7 +46,7 @@ void main(List<String> args) async {
     usageError(parser, exception.message);
   }
 
-  if (argResults['dry-run'] && argResults['overwrite']) {
+  if (argResults['dry-run'] as bool && argResults['overwrite'] as bool) {
     usageError(
         parser, 'Cannot use --dry-run and --overwrite at the same time.');
   }
@@ -61,13 +61,13 @@ void main(List<String> args) async {
   var summary = Summary.none;
   var output = Output.show;
   var setExitIfChanged = false;
-  if (argResults['dry-run']) {
+  if (argResults['dry-run'] as bool) {
     checkForReporterCollision('dry-run', 'overwrite');
     checkForReporterCollision('dry-run', 'machine');
 
     show = Show.dryRun;
     output = Output.none;
-  } else if (argResults['overwrite']) {
+  } else if (argResults['overwrite'] as bool) {
     checkForReporterCollision('overwrite', 'machine');
 
     if (argResults.rest.isEmpty) {
@@ -77,17 +77,17 @@ void main(List<String> args) async {
 
     show = Show.overwrite;
     output = Output.write;
-  } else if (argResults['machine']) {
+  } else if (argResults['machine'] as bool) {
     output = Output.json;
   }
 
-  if (argResults['profile']) summary = Summary.profile();
+  if (argResults['profile'] as bool) summary = Summary.profile();
 
-  setExitIfChanged = argResults['set-exit-if-changed'];
+  setExitIfChanged = argResults['set-exit-if-changed'] as bool;
 
   int pageWidth;
   try {
-    pageWidth = int.parse(argResults['line-length']);
+    pageWidth = int.parse(argResults['line-length'] as String);
   } on FormatException catch (_) {
     usageError(
         parser,
@@ -97,22 +97,22 @@ void main(List<String> args) async {
 
   int indent;
   try {
-    indent = int.parse(argResults['indent']);
-    if (indent < 0 || indent.toInt() != indent) throw FormatException();
+    indent = int.parse(argResults['indent'] as String);
+    if (indent < 0 || indent.toInt() != indent) throw const FormatException();
   } on FormatException catch (_) {
     usageError(
         parser,
         '--indent must be a non-negative integer, was '
         '"${argResults['indent']}".');
   }
 
-  var followLinks = argResults['follow-links'];
+  var followLinks = argResults['follow-links'] as bool;
 
   var fixes = <StyleFix>[];
-  if (argResults['fix']) fixes.addAll(StyleFix.all);
+  if (argResults['fix'] as bool) fixes.addAll(StyleFix.all);
   for (var fix in StyleFix.all) {
-    if (argResults['fix-${fix.name}']) {
-      if (argResults['fix']) {
+    if (argResults['fix-${fix.name}'] as bool) {
+      if (argResults['fix'] as bool) {
         usageError(parser, '--fix-${fix.name} is redundant with --fix.');
       }
 
@@ -133,7 +133,7 @@ void main(List<String> args) async {
       output: output,
       summary: summary,
       setExitIfChanged: setExitIfChanged,
-      experimentFlags: argResults['enable-experiment']);
+      experimentFlags: argResults['enable-experiment'] as List<String>);
 
   if (argResults.rest.isEmpty) {
     await formatStdin(options, selection, argResults['stdin-name'] as String);

example/format.dart

@@ -1,6 +1,7 @@
 // Copyright (c) 2015, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
+
 import 'package:dart_style/dart_style.dart';
 import 'package:dart_style/src/constants.dart';
 import 'package:dart_style/src/debug.dart' as debug;
@@ -16,48 +17,17 @@ void main(List<String> args) {
   debug.tracePieceBuilder = true;
   debug.traceSolver = true;
 
-  runTest('selection/selection.stmt', 2);
-}
-
-void formatStmt(String source, {required bool tall, int pageWidth = 80}) {
-  runFormatter(source, pageWidth, tall: tall, isCompilationUnit: false);
-}
-
-void formatUnit(String source, {required bool tall, int pageWidth = 80}) {
-  runFormatter(source, pageWidth, tall: tall, isCompilationUnit: true);
-}
-
-void runFormatter(String source, int pageWidth,
-    {required bool tall, required bool isCompilationUnit}) {
-  try {
-    var formatter = DartFormatter(
-        pageWidth: pageWidth,
-        experimentFlags: [if (tall) tallStyleExperimentFlag]);
-
-    String result;
-    if (isCompilationUnit) {
-      result = formatter.format(source);
-    } else {
-      result = formatter.formatStatement(source);
-    }
-
-    drawRuler('before', pageWidth);
-    print(source);
-    drawRuler('after', pageWidth);
-    print(result);
-  } on FormatterException catch (error) {
-    print(error.message());
-  }
+  _runTest('selection/selection.stmt', 2);
 }
 
-void drawRuler(String label, int width) {
+void _drawRuler(String label, int width) {
   var padding = ' ' * (width - label.length - 1);
   print('$label:$padding|');
 }
 
 /// Runs the formatter test starting on [line] at [path] inside the "test"
 /// directory.
-Future<void> runTest(String path, int line,
+Future<void> _runTest(String path, int line,
     {int pageWidth = 40, bool tall = true}) async {
   var testFile = await TestFile.read(path);
   var formatTest = testFile.tests.firstWhere((test) => test.line == line);
@@ -81,16 +51,16 @@ Future<void> runTest(String path, int line,
   var expectedText = formatTest.output.textWithSelectionMarkers;
 
   print('$path ${formatTest.description}');
-  drawRuler('before', pageWidth);
+  _drawRuler('before', pageWidth);
   print(formatTest.input.textWithSelectionMarkers);
   if (actualText == expectedText) {
-    drawRuler('result', pageWidth);
+    _drawRuler('result', pageWidth);
     print(actualText);
   } else {
     print('FAIL');
-    drawRuler('expected', pageWidth);
+    _drawRuler('expected', pageWidth);
     print(expectedText);
-    drawRuler('actual', pageWidth);
+    _drawRuler('actual', pageWidth);
     print(actualText);
   }
 }

lib/src/argument_list_visitor.dart

@@ -96,10 +96,9 @@ class ArgumentListVisitor {
       this._allArguments,
       this._arguments,
       this._functions,
-      this._argumentsAfterFunctions) {
-    assert(_functions == null || _argumentsAfterFunctions != null,
-        'If _functions is passed, _argumentsAfterFunctions must be too.');
-  }
+      this._argumentsAfterFunctions)
+      : assert(_functions == null || _argumentsAfterFunctions != null,
+            'If _functions is passed, _argumentsAfterFunctions must be too.');
 
   /// Builds chunks for the argument list.
   void visit() {

lib/src/cli/format_command.dart

@@ -32,7 +32,7 @@ class FormatCommand extends Command<int> {
   Future<int> run() async {
     var argResults = this.argResults!;
 
-    if (argResults['version']) {
+    if (argResults['version'] as bool) {
       print(dartStyleVersion);
       return 0;
     }
@@ -78,7 +78,7 @@ class FormatCommand extends Command<int> {
     }
 
     // Can't use --verbose with anything but --help.
-    if (argResults['verbose'] && !(argResults['help'] as bool)) {
+    if (argResults['verbose'] as bool && !(argResults['help'] as bool)) {
       usageException('Can only use --verbose with --help.');
     }
 
@@ -87,11 +87,11 @@ class FormatCommand extends Command<int> {
       usageException('Cannot print a summary with JSON output.');
     }
 
-    var pageWidth = int.tryParse(argResults['line-length']) ??
+    var pageWidth = int.tryParse(argResults['line-length'] as String) ??
         usageException('--line-length must be an integer, was '
             '"${argResults['line-length']}".');
 
-    var indent = int.tryParse(argResults['indent']) ??
+    var indent = int.tryParse(argResults['indent'] as String) ??
         usageException('--indent must be an integer, was '
             '"${argResults['indent']}".');
 
@@ -101,10 +101,10 @@ class FormatCommand extends Command<int> {
     }
 
     var fixes = <StyleFix>[];
-    if (argResults['fix']) fixes.addAll(StyleFix.all);
+    if (argResults['fix'] as bool) fixes.addAll(StyleFix.all);
     for (var fix in StyleFix.all) {
-      if (argResults['fix-${fix.name}']) {
-        if (argResults['fix']) {
+      if (argResults['fix-${fix.name}'] as bool) {
+        if (argResults['fix'] as bool) {
           usageException('--fix-${fix.name} is redundant with --fix.');
         }
 
@@ -119,7 +119,7 @@ class FormatCommand extends Command<int> {
       usageException(exception.message);
     }
 
-    var followLinks = argResults['follow-links'];
+    var followLinks = argResults['follow-links'] as bool;
     var setExitIfChanged = argResults['set-exit-if-changed'] as bool;
 
     var experimentFlags = argResults['enable-experiment'] as List<String>;

lib/src/cli/options.dart

@@ -145,7 +145,7 @@ List<int>? parseSelection(ArgResults argResults, String optionName) {
   try {
     var coordinates = option.split(':');
     if (coordinates.length != 2) {
-      throw FormatException(
+      throw const FormatException(
           'Selection should be a colon-separated pair of integers, "123:45".');
     }
 

lib/src/cli/output.dart

@@ -46,11 +46,11 @@ enum Output {
         break;
 
       case Output.json:
-        // TODO(rnystrom): Put an empty selection in here to remain compatible with
-        // the old formatter. Since there's no way to pass a selection on the
-        // command line, this will never be used, which is why it's hard-coded to
-        // -1, -1. If we add support for passing in a selection, put the real
-        // result here.
+        // TODO(rnystrom): Put an empty selection in here to remain compatible
+        // with the old formatter. Since there's no way to pass a selection on
+        // the command line, this will never be used, which is why it's
+        // hard-coded to -1, -1. If we add support for passing in a selection,
+        // put the real result here.
         print(jsonEncode({
           'path': path,
           'source': result.text,

lib/src/dart_formatter.dart

@@ -71,7 +71,7 @@ class DartFormatter {
   ///
   /// If [uri] is given, it is a [String] or [Uri] used to identify the file
   /// being formatted in error messages.
-  String format(String source, {uri}) {
+  String format(String source, {Object? uri}) {
     if (uri == null) {
       // Do nothing.
     } else if (uri is Uri) {
@@ -82,7 +82,8 @@ class DartFormatter {
       throw ArgumentError('uri must be `null`, a Uri, or a String.');
     }
 
-    return formatSource(SourceCode(source, uri: uri, isCompilationUnit: true))
+    return formatSource(
+            SourceCode(source, uri: uri as String?, isCompilationUnit: true))
         .text;
   }