Split sidebars out into separate HTML files (#3384)

Author: srawlins

lib/resources/docs.dart.js

@@ -56,19 +56,6 @@ class DartdocGeneratorBackendOptions implements TemplateOptions {
         resourcesDir = context.resourcesDir;
 }
 
-class SidebarGenerator<T extends TemplateData> {
-  final String Function(T context) renderFunction;
-  final Map<Documentable, String> _renderCache = {};
-
-  SidebarGenerator(this.renderFunction);
-
-  /// Retrieves the render for a specific [key], or generates it using the given
-  /// [templateData] if needed.
-  String getRenderFor(Documentable key, T templateData) {
-    return _renderCache[key] ??= renderFunction(templateData);
-  }
-}
-
 /// An interface for classes which are responsible for outputing the generated
 /// documentation.
 abstract class GeneratorBackend {
@@ -142,10 +129,6 @@ abstract class GeneratorBackend {
 abstract class GeneratorBackendBase implements GeneratorBackend {
   final DartdocGeneratorBackendOptions options;
   final Templates templates;
-  final SidebarGenerator<TemplateDataWithLibrary<Documentable>>
-      _sidebarForLibrary;
-  final SidebarGenerator<TemplateDataWithContainer<Documentable>>
-      _sidebarForContainer;
 
   @override
   final FileWriter writer;
@@ -154,11 +137,7 @@ abstract class GeneratorBackendBase implements GeneratorBackend {
 
   GeneratorBackendBase(
       this.options, this.templates, this.writer, this.resourceProvider)
-      : _sidebarForLibrary =
-            SidebarGenerator(templates.renderSidebarForLibrary),
-        _sidebarForContainer =
-            SidebarGenerator(templates.renderSidebarForContainer),
-        _pathContext = resourceProvider.pathContext;
+      : _pathContext = resourceProvider.pathContext;
 
   /// Binds template data and emits the content to the [writer].
   void write(
@@ -205,8 +184,7 @@ abstract class GeneratorBackendBase implements GeneratorBackend {
 
   @override
   void generateClass(PackageGraph packageGraph, Library library, Class clazz) {
-    var data = ClassTemplateData(options, packageGraph, library, clazz,
-        _sidebarForLibrary.getRenderFor, _sidebarForContainer.getRenderFor);
+    var data = ClassTemplateData(options, packageGraph, library, clazz);
     var content = templates.renderClass(data);
     write(writer, clazz.filePath, data, content);
     runtimeStats.incrementAccumulator('writtenClassFileCount');
@@ -220,17 +198,16 @@ abstract class GeneratorBackendBase implements GeneratorBackend {
   @override
   void generateConstructor(PackageGraph packageGraph, Library library,
       Constructable constructable, Constructor constructor) {
-    var data = ConstructorTemplateData(options, packageGraph, library,
-        constructable, constructor, _sidebarForContainer.getRenderFor);
+    var data = ConstructorTemplateData(
+        options, packageGraph, library, constructable, constructor);
     var content = templates.renderConstructor(data);
     write(writer, constructor.filePath, data, content);
     runtimeStats.incrementAccumulator('writtenConstructorFileCount');
   }
 
   @override
   void generateEnum(PackageGraph packageGraph, Library library, Enum eNum) {
-    var data = EnumTemplateData(options, packageGraph, library, eNum,
-        _sidebarForLibrary.getRenderFor, _sidebarForContainer.getRenderFor);
+    var data = EnumTemplateData(options, packageGraph, library, eNum);
     var content = templates.renderEnum(data);
     write(writer, eNum.filePath, data, content);
     runtimeStats.incrementAccumulator('writtenEnumFileCount');
@@ -239,8 +216,7 @@ abstract class GeneratorBackendBase implements GeneratorBackend {
   @override
   void generateExtension(
       PackageGraph packageGraph, Library library, Extension extension) {
-    var data = ExtensionTemplateData(options, packageGraph, library, extension,
-        _sidebarForLibrary.getRenderFor, _sidebarForContainer.getRenderFor);
+    var data = ExtensionTemplateData(options, packageGraph, library, extension);
     var content = templates.renderExtension(data);
     write(writer, extension.filePath, data, content);
     runtimeStats.incrementAccumulator('writtenExtensionFileCount');
@@ -249,17 +225,15 @@ abstract class GeneratorBackendBase implements GeneratorBackend {
   @override
   void generateFunction(
       PackageGraph packageGraph, Library library, ModelFunction function) {
-    var data = FunctionTemplateData(options, packageGraph, library, function,
-        _sidebarForLibrary.getRenderFor);
+    var data = FunctionTemplateData(options, packageGraph, library, function);
     var content = templates.renderFunction(data);
     write(writer, function.filePath, data, content);
     runtimeStats.incrementAccumulator('writtenFunctionFileCount');
   }
 
   @override
   void generateLibrary(PackageGraph packageGraph, Library library) {
-    var data = LibraryTemplateData(
-        options, packageGraph, library, _sidebarForLibrary.getRenderFor);
+    var data = LibraryTemplateData(options, packageGraph, library);
     var content = templates.renderLibrary(data);
     write(writer, library.filePath, data, content);
     runtimeStats.incrementAccumulator('writtenLibraryFileCount');
@@ -268,17 +242,16 @@ abstract class GeneratorBackendBase implements GeneratorBackend {
   @override
   void generateMethod(PackageGraph packageGraph, Library library,
       Container clazz, Method method) {
-    var data = MethodTemplateData(options, packageGraph, library, clazz, method,
-        _sidebarForContainer.getRenderFor);
+    var data =
+        MethodTemplateData(options, packageGraph, library, clazz, method);
     var content = templates.renderMethod(data);
     write(writer, method.filePath, data, content);
     runtimeStats.incrementAccumulator('writtenMethodFileCount');
   }
 
   @override
   void generateMixin(PackageGraph packageGraph, Library library, Mixin mixin) {
-    var data = MixinTemplateData(options, packageGraph, library, mixin,
-        _sidebarForLibrary.getRenderFor, _sidebarForContainer.getRenderFor);
+    var data = MixinTemplateData(options, packageGraph, library, mixin);
     var content = templates.renderMixin(data);
     write(writer, mixin.filePath, data, content);
     runtimeStats.incrementAccumulator('writtenMixinFileCount');
@@ -295,8 +268,8 @@ abstract class GeneratorBackendBase implements GeneratorBackend {
   @override
   void generateProperty(PackageGraph packageGraph, Library library,
       Container clazz, Field field) {
-    var data = PropertyTemplateData(options, packageGraph, library, clazz,
-        field, _sidebarForContainer.getRenderFor);
+    var data =
+        PropertyTemplateData(options, packageGraph, library, clazz, field);
     var content = templates.renderProperty(data);
     write(writer, field.filePath, data, content);
     runtimeStats.incrementAccumulator('writtenPropertyFileCount');
@@ -310,8 +283,8 @@ abstract class GeneratorBackendBase implements GeneratorBackend {
   @override
   void generateTopLevelProperty(
       PackageGraph packageGraph, Library library, TopLevelVariable property) {
-    var data = TopLevelPropertyTemplateData(options, packageGraph, library,
-        property, _sidebarForLibrary.getRenderFor);
+    var data =
+        TopLevelPropertyTemplateData(options, packageGraph, library, property);
     var content = templates.renderTopLevelProperty(data);
     write(writer, property.filePath, data, content);
     runtimeStats.incrementAccumulator('writtenTopLevelPropertyFileCount');
@@ -320,8 +293,7 @@ abstract class GeneratorBackendBase implements GeneratorBackend {
   @override
   void generateTypeDef(
       PackageGraph packageGraph, Library library, Typedef typedef) {
-    var data = TypedefTemplateData(options, packageGraph, library, typedef,
-        _sidebarForLibrary.getRenderFor);
+    var data = TypedefTemplateData(options, packageGraph, library, typedef);
     var content = templates.renderTypedef(data);
     write(writer, typedef.filePath, data, content);
     runtimeStats.incrementAccumulator('writtenTypedefFileCount');

lib/resources/docs.dart.js.map

@@ -57,6 +57,7 @@ class GeneratorFrontEnd implements Generator {
       'writtenMixinFileCount',
       'writtenPackageFileCount',
       'writtenPropertyFileCount',
+      'writtenSidebarFileCount',
       'writtenTopLevelPropertyFileCount',
       'writtenTypedefFileCount'
     });

lib/src/generator/generator_backend.dart

@@ -12,8 +12,8 @@ import 'package:dartdoc/src/generator/html_resources.g.dart' as resources;
 import 'package:dartdoc/src/generator/resource_loader.dart';
 import 'package:dartdoc/src/generator/template_data.dart';
 import 'package:dartdoc/src/generator/templates.dart';
-import 'package:dartdoc/src/model/package.dart';
-import 'package:dartdoc/src/model/package_graph.dart';
+import 'package:dartdoc/src/model/model.dart';
+import 'package:dartdoc/src/runtime_stats.dart';
 import 'package:meta/meta.dart';
 
 /// Creates a [Generator] with an [HtmlGeneratorBackend] backend.
@@ -37,6 +37,52 @@ class HtmlGeneratorBackend extends GeneratorBackendBase {
   HtmlGeneratorBackend(
       super.options, super.templates, super.writer, super.resourceProvider);
 
+  @override
+  void generateClass(PackageGraph packageGraph, Library library, Class clazz) {
+    super.generateClass(packageGraph, library, clazz);
+    var data = ClassTemplateData(options, packageGraph, library, clazz);
+    var sidebarContent = templates.renderSidebarForContainer(data);
+    write(writer, clazz.sidebarPath, data, sidebarContent);
+    runtimeStats.incrementAccumulator('writtenSidebarFileCount');
+  }
+
+  @override
+  void generateEnum(PackageGraph packageGraph, Library library, Enum eNum) {
+    super.generateEnum(packageGraph, library, eNum);
+    var data = EnumTemplateData(options, packageGraph, library, eNum);
+    var sidebarContent = templates.renderSidebarForContainer(data);
+    write(writer, eNum.sidebarPath, data, sidebarContent);
+    runtimeStats.incrementAccumulator('writtenSidebarFileCount');
+  }
+
+  @override
+  void generateExtension(
+      PackageGraph packageGraph, Library library, Extension extension) {
+    super.generateExtension(packageGraph, library, extension);
+    var data = ExtensionTemplateData(options, packageGraph, library, extension);
+    var sidebarContent = templates.renderSidebarForContainer(data);
+    write(writer, extension.sidebarPath, data, sidebarContent);
+    runtimeStats.incrementAccumulator('writtenSidebarFileCount');
+  }
+
+  @override
+  void generateLibrary(PackageGraph packageGraph, Library library) {
+    super.generateLibrary(packageGraph, library);
+    var data = LibraryTemplateData(options, packageGraph, library);
+    var sidebarContent = templates.renderSidebarForLibrary(data);
+    write(writer, library.sidebarPath, data, sidebarContent);
+    runtimeStats.incrementAccumulator('writtenSidebarFileCount');
+  }
+
+  @override
+  void generateMixin(PackageGraph packageGraph, Library library, Mixin mixin) {
+    super.generateMixin(packageGraph, library, mixin);
+    var data = MixinTemplateData(options, packageGraph, library, mixin);
+    var sidebarContent = templates.renderSidebarForContainer(data);
+    write(writer, mixin.sidebarPath, data, sidebarContent);
+    runtimeStats.incrementAccumulator('writtenSidebarFileCount');
+  }
+
   @override
   void generatePackage(PackageGraph packageGraph, Package package) {
     super.generatePackage(packageGraph, package);