Skip to content

Commit c7f7ec5

Browse files
authored
Access TemplateRenderer from PackageGraph like other renderers (#2114)
* Consolidate property templates * Access TemplateRenderer from package graph * Update test file
1 parent d858abc commit c7f7ec5

File tree

5 files changed

+80
-137
lines changed

5 files changed

+80
-137
lines changed

lib/src/html/html_generator_instance.dart

Lines changed: 24 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ import 'dart:io' show File;
88

99
import 'package:collection/collection.dart' show compareNatural;
1010
import 'package:dartdoc/src/html/html_generator.dart' show HtmlGeneratorOptions;
11-
import 'package:dartdoc/src/html/template_render_helper.dart';
1211
import 'package:dartdoc/src/html/resource_loader.dart' as loader;
1312
import 'package:dartdoc/src/html/resources.g.dart' as resources;
1413
import 'package:dartdoc/src/html/template_data.dart';
@@ -29,7 +28,6 @@ class HtmlGeneratorInstance {
2928
final PackageGraph _packageGraph;
3029
final List<Indexable> _indexedElements = <Indexable>[];
3130
final FileWriter _writer;
32-
final HtmlRenderHelper _templateHelper = HtmlRenderHelper();
3331

3432
HtmlGeneratorInstance(
3533
this._options, this._templates, this._packageGraph, this._writer);
@@ -281,8 +279,7 @@ class HtmlGeneratorInstance {
281279
}
282280

283281
void generatePackage(PackageGraph packageGraph, Package package) {
284-
TemplateData data =
285-
PackageTemplateData(_options, packageGraph, _templateHelper, package);
282+
TemplateData data = PackageTemplateData(_options, packageGraph, package);
286283
logInfo('documenting ${package.name}');
287284

288285
_build(package.filePath, _templates.indexTemplate, data);
@@ -292,8 +289,7 @@ class HtmlGeneratorInstance {
292289
void generateCategory(PackageGraph packageGraph, Category category) {
293290
logInfo(
294291
'Generating docs for category ${category.name} from ${category.package.fullyQualifiedName}...');
295-
TemplateData data =
296-
CategoryTemplateData(_options, packageGraph, _templateHelper, category);
292+
TemplateData data = CategoryTemplateData(_options, packageGraph, category);
297293

298294
_build(category.filePath, _templates.categoryTemplate, data);
299295
}
@@ -304,98 +300,86 @@ class HtmlGeneratorInstance {
304300
if (!lib.isAnonymous && !lib.hasDocumentation) {
305301
packageGraph.warnOnElement(lib, PackageWarning.noLibraryLevelDocs);
306302
}
307-
TemplateData data =
308-
LibraryTemplateData(_options, packageGraph, _templateHelper, lib);
303+
TemplateData data = LibraryTemplateData(_options, packageGraph, lib);
309304

310305
_build(lib.filePath, _templates.libraryTemplate, data);
311306
}
312307

313308
void generateClass(PackageGraph packageGraph, Library lib, Class clazz) {
314-
TemplateData data =
315-
ClassTemplateData(_options, packageGraph, _templateHelper, lib, clazz);
309+
TemplateData data = ClassTemplateData(_options, packageGraph, lib, clazz);
316310
_build(clazz.filePath, _templates.classTemplate, data);
317311
}
318312

319313
void generateExtension(
320314
PackageGraph packageGraph, Library lib, Extension extension) {
321-
TemplateData data = ExtensionTemplateData(
322-
_options, packageGraph, _templateHelper, lib, extension);
315+
TemplateData data =
316+
ExtensionTemplateData(_options, packageGraph, lib, extension);
323317
_build(extension.filePath, _templates.extensionTemplate, data);
324318
}
325319

326320
void generateMixins(PackageGraph packageGraph, Library lib, Mixin mixin) {
327-
TemplateData data =
328-
MixinTemplateData(_options, packageGraph, _templateHelper, lib, mixin);
321+
TemplateData data = MixinTemplateData(_options, packageGraph, lib, mixin);
329322
_build(mixin.filePath, _templates.mixinTemplate, data);
330323
}
331324

332325
void generateConstructor(PackageGraph packageGraph, Library lib, Class clazz,
333326
Constructor constructor) {
334327
TemplateData data = ConstructorTemplateData(
335-
_options, packageGraph, _templateHelper, lib, clazz, constructor);
328+
_options, packageGraph, lib, clazz, constructor);
336329

337330
_build(constructor.filePath, _templates.constructorTemplate, data);
338331
}
339332

340333
void generateEnum(PackageGraph packageGraph, Library lib, Enum eNum) {
341-
TemplateData data =
342-
EnumTemplateData(_options, packageGraph, _templateHelper, lib, eNum);
334+
TemplateData data = EnumTemplateData(_options, packageGraph, lib, eNum);
343335

344336
_build(eNum.filePath, _templates.enumTemplate, data);
345337
}
346338

347339
void generateFunction(
348340
PackageGraph packageGraph, Library lib, ModelFunction function) {
349-
TemplateData data = FunctionTemplateData(
350-
_options, packageGraph, _templateHelper, lib, function);
341+
TemplateData data =
342+
FunctionTemplateData(_options, packageGraph, lib, function);
351343

352344
_build(function.filePath, _templates.functionTemplate, data);
353345
}
354346

355347
void generateMethod(
356348
PackageGraph packageGraph, Library lib, Container clazz, Method method) {
357-
TemplateData data = MethodTemplateData(
358-
_options, packageGraph, _templateHelper, lib, clazz, method);
349+
TemplateData data =
350+
MethodTemplateData(_options, packageGraph, lib, clazz, method);
359351

360352
_build(method.filePath, _templates.methodTemplate, data);
361353
}
362354

363-
void generateConstant(
364-
PackageGraph packageGraph, Library lib, Container clazz, Field property) {
365-
TemplateData data = ConstantTemplateData(
366-
_options, packageGraph, _templateHelper, lib, clazz, property);
367-
368-
_build(property.filePath, _templates.constantTemplate, data);
369-
}
355+
void generateConstant(PackageGraph packageGraph, Library lib, Container clazz,
356+
Field property) =>
357+
generateProperty(packageGraph, lib, clazz, property);
370358

371359
void generateProperty(
372360
PackageGraph packageGraph, Library lib, Container clazz, Field property) {
373-
TemplateData data = PropertyTemplateData(
374-
_options, packageGraph, _templateHelper, lib, clazz, property);
361+
TemplateData data =
362+
PropertyTemplateData(_options, packageGraph, lib, clazz, property);
375363

376364
_build(property.filePath, _templates.propertyTemplate, data);
377365
}
378366

379367
void generateTopLevelProperty(
380368
PackageGraph packageGraph, Library lib, TopLevelVariable property) {
381-
TemplateData data = TopLevelPropertyTemplateData(
382-
_options, packageGraph, _templateHelper, lib, property);
369+
TemplateData data =
370+
TopLevelPropertyTemplateData(_options, packageGraph, lib, property);
383371

384372
_build(property.filePath, _templates.topLevelPropertyTemplate, data);
385373
}
386374

387375
void generateTopLevelConstant(
388-
PackageGraph packageGraph, Library lib, TopLevelVariable property) {
389-
TemplateData data = TopLevelConstTemplateData(
390-
_options, packageGraph, _templateHelper, lib, property);
391-
392-
_build(property.filePath, _templates.topLevelConstantTemplate, data);
393-
}
376+
PackageGraph packageGraph, Library lib, TopLevelVariable property) =>
377+
generateTopLevelProperty(packageGraph, lib, property);
394378

395379
void generateTypeDef(
396380
PackageGraph packageGraph, Library lib, Typedef typeDef) {
397-
TemplateData data = TypedefTemplateData(
398-
_options, packageGraph, _templateHelper, lib, typeDef);
381+
TemplateData data =
382+
TypedefTemplateData(_options, packageGraph, lib, typeDef);
399383

400384
_build(typeDef.filePath, _templates.typeDefTemplate, data);
401385
}

0 commit comments

Comments
 (0)