Fix Asciidoc syntax highlight #1276
Merged
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
This commit replaces the regular expression, which detects code blocks in the HTML document produced by a markup renderer, with a more general one. The new regular expression makes no assumptions on what HTML attributes can be set on <pre> or <code> element. As a consequence, code block's programming language detection is now slightly more complicated, because it must deal with parsing HTML attribute lists. A new private method has been defined to handle that.
Recognize "data-lang" HTML attribute, which is set on code blocks in HTML documents produced by AsciiDoctor.
The #html_markup_ruby method, which is responsible for creating HTML from Ruby snippets, produces output with syntax highlighting already applied. Doing it for the second time messes things up. It wasn't a big deal before the regular expression in #parse_codeblocks has been relaxed. Only a slightly different set of HTML attributes was preventing the rendered Ruby listings from being matched. But now, a proper fix is needed, and it is introduced in this very commit.
lsegal
approved these changes
Nov 26, 2019
|
Sorry for the delay here. Thanks for this! |
|
@lsegal Any chance for release? There are some gems which will benefit from this one, e.g. https://rubydoc.info/gems/enmail. |
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 pull request improves the way in which code listing blocks in extra file objects are matched.
In the result, listings in extra file objects written in AsciiDoc are now properly enriched with YARD: the syntax is highlighted, and the identifiers are linked with their respective documentation.
Fixes #1239 (went with option 2).
Details
The regular expression used for code blocks detection has been significantly relaxed. The updated one makes no assumptions on what HTML attributes can be set on
<pre>or<code>element, allowing everything. It still requires that the listing's outermost element is<pre>, but this seems to be a reasonable limitation.The programming language detection still considers the values of
classandlangHTML attributes. Moreover,data-langattribute, which is produced by AsciiDoctor markup processor, is also supported now.Finally, this pull request properly ensures that code blocks produced from Ruby source files are not highlighted twice. It wasn't a problem before only because of a very lucky situation that code blocks produced by
html_markup_rubyhave a slightly different attributes, and that was preventing them from being erroneously double-highlighted.Completed Tasks
bundle exec rakelocally (if code is attached to PR).