path: root/vim/after/ftplugin/sh/lint.vim
diff options
authorTom Ryder <tom@sanctum.geek.nz>2017-11-12 14:42:59 +1300
committerTom Ryder <tom@sanctum.geek.nz>2017-11-12 20:27:54 +1300
commit6e9eb56edb2c5ec48e6daac0b46219c8a2bd24c0 (patch)
treebe1d47def25a5cfbfd4e10905c05a2ec26803f33 /vim/after/ftplugin/sh/lint.vim
parentMerge branch 'feature/vim-plug-boilplate' into develop (diff)
Move lots of local Vim config into vim/after
This is a relatively drastic change that should have been done progressively, but I got carried away in ripping everything out and putting it back in again. Reading the documentation for writing a Vim script (:help usr_41.txt), I am convinced that all of the content that was in the vim/ftplugin directory and some of the vim/indent directory actually belonged in vim/after/ftplugin and vim/after/indent respectively. This is because the section on filetypes makes the distinction between replacing the core filetype or indent plugins and merely adding to or editing them after the fact; from :help ftplugin: > If you do want to use the default plugin, but overrule one of the > settings, you can write the different setting in a script: > > setlocal textwidth=70 > > Now write this in the "after" directory, so that it gets sourced after > the distributed "vim.vim" ftplugin after-directory. For Unix this > would be "~/.vim/after/ftplugin/vim.vim". Note that the default > plugin will have set "b:did_ftplugin", but it is ignored here. Therefore, I have deleted the user_indent.vim and user_ftplugin.vim plugins and their documentation that I wrote, and their ftplugin.vim and indent.vim shims in ~/.vim, in an attempt to make these plugins elegantly undo-ready, and instead embraced the way the documentation and $VIMRUNTIME structure seems to suggest. I broke the ftplugin files up by function and put them under subdirectories of vim/after named by filetype, as the 'runtimepath' layout permits. In doing so, I also carefully applied the documentation's advice: * Short-circuiting repeated loads * Checking for existing mappings using the <Plug> prefix approach * Avoiding repeated function declarations overwriting each other * Guarding against 'cpotions' mangling things (by simply short-circuiting if 'compatible' is set). I've made the b:undo_ftplugin and b:undo_indent commands less forgiving, and append commands to it inline with the initial establishment of the setup they're reversing, including checking that the b:undo_* variable actually exists in the first place. For the indentation scripts, however, three of the four files originally in vim/indent actually do belong there: 1. csv.vim, because it doesn't have an indent file in the core. 2. tsv.vim, because it doesn't have an indent file in the core. 3. php.vim, because it does what ftplugins are allowed to do in preventing the core indent rules from running at all. The indent/vim.vim rules, however, have been moved to after/indent/vim.vim, because the tweaks it makes for two-space indentation are designed to supplement the core indent rules, not replace them. Finally, I've adjusted Makefile targets accordingly for the above, given the vim/ftplugin directory is now empty and there are three new directories in vim/after to install. We wrap these under a single `install-vim-after` parent target for convenience. The `install-vim-after-ftplugin` target accommodates the additional level of filetype directories beneath it.
Diffstat (limited to 'vim/after/ftplugin/sh/lint.vim')
1 files changed, 40 insertions, 0 deletions
diff --git a/vim/after/ftplugin/sh/lint.vim b/vim/after/ftplugin/sh/lint.vim
new file mode 100644
index 00000000..54f86bea
--- /dev/null
+++ b/vim/after/ftplugin/sh/lint.vim
@@ -0,0 +1,40 @@
+" Only do this when not done yet for this buffer
+" Also do nothing if 'compatible' enabled
+if exists('b:did_ftplugin_sh_lint') || &compatible
+ finish
+let b:did_ftplugin_sh_lint = 1
+let b:undo_ftplugin = b:undo_ftplugin
+ \ . '|unlet b:did_ftplugin_sh_lint'
+" Choose linter based on shell family
+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 -'
+ let b:sh_lint = 'write !shellcheck -s sh -'
+let b:undo_ftplugin = b:undo_ftplugin
+ \ . '|unlet b:sh_lint'
+" Set up a mapping for the linter, if we're allowed
+if !exists('g:no_plugin_maps') && !exists('g:no_sh_maps')
+ " Define a mapping target
+ nnoremap <buffer> <silent> <unique>
+ \ <Plug>ShLint
+ \ :<C-U>execute b:sh_lint<CR>
+ let b:undo_ftplugin = b:undo_ftplugin
+ \ . '|nunmap <buffer> <Plug>ShLint'
+ " If there isn't a key mapping already, use a default one
+ if !hasmapto('<Plug>ShLint')
+ nmap <buffer> <unique>
+ \ <LocalLeader>l
+ \ <Plug>ShLint
+ let b:undo_ftplugin = b:undo_ftplugin
+ \ . '|nunmap <buffer> <LocalLeader>l'
+ endif