Minor cleanup to lints and some top level files (#2872)

parlough · web-flow · commit c573859412cd · 2021-12-31T08:52:13.000-07:00
diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -19,18 +19,14 @@ analyzer:
     - 'testing/test_package_export_error/**'
 linter:
   rules:
-    always_declare_return_types: true
-    avoid_dynamic_calls: true
-    avoid_single_cascade_in_expression_statements: true
-    avoid_unused_constructor_parameters: true
-    avoid_init_to_null: true
-    directives_ordering: true
-    no_adjacent_strings_in_list: true
-    package_api_docs: true
-    prefer_final_fields: true
-    prefer_initializing_formals: true
-    prefer_void_to_null: true
-    slash_for_doc_comments: true
-    type_annotate_public_apis: true
-    # Work in progress canonical score lints
-    unawaited_futures: true
+    - always_declare_return_types
+    - always_put_required_named_parameters_first
+    - avoid_bool_literals_in_conditional_expressions
+    - avoid_unused_constructor_parameters
+    - directives_ordering
+    - no_adjacent_strings_in_list
+    - package_api_docs
+    - prefer_single_quotes
+    - sort_child_properties_last
+    - unawaited_futures
+    - unnecessary_null_aware_assignments
diff --git a/analysis_options_presubmit.yaml b/analysis_options_presubmit.yaml
@@ -24,18 +24,14 @@ analyzer:
     - 'testing/test_package_export_error/**'
 linter:
   rules:
-    always_declare_return_types: true
-    avoid_dynamic_calls: true
-    avoid_single_cascade_in_expression_statements: true
-    avoid_unused_constructor_parameters: true
-    avoid_init_to_null: true
-    directives_ordering: true
-    no_adjacent_strings_in_list: true
-    package_api_docs: true
-    prefer_final_fields: true
-    prefer_initializing_formals: true
-    prefer_void_to_null: true
-    slash_for_doc_comments: true
-    type_annotate_public_apis: true
-    # Work in progress canonical score lints
-    unawaited_futures: true
+    - always_declare_return_types
+    - always_put_required_named_parameters_first
+    - avoid_bool_literals_in_conditional_expressions
+    - avoid_unused_constructor_parameters
+    - directives_ordering
+    - no_adjacent_strings_in_list
+    - package_api_docs
+    - prefer_single_quotes
+    - sort_child_properties_last
+    - unawaited_futures
+    - unnecessary_null_aware_assignments
diff --git a/lib/src/comment_references/parser.dart b/lib/src/comment_references/parser.dart
@@ -48,9 +48,10 @@ class StringTrie {
       return valid ? index : lastValid;
     }
     var matchChar = toMatch.codeUnitAt(index);
-    if (children.containsKey(matchChar)) {
+    var matchedChild = children[matchChar];
+    if (matchedChild != null) {
       lastValid = valid ? index : lastValid;
-      return children[matchChar]!.match(toMatch, index + 1, lastValid);
+      return matchedChild.match(toMatch, index + 1, lastValid);
     }
     return valid ? index : lastValid;
   }
@@ -65,7 +66,7 @@ class StringTrie {
   }
 }
 
