/vim-emoji

:smiley: Emoji in Vim

Primary LanguageVim Script

vim-emoji

Emoji in Vim. Emojis are only available on terminal Vim on Mac.

Extracted from vim-github-dashboard.

Installation

Use your favorite plugin manager.

  • Pathogen
    • git clone https://github.com/junegunn/vim-emoji.git ~/.vim/bundle/vim-emoji
  • Vundle
    1. Add Bundle 'junegunn/vim-emoji' to .vimrc
    2. Run :BundleInstall
  • NeoBundle
    1. Add NeoBundle 'junegunn/vim-emoji' to .vimrc
    2. Run :NeoBundleInstall
  • vim-plug
    1. Add Plug 'junegunn/vim-emoji' to .vimrc
    2. Run :PlugInstall

List of functions

  • emoji#available()
  • emoji#for(name[, default = '', pad = 1])
  • emoji#list()
  • emoji#complete(findstart, base)

Examples

Using Emojis as Git Gutter symbols

" In .vimrc
silent! if emoji#available()
  let g:gitgutter_sign_added = emoji#for('small_blue_diamond')
  let g:gitgutter_sign_modified = emoji#for('small_orange_diamond')
  let g:gitgutter_sign_removed = emoji#for('small_red_triangle')
  let g:gitgutter_sign_modified_removed = emoji#for('collision')
endif

Append Emoji list to current buffer

for e in emoji#list()
  call append(line('$'), printf('%s (%s)', emoji#for(e), e))
endfor

Emoji completion

set completefunc=emoji#complete

Replace :emoji_name: into Emojis

%s/:\([^:]\+\):/\=emoji#for(submatch(1), submatch(0))/g