Skip to content

Remove packageGraph from TemplateData. #2379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 8, 2020
Merged

Remove packageGraph from TemplateData. #2379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 20 additions & 18 deletions lib/src/generator/template_data.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ abstract class TemplateOptions {
}

abstract class TemplateData<T extends Documentable> {
final PackageGraph packageGraph;
final PackageGraph _packageGraph;
final TemplateOptions htmlOptions;

TemplateData(this.htmlOptions, this.packageGraph);
TemplateData(this.htmlOptions, this._packageGraph);

String get title;
String get layoutTitle;
Expand Down Expand Up @@ -48,8 +48,14 @@ abstract class TemplateData<T extends Documentable> {
return '';
}

List<Package> get localPackages => _packageGraph.localPackages;

Package get defaultPackage => _packageGraph.defaultPackage;

bool get hasFooterVersion => _packageGraph.hasFooterVersion;

String _layoutTitle(String name, String kind, bool isDeprecated) =>
packageGraph.rendererFactory.templateRenderer
_packageGraph.rendererFactory.templateRenderer
.composeLayoutTitle(name, kind, isDeprecated);
}

Expand Down Expand Up @@ -125,7 +131,7 @@ class LibraryTemplateData extends TemplateData<Library> {
String get metaDescription =>
'${library.name} library API docs, for the Dart programming language.';
@override
List<Documentable> get navLinks => [packageGraph.defaultPackage];
List<Documentable> get navLinks => [_packageGraph.defaultPackage];

@override
String get layoutTitle =>
Expand Down Expand Up @@ -173,7 +179,7 @@ class ClassTemplateData<T extends Class> extends TemplateData<T> {
String get layoutTitle => _layoutTitle(
clazz.nameWithLinkedGenerics, clazz.fullkind, clazz.isDeprecated);
@override
List<Documentable> get navLinks => [packageGraph.defaultPackage, library];
List<Documentable> get navLinks => [_packageGraph.defaultPackage, library];
@override
String get htmlBase => '../';

Expand All @@ -182,14 +188,10 @@ class ClassTemplateData<T extends Class> extends TemplateData<T> {
return _objectType;
}

var dc = packageGraph.libraries
var dc = _packageGraph.libraries
.firstWhere((it) => it.name == 'dart:core', orElse: () => null);

if (dc == null) {
return _objectType = null;
}

return _objectType = dc.getClassByName('Object');
return _objectType = dc?.getClassByName('Object');
}
}

