enable additional lints (#3336)

Author: devoncarew

analysis_options.yaml

@@ -19,12 +19,14 @@ linter:
     - always_declare_return_types
     - always_put_required_named_parameters_first
     - avoid_bool_literals_in_conditional_expressions
+    - avoid_catching_errors
     - avoid_dynamic_calls
     - avoid_slow_async_io
     - avoid_unused_constructor_parameters
     - directives_ordering
     - no_adjacent_strings_in_list
     - omit_local_variable_types
+    - only_throw_errors
     - package_api_docs
     - prefer_asserts_in_initializer_lists
     - prefer_null_aware_method_calls
@@ -35,4 +37,5 @@ linter:
     - unawaited_futures
     - unnecessary_lambdas
     - unnecessary_parenthesis
+    - unnecessary_statements
     - use_super_parameters

lib/src/failure.dart

@@ -6,7 +6,7 @@
 ///
 /// An instance of this is returned if dartdoc fails in an expected way (for
 /// instance, if there is an analysis error in the library).
-class DartdocFailure {
+class DartdocFailure implements Exception {
   final String message;
 
   DartdocFailure(this.message);

lib/src/model/extendable.dart

@@ -8,8 +8,10 @@ import 'package:dartdoc/src/model/model.dart';
 /// extension methods.
 mixin Extendable on ContainerMember {
   /// Returns this Extendable from the [Extension] in which it was declared.
-  Extendable get definingExtension => throw UnimplementedError;
+  Extendable get definingExtension =>
+      throw UnimplementedError('definingExtension');
 
   @override
-  Container get canonicalEnclosingContainer => throw UnimplementedError;
+  Container get canonicalEnclosingContainer =>
+      throw UnimplementedError('canonicalEnclosingContainer');
 }

lib/src/model/package_builder.dart

@@ -444,8 +444,8 @@ class PubPackageBuilder implements PackageBuilder {
           .difference(Set.of(knownLibraryNames))
           .difference(config.exclude);
       if (notFound.isNotEmpty) {
-        throw 'Did not find: [${notFound.join(', ')}] in '
-            'known libraries: [${knownLibraryNames.join(', ')}]';
+        throw StateError('Did not find: [${notFound.join(', ')}] in '
+            'known libraries: [${knownLibraryNames.join(', ')}]');
       }
     }
     // Include directive does not apply to special libraries.

lib/src/model/package_graph.dart

@@ -215,20 +215,19 @@ class PackageGraph with CommentReferable, Nameable, ModelBuilder {
   ///
   /// This mapping must be complete before [initializePackageGraph] is called.
   @visibleForTesting
-  final allLibraries = <String, Library>{};
+  final Map<String, Library> allLibraries = {};
 
   /// All [ModelElement]s constructed for this package; a superset of
   /// [_allModelElements].
-  final HashMap<Tuple3<Element, Library, Container?>, ModelElement?>
-      allConstructedModelElements =
-      HashMap<Tuple3<Element, Library, Container?>, ModelElement?>();
+  final Map<Tuple3<Element, Library, Container?>, ModelElement?>
+      allConstructedModelElements = {};
 
   /// Anything that might be inheritable, place here for later lookup.
-  final allInheritableElements =
-      HashMap<Tuple2<Element, Library>, Set<ModelElement>>();
+  final Map<Tuple2<Element, Library>, Set<ModelElement>>
+      allInheritableElements = {};
 
   /// A mapping of the list of classes which implement each class.
-  final _implementors =
+  final Map<InheritingContainer, List<InheritingContainer>> _implementors =
       LinkedHashMap<InheritingContainer, List<InheritingContainer>>(
           equals: (InheritingContainer a, InheritingContainer b) =>
               a.definingContainer == b.definingContainer,
@@ -857,7 +856,8 @@ class PackageGraph with CommentReferable, Nameable, ModelBuilder {
       // might not be where the element was defined, which is what's important
       // for nodoc's semantics.  Looking up the defining element just to pull
       // a context is again, slow.
-      var globs = config.optionSet['nodoc'].valueAt(file.parent);
+      var globs = (config.optionSet['nodoc'].valueAt(file.parent) as List)
+          .cast<String>();
       return utils.matchGlobs(globs, fullName);
     });
   }

lib/src/mustachio/renderer_base.dart

@@ -189,6 +189,7 @@ abstract class RendererBase<T extends Object?> {
       if (property != null) {
         try {
           return property.renderVariable(context, property, remainingNames);
+          // ignore: avoid_catching_errors
         } on PartialMustachioResolutionError catch (e) {
           // The error thrown by [Property.renderVariable] does not have all of
           // the names required for a decent error. We throw a new error here.
@@ -199,6 +200,7 @@ abstract class RendererBase<T extends Object?> {
               "'$firstName' to a property on $T"));
         }
       }
+      // ignore: avoid_catching_errors
     } on _MustachioResolutionErrorWithoutSpan catch (e) {
       throw MustachioResolutionError(node.keySpan.message(e.message));
     }

lib/src/package_meta.dart

@@ -310,7 +310,7 @@ class _FilePackageMeta extends PubPackageMeta {
   late final Map<dynamic, dynamic> _pubspec = () {
     var pubspec = dir.getChildAssumingFile('pubspec.yaml');
     assert(pubspec.exists);
-    return loadYaml(pubspec.readAsStringSync());
+    return loadYaml(pubspec.readAsStringSync()) as YamlMap;
   }();
 
   _FilePackageMeta(super.dir, super.resourceProvider);

lib/src/tool_runner.dart

@@ -108,7 +108,7 @@ class ToolRunner {
             'Stderr output was:\n${result.stderr}\n');
         return '';
       } else {
-        return result.stdout;
+        return result.stdout as String;
       }
     } on ProcessException catch (exception) {
       toolErrorCallback('Failed to run tool "$name" as '

lib/src/validator.dart

@@ -153,9 +153,10 @@ class Validator {
     // The package index isn't supposed to be in the search, so suppress the
     // warning.
     found.add(indexPath);
-    for (Map<String, dynamic> entry in jsonData) {
+    for (var entry in jsonData.cast<Map<String, dynamic>>()) {
       if (entry.containsKey('href')) {
-        final entryPath = p.joinAll([_origin, ...p.posix.split(entry['href'])]);
+        final entryPath =
+            p.joinAll([_origin, ...p.posix.split(entry['href'] as String)]);
         if (!_visited.contains(entryPath)) {
           _warn(PackageWarning.brokenLink, entryPath, _origin,
               referredFrom: fullPath);

test/mustachio/renderers_output_test.dart

@@ -5,6 +5,7 @@
 library dartdoc.dartdoc_test;
 
 import 'dart:async';
+import 'dart:io';
 
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/file_system/memory_file_system.dart';
@@ -25,26 +26,35 @@ import 'package:test/test.dart';
 Future<DartdocGeneratorOptionContext> _generatorContextFromArgv(
     List<String> argv) async {
   var optionSet = DartdocOptionRoot.fromOptionGenerators(
-      'dartdoc',
-      [
-        createDartdocOptions,
-        createGeneratorOptions,
-      ],
-      pubPackageMetaProvider);
+    'dartdoc',
+    [
+      createDartdocOptions,
+      createGeneratorOptions,
+    ],
+    pubPackageMetaProvider,
+  );
   optionSet.parseArguments(argv);
   return DartdocGeneratorOptionContext.fromDefaultContextLocation(
       optionSet, pubPackageMetaProvider.resourceProvider);
 }
 
 void main() {
+  late Directory tempDir;
+
+  setUp(() {
+    tempDir = Directory.systemTemp.createTempSync('render_test');
+  });
+
+  tearDown(() => tempDir.deleteSync(recursive: true));
+
   test('source code links are visible', () async {
     var resourceProvider = pubPackageMetaProvider.resourceProvider;
     var pathContext = resourceProvider.pathContext;
     var testPackageDir = resourceProvider.getFolder(
         pathContext.absolute(pathContext.canonicalize('testing/test_package')));
 
     var context = await _generatorContextFromArgv(
-        ['--input', testPackageDir.path, '--output', 'UNUSED']);
+        ['--input', testPackageDir.path, '--output', tempDir.path]);
     var dartdoc = await Dartdoc.fromContext(
       context,
       PubPackageBuilder(