/vim-minisnip

Lightweight snippet manager

Primary LanguageVim ScriptMIT LicenseMIT

Note:

This repo has been forked twice (joereynolds and fcpg), see the Fork Notes below.

           _       _           _
 _ __ ___ (_)_ __ (_)___ _ __ (_)_ __
| '_ ` _ \| | '_ \| / __| '_ \| | '_ \
| | | | | | | | | | \__ \ | | | | |_) |
|_| |_| |_|_|_| |_|_|___/_| |_|_| .__/
                                |_|

Minisnip allows you to quickly insert "templates" into files. Among all the other snippet plugins out there, the primary goal of minisnip is to be as minimal and lightweight as possible.

There is a deoplete source available here

Installation

Use your favourite plugin manager to install minisnip:

Plug 'KeyboardFire/vim-minisnip'
cd ~/.vim/bundle
git clone git://github.com/KeyboardFire/vim-minisnip.git
NeoBundle 'KeyboardFire/vim-minisnip'

Usage

To get started with minisnip, create a directory called ~/.vim/minisnip. Then placing a file called foo inside of it will create the foo snippet, which you can access by typing foo<Tab> in insert mode.

Filetype-aware snippets are also available. For example, a file called _java_main will create a main snippet only when filetype=java, allowing you to add ex. a _c_main snippet and so on.

Here is a demo of the basic features of minisnip:

demo GIF 1

Here is another example that shows how arbitrary code can be executed from within a snippet, allowing dynamic snippets based on the file name or other conditions:

demo GIF 2

View the docs to learn the snippet syntax and options.

View the examples to see syntax examples.

Minisnip is licensed under MIT.

Fork notes:

  • Added some options (eg. g:minisnip_triggerornop, g:minisnip_nomaps)
  • Added some basic support for expansion from function context
  • Made a few minor fixes (search() opts, mark preserving, useless <script> etc.)
  • Refactored some code and reformatted

I already got a heavily customized <Tab> key, and I wanted to integrate minisnip into that framework. This essentially meant being able to expand from a function call, and avoiding inserting keys if minisnip does not trigger.

This (joereynolds) fork has the following (backwards compatible) fixes/improvements:

  • Indent snippets when inserted
  • Allow special characters as snippet names
  • Autoload the plugin
  • Installation instructions in README
  • Avoid multiple loads of the plugin

It does not break compatibility with the original vim-minisnip, only improves it.