writers: Recognize extra syntax definitions #7241
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
Since Skylighting does not support Nix syntax, we need to add custom syntax definition using --syntax-definition flag, otherwise files with nix extension will be recognized as bash scripts by the default syntax map. This means that code blocks with nix class will end up with language=bash when converted to DocBook and other formats. Unfortunately, the writers always use the default syntax map so adding custom definition will not help. This patch corrects that, allowing the writers to see all custom definitions. The LaTeX reader suffers from the same issue but it has not been fixed there since it would require wider changes.
jtojnar
force-pushed
the
writer-extra-syntaxes
branch
from
19f78d2
to
dd25f84
Compare
|
Fixed the |
jgm
reviewed
Apr 25, 2021
| [T.toLower (sName s) | s <- syntaxesByExtension defaultSyntaxMap (T.unpack ext)] | ||
| languagesByExtension :: SyntaxMap -> T.Text -> [T.Text] | ||
| languagesByExtension syntaxmap ext = | ||
| [T.toLower (sName s) | s <- syntaxesByExtension syntaxmap (T.unpack ext)] | ||
|
|
There was a problem hiding this comment.
Note that this would be a breaking API change. (Not a reason against, necessarily, but should be noted very clearly in the commit log.)
There was a problem hiding this comment.
Should I add something like + Text.Pandoc.Highlighting: languages and languagesByExtension now take an additional SyntaxMap argument. Get it from writerOpts or use Skylighting’s defaultSyntaxMap. [API change].
Or I can create new functions and make the old ones call them with defaultSyntaxMap.
|
It looks good otherwise. I just merged it, and (doh!) forgot to add the commit message noted above. |
jgm
added a commit
that referenced
this pull request
Apr 25, 2021
Also taking this opportunity to note, for the record, that the commit for #7241 should be marked [API change]. It changes the type of `languagesByExtension` in Highlighting, adding a parameter for a `SyntaxMap`.
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.
Since Skylighting does not support Nix syntax, we need to add custom syntax definition using --syntax-definition flag, otherwise files with nix extension will be recognized as bash scripts by the default syntax map. This means that code blocks with nix class will end up with language=bash when converted to DocBook and other formats.
Unfortunately, the writers always use the default syntax map so adding custom definition will not help.
This patch corrects that, allowing the writers to see all custom definitions.
The LaTeX reader suffers from the same issue but it has not been fixed there since it would require wider changes.
Test