Update automatic tpm installation instructions to avoid linting error #234
Conversation
| @@ -5,8 5,8 @@ One of the first things we do on a new machine is cloning our dotfiles. Not ever | |||
| If you want to install `tpm` and plugins automatically when tmux is started, put the following snippet in `.tmux.conf` before the final `run '~/.tmux/plugins/tpm/tpm'`: | |||
|
|
|||
| ``` | |||
| if "test ! -d ~/.tmux/plugins/tpm" \ | |||
| if-shell "test ! -d ~/.tmux/plugins/tpm" \ | |||
There was a problem hiding this comment.
if without then is valid tmux conf syntax.
I think VS code lint is complaining because it thinks this snippet is shell script.
Can you change the language for this snippet to be tmux and see what happens?
Try adding tmux like this at the top:
```tmux
I'd prefer to keep the current shorter if version because it's more succinct.
There was a problem hiding this comment.
Personally I like the more verbose keyword as it's easy to look up for a newcomer like me. At first I didn't know what that if meant, didn't even know tmux had its own language. I guess using if-shell a user is more likely to find the correct documentation page using a search engine, but its a matter of opinion of course!
EDIT: I checked and VSCode by default does not detect the language of the .tmux.conf file, but does not give errors if you do use the full keywords such as shell-if. I guess because its not colliding with reserved keywords such as if.
After installing a VSCode extension for tmux, the language is correctly detected and no errors are thrown regardless of the if keyword.
Currently the automatic tpm instructions are detected as syntax error by VS Code (
1:1: "if <cond>" must be followed by "then"). This can be fixed by usingif-shellinstead (ifis an alias forif-shellso behaviour should be identical, more info at https://linux.die.net/man/1/tmux).I also added some hyperlinks to original author profiles.