Add a few tests #43
Add a few tests #43
Conversation
As a bit of a follow-up to chrisbra#42, this adds tests for the syntax highlighting. Example zsh files are in testdata/*.zsh; after writing test files are verifying it's all good you can generate with "make update-tests", and you can run it with "make test". I included the testing.vim as a submodule here.
testdata/if.zsh
Outdated
| # TODO: maybe show error for these invalid constructs (missing spaces)? | ||
| [[x=x]] && [x=x] |
There was a problem hiding this comment.
These aren't invalid constructs; they're perfectly valid glob patterns. The first looks for a file named [] or =] or x]. The second one looks for a file named x or =.
Nevertheless, I agree that it might make sense to highlight these constructs as "this is probably wrong" (compare zsh-users/zsh-syntax-highlighting#695 and the issue linked from the first post there).
There was a problem hiding this comment.
Ah right, of course. I think we can get around that by highlighting it as an error only if it's after a zshConditional, or if it's preceded or followed by zshOperator. I'll update the comment.
testdata/quotes.zsh
Outdated
| # Test quoting. | ||
|
|
||
| 'single' 'var: $var' 'subst: $(ls)' 'esc: \n \x01 \001' | ||
| "double" "var: $var" "subst: $(ls)" "esc: \n \x01 \001" # TODO: these last 2 are not highlighted |
There was a problem hiding this comment.
On my machine, without this PR or other recent changes:
-
The
$(and)inside double quotes are highlighted, contrary to what the comment says. -
The
\n\x01\000are highlighted, contrary to what the comment says… but they shouldn't be:% print -r -- "\n \x01 \001" \n \x01 \001
testdata/quotes.zsh
Outdated
| 'escape: \" \' \` \\ escape' # TODO: maybe highlight \' as an error? | ||
| $'escape: \" \' \` \\ escape' |
There was a problem hiding this comment.
Careful here. Since \' is perfectly valid syntax, this line has two single-quoted strings: one with contents escape: \" \ and another with contents # TODO: maybe highlight \ [github is eating the leading whitespace]. There isn't any comment on this line at all, either.
Thus, if someone thinks that's a comment and adds the word "don't" to it, line 13 would no longer have a $'…' string in it. That seems somewhat brittle.
|
Thanks for the comments @danielshahaf; I mostly just added a few tests for whatever came to mind as an initial PR to set up testing; I didn't really look/test too carefully at what it ought to do. For now I tweaked the comments a bit; I'll look at the issues a bit more in the future. |
|
okay, thanks. Appreciate the work on tests :) |
As a bit of a follow-up to #42, this adds tests for the syntax
highlighting.
Example zsh files are in testdata/*.zsh; after writing test files are
verifying it's all good you can generate with "make update-tests", and
you can run it with "make test". I included the testing.vim as a
submodule here.