Open
Conversation
When a syntax contains a regex which can't compile, highlight_lines can
either return an error or ignore the faulty rule, depending on an
option:
let options = HighlightOptions {
ignore_errors: true,
..Default::default()
};
HighlightLines::new(syntax, theme, options)
Collaborator
|
Thanks for taking the time to create a PR. For the record I'm in favor of preventing panics. Any chance you can split this into smaller self-contained PRs for easier digestion and review? The smaller the better. |
Contributor
Author
|
I don't think it can really get smaller. Changes are just consequences of But if it's welcome (I'm also waiting for the bat people to check), I can make a clean PR without the changes in Cargo.toml. |
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
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.
(in large friendly letters)
Syntect can panic when highlighting on a syntax file containing a regular expression with a feature not supported by the regex engine.
This isn't theoretical and leads to panics in programs using syntect:
With this fork, the behavior on a syntax having an invalid rule isn't to panic anymore, and is tuned with options:
With
ignore_errors: false, a faulty regex in a syntax, detected when highlighting some lines, will result in an error.With
ignore_errors: true, the rule containing the faulty regex won't be applied but rest of the highlighting process will proceed.So it never panics but the calling program can opt for the old behavior by specifying
ignore_errors: falseand panicking on a returned error.