Refactor header and footer support to use mustache templating. #2554
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Remove `mixin GeneratorContext` and move contained code into DartdocGeneratorOptionContext, the only class which mixed in this mixin. * **Breaking change**: Move DartdocGeneratorOptionContext from `lib/dartdoc.dart` to `lib/options.dart`, which is more directly related to the class, and is the only library in which this class is constructed or extended. * Add `header`, `footer`, and `footerText` getters to DartdocGeneratorOptionContext. * Add `customHeaderContent`, `customFooterContent`, and `customInnerFooterText` to DartdocGneratorBackendOptions. * **Breaking change**: Privatize the DartdocGeneratorBackendOptions into a new private constructor which takes no parameters. * Change all header/footer/footer-text placeholder comments in templates to instead be mustache interpolations.
parlough
approved these changes
Mar 3, 2021
jcollins-g
approved these changes
Mar 3, 2021
Contributor
jcollins-g
left a comment
jcollins-g
left a comment
There was a problem hiding this comment.
This looks good, and is way simpler than what I thought it would look like!
Approved, assuming you have tested this with Flutter and the custom headers/footers look reasonable there.
Member
Author
|
Header and footers look good to me. The use |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
mixin GeneratorContextand move contained code intoDartdocGeneratorOptionContext, the only class which mixed in this mixin.
lib/dartdoc.darttolib/options.dart, which is more directly related tothe class, and is the only library in which this class is constructed or
extended.
header,footer, andfooterTextgetters toDartdocGeneratorOptionContext.
customHeaderContent,customFooterContent, andcustomInnerFooterTextto DartdocGneratorBackendOptions.
private constructor which takes no parameters.
instead be mustache interpolations.