Add details text tag rendering in preprocessor #20
Conversation
This file contains 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
HettieS
force-pushed
the
add-govuk-details-tag-to-preprocessor
branch
3 times, most recently
from
a47168c to
525b245
Compare
peteryates
reviewed
Jan 4, 2023
|
Looks great, left one minor suggestion that will make adding extra preprocessing steps easier to add. |
* Preprocess details tags to allow for markdown usage * Substitute tags for relevant HTML * Small refactor to make methods chainable * Small test refactor
HettieS
force-pushed
the
add-govuk-details-tag-to-preprocessor
branch
from
525b245 to
64265ea
Compare
HettieS
force-pushed
the
add-govuk-details-tag-to-preprocessor
branch
4 times, most recently
from
6cb6f74 to
240a4ab
Compare
* Add def construct_details_from(match) and def format_punctuation to form details text array * Refactor
HettieS
force-pushed
the
add-govuk-details-tag-to-preprocessor
branch
from
240a4ab to
8433b67
Compare
peteryates
reviewed
Jan 5, 2023
Comment on lines
+51
to
+53
| summary_text, match, details = match_string.partition(Regexp.union(*partition_characters)) | ||
|
|
||
| summary = [summary_text, format_punctuation(match)].compact.join |
peteryates
approved these changes
Jan 5, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Context
This is a first stab at adding a preprocessing step for the Govuk Details component
This means that a start and end tag can be used in a markdown document i.e.
{details} some title. some text. {/details}and the correct details component will be rendered in the HTML.Changes
{details}def inject_detailsinto preprocessordef construct_details_from(match)to construct details array anddef format_punctuation(match)for correct formattingselfso that they can be chained indef preprocessdef preprocessso that HTML is injected before the markdown is processed by the rendererattr_reader :documenttoattr_reader :outputso it looks nicer when we call it indef preprocessUsage
I've built this so that the first sentence within the tag will be rendered as the details summary text. The rest of the content will then be rendered as the details text e.g.
{details} Find out about the fox and the dog. Whilst the fox is quick and brown, the dog is lazy. {/details}will appear like: