Migrate ModelElement and subclasses to NNBD (#2843)

* squash

* rebuild

* migrate more things

* subprocess

* type adjustment in grinder

* partial

* partial 2

* no errors, ship it

* clean up a lot of warnings

* All warnings done so really ship it

* dartfmt

* close

* manual changes on renderers

* comments

* partial

* fix some errors post-migration

* holy cow it passes the tests now

* make mustache happier and clean up an interface

* forgot to remove a fixme

* Work around strange super-not-allowed error in stable

* review comments

Author: jcollins-g

lib/dartdoc.dart

@@ -2,7 +2,6 @@
 // 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.
 
-// @dart=2.9
 /// A documentation generator for Dart.
 ///
 /// Library interface is still experimental.

lib/src/dartdoc_options.dart

@@ -58,8 +58,8 @@ class DartdocFileMissing extends DartdocOptionError {
 /// the 'categories' keyword in the options file, and populated by the
 /// [CategoryConfiguration] class.
 class CategoryDefinition {
-  /// Internal name of the category.
-  final String name;
+  /// Internal name of the category, or null for the default category.
+  final String? name;
 
   /// Displayed name of the category in docs, or null if there is none.
   final String? _displayName;
@@ -71,7 +71,7 @@ class CategoryDefinition {
   CategoryDefinition(this.name, this._displayName, this.documentationMarkdown);
 
   /// Returns the [_displayName], if available, or else simply [name].
-  String get displayName => _displayName ?? name;
+  String get displayName => _displayName ?? name ?? '';
 }
 
 /// A configuration class that can interpret category definitions from a YAML
@@ -1246,7 +1246,7 @@ class DartdocOptionContext extends DartdocOptionContextBase
 
   List<String> get dropTextFrom => optionSet['dropTextFrom'].valueAt(context);
 
-  String get examplePathPrefix =>
+  String? get examplePathPrefix =>
       optionSet['examplePathPrefix'].valueAt(context);
 
   // TODO(srawlins): This memoization saved a lot of time in unit testing, but

lib/src/element_type.dart

@@ -43,6 +43,7 @@ abstract class ElementType extends Privacy
     if (fElement == null ||
         fElement.kind == ElementKind.DYNAMIC ||
         fElement.kind == ElementKind.NEVER) {
+      // [UndefinedElementType]s.
       if (f is FunctionType) {
         if (f.alias?.element != null) {
           return AliasedFunctionTypeElementType(
@@ -51,43 +52,42 @@ abstract class ElementType extends Privacy
         return FunctionTypeElementType(f, library, packageGraph, returnedFrom);
       }
       return UndefinedElementType(f, library, packageGraph, returnedFrom);
-    } else {
-      var element = packageGraph.modelBuilder.fromElement(fElement);
-      // [TypeAliasElement.aliasElement] has different implications.
-      // In that case it is an actual type alias of some kind (generic
-      // or otherwise.   Here however aliasElement signals that this is a
-      // type referring to an alias.
-      if (f is! TypeAliasElement && f.alias?.element != null) {
-        return AliasedElementType(f as ParameterizedType, library, packageGraph,
-            element, returnedFrom);
-      }
-      assert(f is ParameterizedType || f is TypeParameterType);
-      // TODO(jcollins-g): strip out all the cruft that's accumulated
-      // here for non-generic type aliases.
-      var isGenericTypeAlias = f.alias?.element != null && f is! InterfaceType;
-      if (f is FunctionType) {
-        assert(f is ParameterizedType);
-        // This is an indication we have an extremely out of date analyzer....
-        assert(
-            !isGenericTypeAlias, 'should never occur: out of date analyzer?');
-        // And finally, delete this case and its associated class
-        // after https://dart-review.googlesource.com/c/sdk/+/201520
-        // is in all published versions of analyzer this version of dartdoc
-        // is compatible with.
-        return CallableElementType(
-            f, library, packageGraph, element, returnedFrom);
-      } else if (isGenericTypeAlias) {
-        return GenericTypeAliasElementType(f as TypeParameterType, library,
-            packageGraph, element, returnedFrom);
-      }
-      if (f is TypeParameterType) {
-        return TypeParameterElementType(
-            f, library, packageGraph, element, returnedFrom);
-      }
-      assert(f is ParameterizedType);
-      return ParameterizedElementType(
+    }
+    // [DefinedElementType]s.
+    var element = packageGraph.modelBuilder.fromElement(fElement);
+    // [TypeAliasElement.aliasElement] has different implications.
+    // In that case it is an actual type alias of some kind (generic
+    // or otherwise.   Here however aliasElement signals that this is a
+    // type referring to an alias.
+    if (f is! TypeAliasElement && f.alias?.element != null) {
+      return AliasedElementType(
           f as ParameterizedType, library, packageGraph, element, returnedFrom);
     }
+    assert(f is ParameterizedType || f is TypeParameterType);
+    // TODO(jcollins-g): strip out all the cruft that's accumulated
+    // here for non-generic type aliases.
+    var isGenericTypeAlias = f.alias?.element != null && f is! InterfaceType;
+    if (f is FunctionType) {
+      assert(f is ParameterizedType);
+      // This is an indication we have an extremely out of date analyzer....
+      assert(!isGenericTypeAlias, 'should never occur: out of date analyzer?');
+      // And finally, delete this case and its associated class
+      // after https://dart-review.googlesource.com/c/sdk/+/201520
+      // is in all published versions of analyzer this version of dartdoc
+      // is compatible with.
+      return CallableElementType(
+          f, library, packageGraph, element, returnedFrom);
+    } else if (isGenericTypeAlias) {
+      return GenericTypeAliasElementType(
+          f as TypeParameterType, library, packageGraph, element, returnedFrom);
+    }
+    if (f is TypeParameterType) {
+      return TypeParameterElementType(
+          f, library, packageGraph, element, returnedFrom);
+    }
+    assert(f is ParameterizedType);
+    return ParameterizedElementType(
+        f as ParameterizedType, library, packageGraph, element, returnedFrom);
   }
 
   bool get canHaveParameters => false;
@@ -260,7 +260,7 @@ class AliasedElementType extends ParameterizedElementType with Aliased {
   ParameterizedType get type;
 
   /// Parameters, if available, for the underlying typedef.
-  List<Parameter> get aliasedParameters =>
+  late final List<Parameter> aliasedParameters =
       modelElement.isCallable ? modelElement.parameters : [];
 
   @override
@@ -298,7 +298,7 @@ abstract class DefinedElementType extends ElementType {
       this.modelElement, ElementType? returnedFrom)
       : super(type, library, packageGraph, returnedFrom);
 
-  Element get element => modelElement.element;
+  Element get element => modelElement.element!;
 
   @override
   String get name => type.element!.name!;
@@ -372,7 +372,7 @@ abstract class DefinedElementType extends ElementType {
       modelElement.referenceParents;
 
   @override
-  Iterable<CommentReferable> get referenceGrandparentOverrides =>
+  Iterable<CommentReferable>? get referenceGrandparentOverrides =>
       modelElement.referenceGrandparentOverrides;
 
   @internal

lib/src/generator/generator_utils.dart

@@ -14,9 +14,9 @@ import 'package:dartdoc/src/model/model_element.dart';
 /// will likely want the same content for this.
 String generateCategoryJson(Iterable<Categorization> categories, bool pretty) {
   // ignore: omit_local_variable_types
-  final List<Map<String, Object>> indexItems =
+  final List<Map<String, Object?>> indexItems =
       categories.map((Categorization categorization) {
-    final data = <String, Object>{
+    final data = <String, Object?>{
       'name': categorization.name,
       'qualifiedName': categorization.fullyQualifiedName,
       'href': categorization.href,
@@ -49,21 +49,21 @@ String generateCategoryJson(Iterable<Categorization> categories, bool pretty) {
 String generateSearchIndexJson(
     Iterable<Indexable> indexedElements, bool pretty) {
   final indexItems = indexedElements.map((Indexable indexable) {
-    final data = <String, Object>{
+    final data = <String, Object?>{
       'name': indexable.name,
       'qualifiedName': indexable.fullyQualifiedName,
       'href': indexable.href,
       'type': indexable.kind,
       'overriddenDepth': indexable.overriddenDepth,
     };
     if (indexable is ModelElement) {
-      data['packageName'] = indexable.package.name;
+      data['packageName'] = indexable.package?.name;
     }
     if (indexable is EnclosedElement) {
       final ee = indexable as EnclosedElement;
-      data['enclosedBy'] = {
-        'name': ee.enclosingElement.name,
-        'type': ee.enclosingElement.kind
+      data['enclosedBy'] = <String, Object?>{
+        'name': ee.enclosingElement!.name,
+        'type': ee.enclosingElement!.kind
       };
 
       data['qualifiedName'] = indexable.fullyQualifiedName;

lib/src/generator/template_data.dart

@@ -51,7 +51,8 @@ abstract class TemplateData<T extends Documentable> {
 
   String get bareHref {
     if (self is Indexable) {
-      return (self as Indexable).href.replaceAll(htmlBasePlaceholder, '');
+      var selfHref = (self as Indexable).href ?? '';
+      return selfHref.replaceAll(htmlBasePlaceholder, '');
     }
     return '';
   }

lib/src/generator/templates.aot_renderers_for_md.dart

@@ -712,12 +712,10 @@ String renderClass(_i1.ClassTemplateData context0) {
 ''');
         var context11 = context2.potentiallyApplicableExtensions;
         if (context11 != null) {
-          for (var context12 in context11) {
-            buffer.writeln();
-            buffer.write('''
+          buffer.writeln();
+          buffer.write('''
 - ''');
-            buffer.write(context12.linkedName.toString());
-          }
+          buffer.write(context2.linkedName.toString());
         }
       }
       buffer.writeln();
@@ -726,13 +724,13 @@ String renderClass(_i1.ClassTemplateData context0) {
         buffer.write('''
 **Annotations**
 ''');
-        var context13 = context2.annotations;
-        if (context13 != null) {
-          for (var context14 in context13) {
+        var context12 = context2.annotations;
+        if (context12 != null) {
+          for (var context13 in context12) {
             buffer.writeln();
             buffer.write('''
 - ''');
-            buffer.write(context14.linkedNameWithParameters.toString());
+            buffer.write(context13.linkedNameWithParameters.toString());
           }
         }
       }
@@ -743,25 +741,25 @@ String renderClass(_i1.ClassTemplateData context0) {
       buffer.write('''
 ## Constructors
 ''');
-      var context15 = context2.publicConstructorsSorted;
-      if (context15 != null) {
-        for (var context16 in context15) {
+      var context14 = context2.publicConstructorsSorted;
+      if (context14 != null) {
+        for (var context15 in context14) {
           buffer.writeln();
-          buffer.write(context16.linkedName.toString());
+          buffer.write(context15.linkedName.toString());
           buffer.write(''' (''');
-          buffer.write(context16.linkedParams.toString());
+          buffer.write(context15.linkedParams.toString());
           buffer.write(''')
 
 ''');
-          buffer.write(context16.oneLineDoc.toString());
+          buffer.write(context15.oneLineDoc.toString());
           buffer.write(' ');
-          buffer.write(context16.extendedDocLink.toString());
+          buffer.write(context15.extendedDocLink.toString());
           buffer.write('  ');
-          if (context16.isConst == true) {
+          if (context15.isConst == true) {
             buffer.write('''_const_''');
           }
           buffer.write(' ');
-          if (context16.isFactory == true) {
+          if (context15.isFactory == true) {
             buffer.write('''_factory_''');
           }
           buffer.writeln();
@@ -774,12 +772,12 @@ String renderClass(_i1.ClassTemplateData context0) {
       buffer.write('''
 ## Properties
 ''');
-      var context17 = context2.publicInstanceFieldsSorted;
-      if (context17 != null) {
-        for (var context18 in context17) {
+      var context16 = context2.publicInstanceFieldsSorted;
+      if (context16 != null) {
+        for (var context17 in context16) {
           buffer.writeln();
           buffer.write(
-              _renderClass_partial_property_5(context18, context2, context0));
+              _renderClass_partial_property_5(context17, context2, context0));
           buffer.writeln();
         }
       }
@@ -790,12 +788,12 @@ String renderClass(_i1.ClassTemplateData context0) {
       buffer.write('''
 ## Methods
 ''');
-      var context19 = context2.publicInstanceMethodsSorted;
-      if (context19 != null) {
-        for (var context20 in context19) {
+      var context18 = context2.publicInstanceMethodsSorted;
+      if (context18 != null) {
+        for (var context19 in context18) {
           buffer.writeln();
           buffer.write(
-              _renderClass_partial_callable_6(context20, context2, context0));
+              _renderClass_partial_callable_6(context19, context2, context0));
           buffer.writeln();
         }
       }
@@ -806,12 +804,12 @@ String renderClass(_i1.ClassTemplateData context0) {
       buffer.write('''
 ## Operators
 ''');
-      var context21 = context2.publicInstanceOperatorsSorted;
-      if (context21 != null) {
-        for (var context22 in context21) {
+      var context20 = context2.publicInstanceOperatorsSorted;
+      if (context20 != null) {
+        for (var context21 in context20) {
           buffer.writeln();
           buffer.write(
-              _renderClass_partial_callable_6(context22, context2, context0));
+              _renderClass_partial_callable_6(context21, context2, context0));
           buffer.writeln();
         }
       }
@@ -822,12 +820,12 @@ String renderClass(_i1.ClassTemplateData context0) {
       buffer.write('''
 ## Static Properties
 ''');
-      var context23 = context2.publicVariableStaticFieldsSorted;
-      if (context23 != null) {
-        for (var context24 in context23) {
+      var context22 = context2.publicVariableStaticFieldsSorted;
+      if (context22 != null) {
+        for (var context23 in context22) {
           buffer.writeln();
           buffer.write(
-              _renderClass_partial_property_5(context24, context2, context0));
+              _renderClass_partial_property_5(context23, context2, context0));
           buffer.writeln();
         }
       }
@@ -838,12 +836,12 @@ String renderClass(_i1.ClassTemplateData context0) {
       buffer.write('''
 ## Static Methods
 ''');
-      var context25 = context2.publicStaticMethodsSorted;
-      if (context25 != null) {
-        for (var context26 in context25) {
+      var context24 = context2.publicStaticMethodsSorted;
+      if (context24 != null) {
+        for (var context25 in context24) {
           buffer.writeln();
           buffer.write(
-              _renderClass_partial_callable_6(context26, context2, context0));
+              _renderClass_partial_callable_6(context25, context2, context0));
           buffer.writeln();
         }
       }
@@ -854,12 +852,12 @@ String renderClass(_i1.ClassTemplateData context0) {
       buffer.write('''
 ## Constants
 ''');
-      var context27 = context2.publicConstantFieldsSorted;
-      if (context27 != null) {
-        for (var context28 in context27) {
+      var context26 = context2.publicConstantFieldsSorted;
+      if (context26 != null) {
+        for (var context27 in context26) {
           buffer.writeln();
           buffer.write(
-              _renderClass_partial_constant_7(context28, context2, context0));
+              _renderClass_partial_constant_7(context27, context2, context0));
           buffer.writeln();
         }
       }