Expand All @@ -216,7 +218,7 @@ class ExtensionTemplateData<T extends Extension> extends TemplateData<T> {
@override
String get layoutTitle => _layoutTitle(extension.name, extension.kind, false);
@override
List<Documentable> get navLinks => [packageGraph.defaultPackage, library];
List<Documentable> get navLinks => [_packageGraph.defaultPackage, library];
@override
String get htmlBase => '../';
}
Expand All @@ -236,7 +238,7 @@ class ConstructorTemplateData extends TemplateData<Constructor> {
String get layoutTitle => _layoutTitle(
constructor.name, constructor.fullKind, constructor.isDeprecated);
@override
List<Documentable> get navLinks => [packageGraph.defaultPackage, library];
List<Documentable> get navLinks => [_packageGraph.defaultPackage, library];
@override
List<Container> get navLinksWithGenerics => [clazz];
@override
Expand Down Expand Up @@ -283,7 +285,7 @@ class FunctionTemplateData extends TemplateData<ModelFunction> {
'API docs for the ${function.name} function from the '
'${library.name} library, for the Dart programming language.';
@override
List<Documentable> get navLinks => [packageGraph.defaultPackage, library];
List<Documentable> get navLinks => [_packageGraph.defaultPackage, library];
@override
String get htmlBase => '../';
}
Expand Down Expand Up @@ -314,7 +316,7 @@ class MethodTemplateData extends TemplateData<Method> {
'API docs for the ${method.name} method from the '
'${container.name} ${containerDesc}, for the Dart programming language.';
@override
List<Documentable> get navLinks => [packageGraph.defaultPackage, library];
List<Documentable> get navLinks => [_packageGraph.defaultPackage, library];
@override
List<Container> get navLinksWithGenerics => [container];
@override
Expand Down Expand Up @@ -348,7 +350,7 @@ class PropertyTemplateData extends TemplateData<Field> {
'API docs for the ${property.name} ${property.kind} from the '
'${container.name} ${containerDesc}, for the Dart programming language.';
@override
List<Documentable> get navLinks => [packageGraph.defaultPackage, library];
List<Documentable> get navLinks => [_packageGraph.defaultPackage, library];
@override
List<Container> get navLinksWithGenerics => [container];
@override
Expand Down Expand Up @@ -377,7 +379,7 @@ class TypedefTemplateData extends TemplateData<Typedef> {
'API docs for the ${typeDef.name} property from the '
'${library.name} library, for the Dart programming language.';
@override
List<Documentable> get navLinks => [packageGraph.defaultPackage, library];
List<Documentable> get navLinks => [_packageGraph.defaultPackage, library];
@override
String get htmlBase => '../';
}
Expand All @@ -404,7 +406,7 @@ class TopLevelPropertyTemplateData extends TemplateData<TopLevelVariable> {
'API docs for the ${property.name} $_type from the '
'${library.name} library, for the Dart programming language.';
@override
List<Documentable> get navLinks => [packageGraph.defaultPackage, library];
List<Documentable> get navLinks => [_packageGraph.defaultPackage, library];
@override
String get htmlBase => '../';

Expand Down
8 changes: 4 additions & 4 deletions lib/templates/html/_footer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

<footer>
<span class="no-break">
{{packageGraph.defaultPackage.name}}
{{#packageGraph.hasFooterVersion}}
{{packageGraph.defaultPackage.version}}
{{/packageGraph.hasFooterVersion}}
{{defaultPackage.name}}
{{#hasFooterVersion}}
{{defaultPackage.version}}
{{/hasFooterVersion}}
</span>

{{! footer-text placeholder }}
Expand Down
4 changes: 2 additions & 2 deletions lib/templates/html/_packages.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<ol>
{{#packageGraph.localPackages}}
{{#localPackages}}
{{#isFirstPackage}}
{{#hasDocumentedCategories}}
<li class="section-title">Topics</li>
Expand All @@ -21,5 +21,5 @@
<li class="section-subitem">{{{linkedName}}}</li>
{{/publicLibraries}}
{{/categoriesWithPublicLibraries}}
{{/packageGraph.localPackages}}
{{/localPackages}}
</ol>
46 changes: 22 additions & 24 deletions lib/templates/html/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,33 +7,31 @@ <h5 class="hidden-xs"><span class="package-name">{{self.name}}</span> <span clas
</div>

<div id="dartdoc-main-content" class="col-xs-12 col-sm-9 col-md-8 main-content">
{{#packageGraph.defaultPackage}}
{{#defaultPackage}}
{{>documentation}}
{{/packageGraph.defaultPackage}}
{{/defaultPackage}}

{{#packageGraph}}
{{#localPackages}}
<section class="summary">
{{#isFirstPackage}}
<h2>Libraries</h2>
{{/isFirstPackage}}
{{^isFirstPackage}}
<h2>{{name}}</h2>
{{/isFirstPackage}}
<dl>
{{#defaultCategory.publicLibraries}}
{{#localPackages}}
<section class="summary">
{{#isFirstPackage}}
<h2>Libraries</h2>
{{/isFirstPackage}}
{{^isFirstPackage}}
<h2>{{name}}</h2>
{{/isFirstPackage}}
<dl>
{{#defaultCategory.publicLibraries}}
{{>library}}
{{/defaultCategory.publicLibraries}}
{{#categoriesWithPublicLibraries}}
<h3>{{name}}</h3>
{{#publicLibraries}}
{{>library}}
{{/defaultCategory.publicLibraries}}
{{#categoriesWithPublicLibraries}}
<h3>{{name}}</h3>
{{#publicLibraries}}
{{>library}}
{{/publicLibraries}}
{{/categoriesWithPublicLibraries}}
</dl>
</section>
{{/localPackages}}
{{/packageGraph}}
{{/publicLibraries}}
{{/categoriesWithPublicLibraries}}
</dl>
</section>
{{/localPackages}}

</div> <!-- /.main-content -->

Expand Down
6 changes: 2 additions & 4 deletions lib/templates/md/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@

# {{ title }}

{{#packageGraph.defaultPackage}}
{{#defaultPackage}}
{{>documentation}}
{{/packageGraph.defaultPackage}}
{{/defaultPackage}}

{{#packageGraph}}
{{#localPackages}}
{{#isFirstPackage}}
## Libraries
Expand All @@ -27,6 +26,5 @@
{{/publicLibraries}}
{{/categoriesWithPublicLibraries}}
{{/localPackages}}
{{/packageGraph}}

{{>footer}}
8 changes: 4 additions & 4 deletions testing/test_package_custom_templates/templates/_footer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

<footer>
<span class="no-break">
{{packageGraph.defaultPackage.name}}
{{#packageGraph.hasFooterVersion}}
{{packageGraph.defaultPackage.version}}
{{/packageGraph.hasFooterVersion}}
{{defaultPackage.name}}
{{#hasFooterVersion}}
{{defaultPackage.version}}
{{/hasFooterVersion}}
</span>

{{! footer-text placeholder }}
Expand Down
4 changes: 2 additions & 2 deletions testing/test_package_custom_templates/templates/_packages.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<ol>
{{#packageGraph.localPackages}}
{{#localPackages}}
{{#isFirstPackage}}
{{#hasDocumentedCategories}}
<li class="section-title">Topics</li>
Expand All @@ -21,5 +21,5 @@
<li class="section-subitem">{{{linkedName}}}</li>
{{/publicLibraries}}
{{/categoriesWithPublicLibraries}}
{{/packageGraph.localPackages}}
{{/localPackages}}
</ol>
48 changes: 23 additions & 25 deletions testing/test_package_custom_templates/templates/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,33 +10,31 @@ <h5 class="hidden-xs"><span class="package-name">{{self.name}}</span> <span clas


<div id="dartdoc-main-content" class="col-xs-12 col-sm-9 col-md-8 main-content">
{{#packageGraph.defaultPackage}}
{{#defaultPackage}}
{{>documentation}}
{{/packageGraph.defaultPackage}}

{{#packageGraph}}
{{#localPackages}}
<section class="summary">
{{#isFirstPackage}}
<h2>Libraries</h2>
{{/isFirstPackage}}
{{^isFirstPackage}}
<h2>{{name}}</h2>
{{/isFirstPackage}}
<dl>
{{#defaultCategory.publicLibraries}}
{{/defaultPackage}}

{{#localPackages}}
<section class="summary">
{{#isFirstPackage}}
<h2>Libraries</h2>
{{/isFirstPackage}}
{{^isFirstPackage}}
<h2>{{name}}</h2>
{{/isFirstPackage}}
<dl>
{{#defaultCategory.publicLibraries}}
{{>library}}
{{/defaultCategory.publicLibraries}}
{{#categoriesWithPublicLibraries}}
<h3>{{name}}</h3>
{{#publicLibraries}}
{{>library}}
{{/defaultCategory.publicLibraries}}
{{#categoriesWithPublicLibraries}}
<h3>{{name}}</h3>
{{#publicLibraries}}
{{>library}}
{{/publicLibraries}}
{{/categoriesWithPublicLibraries}}
</dl>
</section>
{{/localPackages}}
{{/packageGraph}}
{{/publicLibraries}}
{{/categoriesWithPublicLibraries}}
</dl>
</section>
{{/localPackages}}

</div> <!-- /.main-content -->

Expand Down