Completion config file error handling #355
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
houndci-bot
reviewed
Mar 3, 2019
|
|
||
| expect { starting_gitsh }.to raise_exception( | ||
| Gitsh::TabCompletion::DSL::ParseError, | ||
| /Invalid variable \(\$invalid_variable\) at line 1, column 11 in file #{config_path}/, |
There was a problem hiding this comment.
Metrics/LineLength: Line is too long. [96/80]
There was a problem hiding this comment.
These are too long, but I can't think of a nice way of breaking them up without reducing readability.
houndci-bot
reviewed
Mar 3, 2019
georgebrock
force-pushed
the
completion-error-handling
branch
2 times, most recently
from
299065e
to
9eb4e3a
Compare
mike-burns
reviewed
Mar 8, 2019
| @@ -6,7 +6,7 @@ module TabCompletion | |||
| module DSL | |||
| def self.load(path, start_state, env) | |||
| source = File.read(path) | |||
| tokens = Lexer.lex(source) | |||
| tokens = Lexer.lex(source, path) | |||
| @@ -72,6 +78,8 @@ def self.parse(tokens, opts = {}) | |||
| tokens, | |||
| opts.merge(env: Environment.new(opts.fetch(:gitsh_env))), | |||
| ) | |||
| rescue RLTK::NotInLanguage => error | |||
There was a problem hiding this comment.
Do we want to handle any of the other three exceptions that RLTK can raise?
(Maybe not InternalParserError.)
There was a problem hiding this comment.
I don't think we need to:
RLTK::BadTokenshould only happen if our lexer and parser disagree on what the set of tokens is, and I'd hope that would be caught by an integration test rather than raising at runtime.RLTK::HandledErrorshould only happen if the parser uses error productions, which currently we don't, not least because the RLTK README warns that they're not well tested, and because I don't fully understand what they're for.
There was a problem hiding this comment.
Excellent reasons. LGTM!
georgebrock
force-pushed
the
completion-error-handling
branch
2 times, most recently
from
a89a434
to
8c2b0d2
Compare
Loading the tab completion configuration files at start up, instead of lazily loading them on first use, allows us to report errors immediately instead of crashing when the user first tries to use tab completion.
georgebrock
force-pushed
the
completion-error-handling
branch
from
8c2b0d2
to
5d5a924
Compare
This commit introduces useful error reporting when a tab completion configuration file fails to parse. The error will report which token was unexpected, which file it was in, and exactly where in the file.
The tab completion configuration language supports variables which represent matchers for particular types of arguments, e.g. `$branch` or `$path`. This commit introduces error handling when a tab completion configuration file contains a variable that isn't supported by gitsh. The error message will include the name of the variable, the path to the file where the error occurred, and the exact position in the file.
georgebrock
force-pushed
the
completion-error-handling
branch
from
5d5a924
to
1055384
Compare
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.
This PR adds error reporting for problems with the tab completion. It covers several of the issues raised in #316.
Specifically:
??).$foo)