-late final StringTrie operatorParseTrie = () {
+final StringTrie operatorParseTrie = () {
   var _operatorParseTrie = StringTrie();
   for (var name in operatorNames.keys) {
     _operatorParseTrie.addWord(name);
diff --git a/lib/src/dartdoc.dart b/lib/src/dartdoc.dart
@@ -352,7 +352,7 @@ class Dartdoc {
     var stringLinks = links
         .map((link) => link.attributes['href'])
         .whereType<String>()
-        .where((href) => href != '')
+        .where((href) => href.isNotEmpty)
         .toList();
 
     return Tuple2(stringLinks, baseHref);
diff --git a/lib/src/dartdoc_options.dart b/lib/src/dartdoc_options.dart
@@ -1467,13 +1467,15 @@ Future<List<DartdocOption>> createDartdocOptions(
           // ignore: unnecessary_null_comparison
           if (inSdk != null) {
             Map<String, String> sdks = option.parent['sdks'].valueAt(dir);
-            if (sdks.containsKey(inSdk)) return sdks[inSdk]!;
+            var inSdkVal = sdks[inSdk];
+            if (inSdkVal != null) return inSdkVal;
           }
           var hostedAt = packageMeta.hostedAt;
           // ignore: unnecessary_null_comparison
           if (hostedAt != null) {
             Map<String, String> hostMap = option.parent['hosted'].valueAt(dir);
-            if (hostMap.containsKey(hostedAt)) return hostMap[hostedAt]!;
+            var hostedAtVal = hostMap[hostedAt];
+            if (hostedAtVal != null) return hostedAtVal;
           }
           return '';
         }, resourceProvider, help: 'Url to use for this particular package.'),
diff --git a/lib/src/element_type.dart b/lib/src/element_type.dart
@@ -227,7 +227,7 @@ class ParameterizedElementType extends DefinedElementType with Rendered {
       .toList(growable: false);
 }
 
-/// A [ElementType] whose underlying type was referrred to by a type alias.
+/// A [ElementType] whose underlying type was referred to by a type alias.
 mixin Aliased implements ElementType, ModelBuilderInterface {
   late final Element typeAliasElement = type.alias!.element;
 
diff --git a/lib/src/model/comment_referable.dart b/lib/src/model/comment_referable.dart
@@ -39,7 +39,7 @@ extension on Scope {
 
 /// A set of utility methods for helping build
 /// [CommentReferable.referenceChildren] out of collections of other
-/// [CommmentReferable]s.
+/// [CommentReferable]s.
 extension CommentReferableEntryGenerators on Iterable<CommentReferable> {
   /// Creates ordinary references except if there is a conflict with
   /// [referable], it will generate a [MapEntry] using [referable]'s
diff --git a/lib/src/model/getter_setter_combo.dart b/lib/src/model/getter_setter_combo.dart
@@ -154,7 +154,7 @@ mixin GetterSetterCombo on ModelElement {
           buffer.write(getter!.oneLineDoc);
         }
         if (hasPublicSetter && setter!.oneLineDoc!.isNotEmpty) {
-          buffer.write(getterSetterBothAvailable ? "" : setter!.oneLineDoc);
+          buffer.write(getterSetterBothAvailable ? '' : setter!.oneLineDoc);
         }
         _oneLineDoc = buffer.toString();
       }
diff --git a/lib/src/model/model_element.dart b/lib/src/model/model_element.dart
@@ -157,9 +157,9 @@ abstract class ModelElement extends Canonicalization
   /// if and only if this is to be an inherited or extended object.
   factory ModelElement._fromPropertyInducingElement(
       PropertyInducingElement e, Library library, PackageGraph packageGraph,
-      {Container? enclosingContainer,
-      required Accessor? getter,
-      required Accessor? setter}) {
+      {required Accessor? getter,
+      required Accessor? setter,
+      Container? enclosingContainer}) {
     // TODO(jcollins-g): Refactor object model to instantiate 'ModelMembers'
     //                   for members?
     if (e is Member) {
diff --git a/lib/src/model/model_object_builder.dart b/lib/src/model/model_object_builder.dart
@@ -20,9 +20,9 @@ abstract class ModelElementBuilder {
   ModelElement fromElement(Element e);
 
   ModelElement fromPropertyInducingElement(Element e, Library l,
-      {Container enclosingContainer,
-      required Accessor? getter,
-      required Accessor? setter});
+      {required Accessor? getter,
+      required Accessor? setter,
+      Container enclosingContainer});
 }
 
 abstract class ElementTypeBuilder {
diff --git a/lib/src/model/package_graph.dart b/lib/src/model/package_graph.dart
@@ -10,7 +10,7 @@ import 'package:analyzer/file_system/file_system.dart';
 // ignore: implementation_imports
 import 'package:analyzer/src/generated/sdk.dart' show DartSdk, SdkLibrary;
 // ignore: implementation_imports
-import 'package:analyzer/src/generated/source_io.dart' show Source;
+import 'package:analyzer/src/generated/source.dart' show Source;
 import 'package:dartdoc/src/dartdoc_options.dart';
 import 'package:dartdoc/src/failure.dart';
 import 'package:dartdoc/src/logging.dart';
diff --git a/lib/src/mustachio/parser.dart b/lib/src/mustachio/parser.dart
@@ -562,7 +562,7 @@ class _KeyParseResult {
   final List<String> names;
 
   /// The source span from where this key was parsed, if this represents a
-  /// parsed key, othwerwise `null`.
+  /// parsed key, otherwise `null`.
   final SourceSpan? span;
 
   const _KeyParseResult._(this.type, this.names, {this.span});
diff --git a/lib/src/package_meta.dart b/lib/src/package_meta.dart
@@ -4,7 +4,6 @@
 
 library dartdoc.package_meta;
 
-import 'dart:convert';
 import 'dart:io' show Platform, Process;
 
 import 'package:analyzer/dart/element/element.dart';
@@ -20,9 +19,7 @@ import 'package:yaml/yaml.dart';
 
 import 'logging.dart';
 
-Map<String, PackageMeta?> _packageMetaCache = {};
-
-Encoding utf8AllowMalformed = Utf8Codec(allowMalformed: true);
+final Map<String, PackageMeta?> _packageMetaCache = {};
 
 class PackageMetaFailure extends DartdocFailure {
   PackageMetaFailure(String message) : super(message);
@@ -174,7 +171,7 @@ abstract class PubPackageMeta extends PackageMeta {
   PubPackageMeta(Folder dir, ResourceProvider resourceProvider)
       : super(dir, resourceProvider);
 
-  static late final List<List<String>> _sdkDirFilePaths = () {
+  static final List<List<String>> _sdkDirFilePaths = () {
     var pathsToReturn = <List<String>>[];
     if (Platform.isWindows) {
       for (var paths in _sdkDirFilePathsPosix) {
diff --git a/lib/src/special_elements.dart b/lib/src/special_elements.dart
@@ -99,12 +99,12 @@ class SpecialClasses {
 
   /// Add a class object that could be special.
   void addSpecial(Class aClass) {
-    if (_specialClassDefinitions.containsKey(aClass.name)) {
-      var d = _specialClassDefinitions[aClass.name]!;
-      if (d.matchesClass(aClass)) {
-        assert(!_specialClass.containsKey(d.specialClass) ||
-            _specialClass[d.specialClass] == aClass);
-        _specialClass[d.specialClass] = aClass;
+    var definition = _specialClassDefinitions[aClass.name];
+    if (definition != null) {
+      if (definition.matchesClass(aClass)) {
+        assert(!_specialClass.containsKey(definition.specialClass) ||
+            _specialClass[definition.specialClass] == aClass);
+        _specialClass[definition.specialClass] = aClass;
       }
     }
   }
diff --git a/lib/src/tool_definition.dart b/lib/src/tool_definition.dart
@@ -81,7 +81,7 @@ class ToolDefinition {
   Future<ToolStateForArgs> toolStateForArgs(String toolName, List<String> args,
       {required ToolErrorCallback toolErrorCallback}) async {
     var commandPath = args.removeAt(0);
-    return ToolStateForArgs(commandPath, args, null);
+    return ToolStateForArgs(commandPath, args);
   }
 }
 
@@ -124,7 +124,7 @@ class DartToolDefinition extends ToolDefinition {
             ...compileArgs,
             ...args,
           ],
-          snapshot._snapshotCompleted);
+          onProcessComplete: snapshot._snapshotCompleted);
     } else {
       await snapshot._snapshotValid();
       if (!snapshotFile.exists) {
@@ -135,7 +135,7 @@ class DartToolDefinition extends ToolDefinition {
         // replace the first argument with the path to the snapshot.
         args[0] = snapshotPath;
       }
-      return ToolStateForArgs(_resourceProvider.resolvedExecutable, args, null);
+      return ToolStateForArgs(_resourceProvider.resolvedExecutable, args);
     }
   }
 
@@ -227,13 +227,15 @@ class SnapshotCache {
   }
 
   _Snapshot getSnapshot(String toolPath) {
-    if (snapshots.containsKey(toolPath)) {
-      return snapshots[toolPath]!;
+    var toolSnapshot = snapshots[toolPath];
+    if (toolSnapshot != null) {
+      return toolSnapshot;
     }
-    snapshots[toolPath] =
+    toolSnapshot =
         _Snapshot(snapshotCache, toolPath, _serial, _resourceProvider);
+    snapshots[toolPath] = toolSnapshot;
     _serial++;
-    return snapshots[toolPath]!;
+    return toolSnapshot;
   }
 
   void dispose() {
@@ -249,5 +251,5 @@ class ToolStateForArgs {
   final List<String> args;
   final void Function()? onProcessComplete;
 
-  ToolStateForArgs(this.commandPath, this.args, this.onProcessComplete);
+  ToolStateForArgs(this.commandPath, this.args, {this.onProcessComplete});
 }
diff --git a/lib/src/tool_runner.dart b/lib/src/tool_runner.dart
@@ -139,8 +139,8 @@ class ToolRunner {
 
   Future<String> _run(List<String> args,
       {required ToolErrorCallback toolErrorCallback,
-      String content = '',
-      required Map<String, String> environment}) async {
+      required Map<String, String> environment,
+      String content = ''}) async {
     assert(args.isNotEmpty);
     var toolName = args.removeAt(0);
     if (!toolConfiguration.tools.containsKey(toolName)) {
diff --git a/test/mustachio/parser_test.dart b/test/mustachio/parser_test.dart
@@ -426,9 +426,9 @@ void _expectText(MustachioNode node, Object matcher,
 void _expectVariable(
   MustachioNode node,
   Object matcher, {
-  bool escape = true,
   required int spanStart,
   required int spanEnd,
+  bool escape = true,
   int? keySpanStart,
   int? keySpanEnd,
 }) {
@@ -459,9 +459,9 @@ void _expectVariable(
 void _expectSection(
   MustachioNode node,
   Object matcher, {
-  bool invert = false,
   required int spanStart,
   required int spanEnd,
+  bool invert = false,
   int? keySpanStart,
   int? keySpanEnd,
 }) {
diff --git a/tool/grind.dart b/tool/grind.dart
@@ -849,7 +849,7 @@ $analyzerOptions
         '--link-to-remote',
         '--show-progress',
         '--enable-experiment',
-        languageExperiments.join(","),
+        languageExperiments.join(','),
         ...extraDartdocParameters,
       ],
       workingDirectory: languageTestPackageDir.absolute.path);
diff --git a/tool/subprocess_launcher.dart b/tool/subprocess_launcher.dart
@@ -138,8 +138,8 @@ class SubprocessLauncher {
 
   // from flutter:dev/tools/dartdoc.dart, modified
   static Future<void> _printStream(Stream<List<int>> stream, Stdout output,
-      {String prefix = '',
-      required Iterable<String> Function(String line) filter}) {
+      {required Iterable<String> Function(String line) filter,
+      String prefix = ''}) {
     return stream
         .transform(utf8.decoder)
         .transform(const LineSplitter())

Original file line number	Diff line number	Diff line change
`@@ -48,9 +48,10 @@ class StringTrie {`
`48`	`48`	`return valid ? index : lastValid;`
`49`	`49`	`}`
`50`	`50`	`var matchChar = toMatch.codeUnitAt(index);`
`51`		`- if (children.containsKey(matchChar)) {`
	`51`	`+ var matchedChild = children[matchChar];`
	`52`	`+ if (matchedChild != null) {`
`52`	`53`	`lastValid = valid ? index : lastValid;`
`53`		`- return children[matchChar]!.match(toMatch, index + 1, lastValid);`
	`54`	`+ return matchedChild.match(toMatch, index + 1, lastValid);`
`54`	`55`	`}`
`55`	`56`	`return valid ? index : lastValid;`
`56`	`57`	`}`
`@@ -65,7 +66,7 @@ class StringTrie {`
`65`	`66`	`}`
`66`	`67`	`}`
`67`	`68`
`68`		`-late final StringTrie operatorParseTrie = () {`
	`69`	`+final StringTrie operatorParseTrie = () {`
`69`	`70`	`var _operatorParseTrie = StringTrie();`
`70`	`71`	`for (var name in operatorNames.keys) {`
`71`	`72`	`_operatorParseTrie.addWord(name);`
Original file line number	Diff line number	Diff line change
`@@ -227,7 +227,7 @@ class ParameterizedElementType extends DefinedElementType with Rendered {`
`227`	`227`	`.toList(growable: false);`
`228`	`228`	`}`
`229`	`229`
`230`		`-/// A [ElementType] whose underlying type was referrred to by a type alias.`
	`230`	`+/// A [ElementType] whose underlying type was referred to by a type alias.`
`231`	`231`	`mixin Aliased implements ElementType, ModelBuilderInterface {`
`232`	`232`	`late final Element typeAliasElement = type.alias!.element;`
`233`	`233`
Original file line number	Diff line number	Diff line change
`@@ -154,7 +154,7 @@ mixin GetterSetterCombo on ModelElement {`
`154`	`154`	`buffer.write(getter!.oneLineDoc);`
`155`	`155`	`}`
`156`	`156`	`if (hasPublicSetter && setter!.oneLineDoc!.isNotEmpty) {`
`157`		`- buffer.write(getterSetterBothAvailable ? "" : setter!.oneLineDoc);`
	`157`	`+ buffer.write(getterSetterBothAvailable ? '' : setter!.oneLineDoc);`
`158`	`158`	`}`
`159`	`159`	`_oneLineDoc = buffer.toString();`
`160`	`160`	`}`