aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2017-11-08 13:41:51 +1300
committerTom Ryder <tom@sanctum.geek.nz>2017-11-08 13:41:51 +1300
commitf855ec0a7e76223d318ee4f0924d131643133e78 (patch)
treec16e358fc863cfaaa511d954df54187f9942a4f5
parent443e09ec6c1016bde860f8997b161df744d0153b (diff)
parent02a368550446f9d2ee959905e0d633dc0f4edc98 (diff)
downloaddotfiles-f855ec0a7e76223d318ee4f0924d131643133e78.tar.gz
Merge branch 'feature/vim-review' into develop
* feature/vim-review: Use consistent/thorough ftplugin/indent unloading Add clustering for POSIX shell syntax groups Add `kill` as shStatement Add `break`, `continue`, `return` as shStatement Override commands and variables for syntax/sh.vim Disable unwanted shell error syntax for any shell Break a long conditional in vim/ftdetect/sh.vim Rename b:check and b:lint with sh_ prefix Remove overkill defined-and-false check of sh vars Clear b:check/lint in ftdetect/sh.vim b:undo Move ftplugin/sh.vim b:undo def to end of file Use correct undo variable name in ftplugin/sh.vim Remove superfluous augroups around ftdetect defs Use sh.vim local vars not global POSIX hacks
-rw-r--r--vim/after/syntax/sh.vim113
-rw-r--r--vim/ftdetect/csv.vim9
-rw-r--r--vim/ftdetect/muttrc.vim9
-rw-r--r--vim/ftdetect/sh.vim34
-rw-r--r--vim/ftdetect/tsv.vim9
-rw-r--r--vim/ftdetect/xdefaults.vim9
-rw-r--r--vim/ftplugin/html.vim6
-rw-r--r--vim/ftplugin/mail.vim2
-rw-r--r--vim/ftplugin/markdown.vim6
-rw-r--r--vim/ftplugin/perl.vim6
-rw-r--r--vim/ftplugin/sh.vim65
-rw-r--r--vim/ftplugin/text.vim6
-rw-r--r--vim/ftplugin/vim.vim4
-rw-r--r--vim/indent/csv.vim2
-rw-r--r--vim/indent/tsv.vim2
-rw-r--r--vim/indent/vim.vim10
16 files changed, 191 insertions, 101 deletions
diff --git a/vim/after/syntax/sh.vim b/vim/after/syntax/sh.vim
index d07f4cff..ba209e99 100644
--- a/vim/after/syntax/sh.vim
+++ b/vim/after/syntax/sh.vim
@@ -1,23 +1,104 @@
-" If g:is_posix is set, g:is_kornshell is probably set too, a strange decision
-" by sh.vim. No matter; we can tease out whether this is actually a Korn shell
-" script using our own b:is_ksh flag set at the end of ~/.vim/ftdetect/sh.vim,
-" and if it isn't, we'll throw away the highlighting groups for ksh.
-if exists('g:is_kornshell') && !exists('b:is_ksh')
- syntax clear kshSpecialVariables
- syntax clear kshStatement
+" If we know we have another shell type, clear away the others completely, now
+" that core syntax/sh.vim is done prodding /bin/sh to determine the system
+" shell type (which I don't care about).
+if exists('b:is_bash')
+ unlet! b:is_sh b:is_posix b:is_kornshell
+elseif exists('b:is_kornshell')
+ unlet! b:is_sh b:is_posix
+elseif exists('b:is_posix')
+ unlet! b:is_sh
endif
-" Some corrections for highlighting if we have any of POSIX, Bash, or Ksh
-if exists('g:is_posix') || exists('b:is_bash') || exists('b:is_ksh')
+" The syntax highlighter seems to flag '/baz' in '"${foo:-"$bar"/baz}"' as an
+" error, which it isn't, at least in POSIX sh, Bash, and Ksh.
+syntax clear shDerefWordError
+
+" The syntax highlighter doesn't match parens for subshells for 'if' tests
+" correctly if they're on separate lines. This happens enough that it's
+" probably not worth keeping the error.
+syntax clear shParenError
+
+" Highlighting corrections specific to POSIX mode
+if exists('b:is_posix')
- " The syntax highlighter seems to flag '/baz' in '"${foo:-"$bar"/baz}"' as an
- " error, and I'm pretty sure it's not, at least in POSIX sh, Bash, and Ksh.
- syntax clear shDerefWordError
+ " Highlight some commands that are both defined by POSIX and builtin
+ " commands in dash, as a rough but useable proxy for 'shell builtins'. This
+ " list was mostly wrested from `man 1 dash`. Also include control structure
+ " keywords like `break`, `continue`, and `return`.
+ syntax clear shStatement
+ syntax cluster shCommandSubList add=shStatement
+ syntax cluster shCaseList add=shStatement
+ syntax keyword shStatement
+ \ alias
+ \ bg
+ \ break
+ \ cd
+ \ command
+ \ continue
+ \ echo
+ \ eval
+ \ exec
+ \ exit
+ \ export
+ \ fc
+ \ fg
+ \ getopts
+ \ hash
+ \ kill
+ \ printf
+ \ pwd
+ \ read
+ \ readonly
+ \ return
+ \ set
+ \ shift
+ \ test
+ \ times
+ \ trap
+ \ true
+ \ type
+ \ ulimit
+ \ umask
+ \ unalias
+ \ unset
+ \ wait
- " The syntax highlighter doesn't match parens for subshells for 'if' tests
- " correctly if they're on separate lines. This happens enough that it's
- " probably not worth keeping the error.
- syntax clear shParenError
+ " Core syntax/sh.vim puts IFS and other variables that affect shell function
+ " in another color, but a subset of them actually apply to POSIX shell too
+ " (and plain Bourne). These are selected by searching the POSIX manpages. I
+ " added NLSPATH too, which wasn't in the original.
+ syntax clear shShellVariables
+ syntax cluster shCommandSubList add=shShellVariables
+ syntax keyword shShellVariables
+ \ CDPATH
+ \ ENV
+ \ FCEDIT
+ \ HISTFILE
+ \ HISTSIZE
+ \ HISTTIMEFORMAT
+ \ HOME
+ \ IFS
+ \ LANG
+ \ LC_ALL
+ \ LC_COLLATE
+ \ LC_CTYPE
+ \ LC_MESSAGES
+ \ LC_NUMERIC
+ \ LINENO
+ \ MAIL
+ \ MAILCHECK
+ \ MAILPATH
+ \ NLSPATH
+ \ OLDPWD
+ \ OPTARG
+ \ OPTERR
+ \ OPTIND
+ \ PATH
+ \ PS1
+ \ PS2
+ \ PS3
+ \ PS4
+ \ PWD
endif
diff --git a/vim/ftdetect/csv.vim b/vim/ftdetect/csv.vim
index e5a38e10..a234c093 100644
--- a/vim/ftdetect/csv.vim
+++ b/vim/ftdetect/csv.vim
@@ -1,7 +1,4 @@
" Add automatic commands to detect CSV files
-augroup dotfiles_ftdetect_csv
- autocmd!
- autocmd BufNewFile,BufRead
- \ *.csv
- \ setfiletype csv
-augroup END
+autocmd BufNewFile,BufRead
+ \ *.csv
+ \ setfiletype csv
diff --git a/vim/ftdetect/muttrc.vim b/vim/ftdetect/muttrc.vim
index 0f625f2b..55eeea93 100644
--- a/vim/ftdetect/muttrc.vim
+++ b/vim/ftdetect/muttrc.vim
@@ -1,7 +1,4 @@
" Add automatic commands to detect .muttrc files
-augroup dotfiles_ftdetect_muttrc
- autocmd!
- autocmd BufNewFile,BufRead
- \ **/.dotfiles/mutt/muttrc.d/*.rc,**/.muttrc.d/*.rc
- \ setfiletype muttrc
-augroup END
+autocmd BufNewFile,BufRead
+ \ **/.dotfiles/mutt/muttrc.d/*.rc,**/.muttrc.d/*.rc
+ \ setfiletype muttrc
diff --git a/vim/ftdetect/sh.vim b/vim/ftdetect/sh.vim
index f00a5659..880f08e9 100644
--- a/vim/ftdetect/sh.vim
+++ b/vim/ftdetect/sh.vim
@@ -1,23 +1,19 @@
" Add automatic commands to choose shell flavours based on filename pattern
-augroup dotfiles_ftdetect_sh
- autocmd!
- " Names/paths of things that are Bash shell script
- autocmd BufNewFile,BufRead
- \ **/.dotfiles/bash/**,bash-fc-*
- \ let b:is_bash = 1
- \ | setfiletype sh
+" Names/paths of things that are Bash shell script
+autocmd BufNewFile,BufRead
+ \ **/.dotfiles/bash/**,bash-fc-*
+ \ let b:is_bash = 1
+ \ | setfiletype sh
- " Names/paths of things that are Korn shell script
- autocmd BufNewFile,BufRead
- \ **/.dotfiles/ksh/**,.kshrc,*.ksh
- \ let b:is_kornshell = 1
- \ | setfiletype sh
+" Names/paths of things that are Korn shell script
+autocmd BufNewFile,BufRead
+ \ **/.dotfiles/ksh/**,.kshrc,*.ksh
+ \ let b:is_kornshell = 1
+ \ | setfiletype sh
- " Names/paths of things that are POSIX shell script
- autocmd BufNewFile,BufRead
- \ **/.dotfiles/sh/**,.shinit,.shrc,.xinitrc,/etc/default/*
- \ let b:is_posix = 1
- \ | setfiletype sh
-
-augroup END
+" Names/paths of things that are POSIX shell script
+autocmd BufNewFile,BufRead
+ \ **/.dotfiles/sh/**,.shinit,.shrc,.xinitrc,/etc/default/*
+ \ let b:is_posix = 1
+ \ | setfiletype sh
diff --git a/vim/ftdetect/tsv.vim b/vim/ftdetect/tsv.vim
index 673721f5..a345ac65 100644
--- a/vim/ftdetect/tsv.vim
+++ b/vim/ftdetect/tsv.vim
@@ -1,7 +1,4 @@
" Add automatic commands to detect TSV files
-augroup dotfiles_ftdetect_tsv
- autocmd!
- autocmd BufNewFile,BufRead
- \ *.tsv
- \ setfiletype tsv
-augroup END
+autocmd BufNewFile,BufRead
+ \ *.tsv
+ \ setfiletype tsv
diff --git a/vim/ftdetect/xdefaults.vim b/vim/ftdetect/xdefaults.vim
index 1529e5c9..f45a22a7 100644
--- a/vim/ftdetect/xdefaults.vim
+++ b/vim/ftdetect/xdefaults.vim
@@ -1,7 +1,4 @@
" Add automatic commands to find Xresources subfiles
-augroup dotfiles_ftdetect_xdefaults
- autocmd!
- autocmd BufNewFile,BufRead
- \ **/.Xresources.d/*
- \ setfiletype xdefaults
-augroup END
+autocmd BufNewFile,BufRead
+ \ **/.Xresources.d/*
+ \ setfiletype xdefaults
diff --git a/vim/ftplugin/html.vim b/vim/ftplugin/html.vim
index 3db5dcca..27b38424 100644
--- a/vim/ftplugin/html.vim
+++ b/vim/ftplugin/html.vim
@@ -28,3 +28,9 @@ endfunction
nnoremap <buffer> <silent>
\ <LocalLeader>r
\ :<C-U>call <SID>UrlLink()<CR>
+
+" Unload this filetype plugin
+let b:undo_user_ftplugin = ''
+ \ . '|silent! nunmap <LocalLeader>c'
+ \ . '|silent! nunmap <LocalLeader>t'
+ \ . '|silent! nunmap <LocalLeader>r'
diff --git a/vim/ftplugin/mail.vim b/vim/ftplugin/mail.vim
index d4840bfd..697ce499 100644
--- a/vim/ftplugin/mail.vim
+++ b/vim/ftplugin/mail.vim
@@ -1,4 +1,6 @@
" Use trailing whitespace to denote continued paragraph
setlocal formatoptions+=w
+
+" Unload this filetype plugin
let b:undo_user_ftplugin
\ = 'setlocal formatoptions<'
diff --git a/vim/ftplugin/markdown.vim b/vim/ftplugin/markdown.vim
index ab27c2f7..f26fb156 100644
--- a/vim/ftplugin/markdown.vim
+++ b/vim/ftplugin/markdown.vim
@@ -1,6 +1,8 @@
" Spellcheck documents by default
if has('syntax')
setlocal spell
- let b:undo_user_ftplugin
- \ = 'setlocal spell<'
endif
+
+" Unload this filetype plugin
+let b:undo_user_ftplugin
+ \ = 'silent! setlocal spell<'
diff --git a/vim/ftplugin/perl.vim b/vim/ftplugin/perl.vim
index 07cf9a1f..7f6eb7fe 100644
--- a/vim/ftplugin/perl.vim
+++ b/vim/ftplugin/perl.vim
@@ -12,3 +12,9 @@ nnoremap <buffer> <silent>
nnoremap <buffer> <silent>
\ <LocalLeader>t
\ :<C-U>%!perltidy<CR>
+
+" Unload this filetype plugin
+let l:undo_user_ftplugin = ''
+ \ . '|silent! unmap <LocalLeader>c'
+ \ . '|silent! unmap <LocalLeader>l'
+ \ . '|silent! unmap <LocalLeader>t'
diff --git a/vim/ftplugin/sh.vim b/vim/ftplugin/sh.vim
index 21d494e3..a8c94445 100644
--- a/vim/ftplugin/sh.vim
+++ b/vim/ftplugin/sh.vim
@@ -1,52 +1,53 @@
-" Default to POSIX shell, as I never write Bourne, and if I write Bash or Ksh
-" it'll be denoted with either a shebang or an appropriate extension.
-let g:is_posix = 1
-
-"
-" Setting g:is_posix above also prompts Vim's core syntax/sh.vim script to
-" set g:is_kornshell and thereby b:is_kornshell to the same value as g:is_posix.
"
-" That's very confusing, so before it happens we'll copy b:is_kornshell's
-" value as determined by filetype.vim and ~/.vim/ftdetect/sh.vim into a custom
-" variable b:is_ksh, before its meaning gets confused.
+" If we have a #!/bin/sh shebang and filetype.vim determined we were neither
+" POSIX nor Bash nor Korn shell, we'll guess POSIX, just because it's far more
+" likely that's what I want to write than plain Bourne shell.
"
-" b:is_ksh as a name is more inline with b:is_bash and b:is_sh, anyway, so
-" we'll just treat b:is_kornshell like it's both misnamed and broken.
+" You're supposed to be able to do this by setting g:is_posix, but if that's
+" set, the syntax file ends up setting g:is_kornshell for you too, for reasons
+" I don't really understand. This method works though, and is cleaner than
+" the other workaround I had been trying.
"
-" We can then switch on our custom variable in ~/.vim/after/syntax/sh.vim to
-" apply settings that actually *are* unique to Korn shell and its derivatives.
-"
-if exists('b:is_kornshell')
- let b:is_ksh = b:is_kornshell
+if exists('b:is_sh')
+ unlet b:is_sh
+ if !exists('b:is_bash') && !exists('b:is_kornshell')
+ let b:is_posix = 1
+ endif
endif
" Use han(1df) as a man(1) wrapper for Bash files if available
-if exists('b:is_bash') && executable('han')
+if exists('b:is_bash')
+ \ && executable('han')
setlocal keywordprg=han
- let b:undo_user_indent
- \ = 'setlocal keywordprg<'
endif
" Map checker based on shell family
-if exists('b:is_bash') && b:is_bash
- let b:check = 'write !bash -n'
-elseif exists('b:is_ksh') && b:is_ksh
- let b:check = 'write !ksh -n'
+if exists('b:is_bash')
+ let b:sh_check = 'write !bash -n'
+elseif exists('b:is_kornshell')
+ let b:sh_check = 'write !ksh -n'
else
- let b:check = 'write !sh -n'
+ let b:sh_check = 'write !sh -n'
endif
nnoremap <buffer> <silent>
\ <LocalLeader>c
- \ :<C-U>execute b:check<CR>
+ \ :<C-U>execute b:sh_check<CR>
" Map linter based on shell family
-if exists('b:is_bash') && b:is_bash
- let b:lint = 'write !shellcheck -s bash -'
-elseif exists('b:is_ksh') && b:is_ksh
- let b:lint = 'write !shellcheck -s ksh -'
+if exists('b:is_bash')
+ let b:sh_lint = 'write !shellcheck -s bash -'
+elseif exists('b:is_kornshell')
+ let b:sh_lint = 'write !shellcheck -s ksh -'
else
- let b:lint = 'write !shellcheck -s sh -'
+ let b:sh_lint = 'write !shellcheck -s sh -'
endif
nnoremap <buffer> <silent>
\ <LocalLeader>l
- \ :<C-U>execute b:lint<CR>
+ \ :<C-U>execute b:sh_lint<CR>
+
+" Unload this filetype plugin
+let b:undo_user_ftplugin = ''
+ \ . '|setlocal keywordprg<'
+ \ . '|unlet! b:sh_check b:sh_lint'
+ \ . '|silent! unmap <LocalLeader>c'
+ \ . '|silent! unmap <LocalLeader>l'
diff --git a/vim/ftplugin/text.vim b/vim/ftplugin/text.vim
index ab27c2f7..f26fb156 100644
--- a/vim/ftplugin/text.vim
+++ b/vim/ftplugin/text.vim
@@ -1,6 +1,8 @@
" Spellcheck documents by default
if has('syntax')
setlocal spell
- let b:undo_user_ftplugin
- \ = 'setlocal spell<'
endif
+
+" Unload this filetype plugin
+let b:undo_user_ftplugin
+ \ = 'silent! setlocal spell<'
diff --git a/vim/ftplugin/vim.vim b/vim/ftplugin/vim.vim
index d4e55ace..e8113134 100644
--- a/vim/ftplugin/vim.vim
+++ b/vim/ftplugin/vim.vim
@@ -4,3 +4,7 @@
nnoremap <buffer> <silent>
\ <LocalLeader>l
\ :<C-U>write !vint -s /dev/stdin<CR>
+
+" Unload this filetype plugin
+let b:undo_user_ftplugin
+ \ = 'silent! nunmap <LocalLeader>l'
diff --git a/vim/indent/csv.vim b/vim/indent/csv.vim
index 682bc3a8..ae2b6f6c 100644
--- a/vim/indent/csv.vim
+++ b/vim/indent/csv.vim
@@ -1,5 +1,7 @@
" Manual indenting and literal tabs for CSVs
setlocal noautoindent
setlocal noexpandtab
+
+" Unload this indent plugin
let b:undo_user_indent
\ = 'setlocal autoindent< expandtab<'
diff --git a/vim/indent/tsv.vim b/vim/indent/tsv.vim
index 951b3e60..759602ed 100644
--- a/vim/indent/tsv.vim
+++ b/vim/indent/tsv.vim
@@ -1,5 +1,7 @@
" Manual indenting and literal tabs for TSVs
setlocal noautoindent
setlocal noexpandtab
+
+" Unload this indent plugin
let b:undo_user_indent
\ = 'setlocal autoindent< expandtab<'
diff --git a/vim/indent/vim.vim b/vim/indent/vim.vim
index 047a353d..138b9205 100644
--- a/vim/indent/vim.vim
+++ b/vim/indent/vim.vim
@@ -3,9 +3,7 @@ setlocal shiftwidth=2
setlocal softtabstop=2
setlocal tabstop=2
-" Ancient Vim can't use the '<' suffix syntax for resetting local integer
-" options
-if v:version > 700
- let b:undo_user_indent
- \ = 'setlocal shiftwidth< softtabstop< tabstop<'
-endif
+" Unload this indent plugin; suppress errors because ancient Vim can't use the
+" '<' suffix syntax for resetting local integer
+let b:undo_user_indent
+ \ = 'silent! setlocal shiftwidth< softtabstop< tabstop<'