feat(gatsby-remark-prismjs): syntax highlighting inside diffs #26525
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
added support for syntax highlighting inside diffs using diff-xxxx pattern as language identifier ✅ Closes: gatsbyjs#20630
gatsbot
bot
added
the
status: triage needed
laurieontech
added
topic: remark/mdx
pieh
approved these changes
Sep 11, 2020
There was a problem hiding this comment.
Thanks for your patience @kenchandev!
I just added small stub in readme so this feature has some documentation + added 1 test to cover code changes in index.js file (mostly regex matching).
I think this is great addition, thanks a ton!
pragmaticpat
pushed a commit
to pragmaticpat/gatsby
that referenced
this pull request
Apr 28, 2022
…js#26525) * feat(gatsby-remark-prismjs): syntax highlighting inside diffs added support for syntax highlighting inside diffs using diff-xxxx pattern as language identifier ✅ Closes: gatsbyjs#20630 * add minimal documentation about `diff-[language]` * \w means [a-zA-Z0-9_] so we can drop \d ([0-9]) as it's already covered * add top level test to also cover regex part Co-authored-by: Michal Piechowiak <misiek.piechowiak@gmail.com>
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.
Description
This feature provides support for syntax highlighting inside diffs. In the last example shown on the Diff Highlight page of the Prism documentation, it demonstrates that within a diff code block, Prism is capable of highlighting the syntax in a specific language. See below snapshot to quickly preview what this feature does:
Currently, this is not supported by the
gatsby-remark-prismjsplugin. There was an issue about this missing feature, but it eventually closed due to inactivity.To support this feature, the modifications were minor:
diff-xxxxpattern (xxxxis a language such asjsorjavascript).classNameto allowlanguage-diff-xxxxifdiff-xxxxis specified as the language identifier of the code block.prism-diff-highlight.jsplugin. It only adds hooks (the same hooks ran byPrism.highlight) to Prism. Unlike theprism-line-highlightandprism-line-numbersplugins, there is no reference to thewindowobject within the scope of the plugin's IIFE, etc. Using thePrism.highlightmethod, it highlights the syntax inside diffs if the grammar is specified asdiffand the language is specified asdiff-xxxx:Prism.highlight(code, Prism.languages.diff, 'diff-' + diffLanguage).highlightCode()to accept an argument (diffLanguage) for the syntax highlighting language ifdiff-xxxxis specified as the language identifier of the code block.Documentation
Based on how issue #20630 was raised, other developers might also assume that this feature is automatically supported out-of-the-box by the plugin.
If documentation for this feature is needed, then feel free to let me know and I'll add it. I think it can be written in the Usage in Markdown section, but I'm not 100% certain if it belongs there or if a new section should be devoted to this.
Related Issues
Fixes #20630