Project-Specific Templates with Projectionist Defining the following snippet for the sh file type would insert a shebang for you to start off every new shell script: The convention for naming skeleton snippets enforced in s:try_insert() is to use skel prefixed with an underscore. In that case, it is necessary to issue an :undo in order to clear the snippet name that was inserted on the first line. The expansion will of course fail if the snippet is not defined (if there is no skeleton defined for the current file type). UltiSnips sets the g:ulti_expand_res variable to the result of the expansion to indicate success or failure. The s:try_insert() function programmatically attempts to insert the snippet with the given name into the buffer. It then defers to a separate script-local function to do the actual work (but we’ll be extending this function in the next section). The snippet#InsertSkeleton() function checks that the buffer is empty and that a corresponding file does not already exist on disk. Let filename = expand ( '%' ) " Abort on non-empty buffer or extant file if !(line ( '$' ) = 1 & getline ( '$' ) = '' ) || filereadable (filename ) return endif call s:try_insert ( 'skel' ) endfunction "\=UltiSnips#ExpandSnippet()\" if g:ulti_expand_res = 0 silent ! undoĮndif return g:ulti_expand_res endfunction function ! snippet#InsertSkeleton () abort " autoload/snippet.vim function ! s:try_insert (skel )Įxecute "normal! i_". I’ve chosen to place it in a script that gets loaded after UltiSnips so that the functionality can be bypassed if UltiSnips is not available. Hence the first step is to create an autocommand. The autocommand event we are interested in is BufNewFile, which gets fired whenever a buffer is created referencing a file that does not yet exist on disk. UltiSnips is the de facto standard for snippet plug-ins as of this writing, and the one I currently use, so I devised a system where I could use UltiSnips snippets to define my templates. However, it always bothered me that I was using two separate mechanisms for file templates and regular snippets since there’s a lot of overlap. There are plenty of plug-ins out there that give you more control and flexibility.
Namely, the templates are not context-aware-you can’t include dynamic text or (easily) vary the template based on features of the file path. This method is very straightforward, but it has some limitations.
0 kommentar(er)
