Better YAML front matter parsing in commonmark-ext-yaml-front-matter - #445
Open
zyxist wants to merge 1 commit into
Open
Better YAML front matter parsing in commonmark-ext-yaml-front-matter#445zyxist wants to merge 1 commit into
zyxist wants to merge 1 commit into
Conversation
…ext-yaml-front-matter
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Last year, I reported the issue #391 - I found some time to turn it into the contribution, based on the outcome of the discussion. I will be happy to discuss the approach and apply any improvements, if necessary.
Summary
The PR splits the YAML front matter processing into two parts:
YamlFrontMatterExtractor.I moved the existing built-in parser of YAML subset into one of the two extractors:
YamlDataExtractor. The other extractor isYamlContentExtractorthat extracts the front matter as a string for further processing with other tools.Compatibility
The changes are backward-compatible.
YamlDataExtractoris the default extractor, and one must explicitly initialize the extension withYamlContentExtractorto get the string content. The visitor and Markdown renderer support both modes.Naming
For the existing parser, I strived to keep consistent naming to help understand the connection:
YamlFrontMatterVisitor.getData()(existing method) =>YamlDataExtractor.