Code Monkey home page Code Monkey logo

doorboy.vim's Introduction

doorboy.vim

Build Status

doorboy.vim is a smart plugin that serves you around brackets((){}[]) and quotations('`").

Screenshot

Installation

vim-plug

Add this to your .vimrc file.

Plug 'itmammoth/doorboy.vim'

Then, :PlugInstall

dein.vim

Add this to your .vimrc file.

call dein#add('itmammoth/doorboy.vim')

Then, :call dein#install()

Vundle

Plugin 'itmammoth/doorboy.vim'

... and many other plugin managers.

Features

Auto closing brackets with ( { [

(| represents the cursor position)

Type: (
Then: (|)
Auto closing quotation with " ' `
Type: "
Then: "|"

Auto closing brackets and quotations works properly in the cursor context.

Skipping close brackets and quotations
When: 'string|'
Type: '
Then: 'string'|
Pushing away brackets
When: {|}
Type: <Space>
Then: { | }
Enhanced backspace
When: { | }
Type: <BS>
Then: {|}
Type: <BS>
Then: |
Smart new line
When: {|}
Type: <CR>
Then: {
        |
      }

Configuration

key-mappings

doorboy.vim automatically provides some key-mappings to you.

Quotations
  • " ' `
  • | / on filetype ruby
  • / on filetype javascript and perl
Brackets
  • ( { [
  • ) } ]
Spaces
  • <BS>
  • <Space>
  • <CR>
NOTICE:

doorboy.vim NEVER overwrites the mapping with <BS>,<Space> and <CR> if these keys are already taken, so in such a case, you need to add the preferred mappings to your .vimrc file.

Available mapping functions are

  • doorboy#map_backspace
  • doorboy#map_space
  • doorboy#map_cr

For instance (to go with neocomplete + endwise)

" inoremap <expr> <CR> (pumvisible() ? "\<C-y>" : "" ) . "\<CR>"
inoremap <CR> <Plug>MyCR
inoremap <expr> <Plug>MyCR (pumvisible() ? "\<C-y>" : "" ) . doorboy#map_cr()

" inoremap <expr><BS> neocomplete#smart_close_popup()."\<BS>"
inoremap <expr><BS> neocomplete#smart_close_popup().doorboy#map_backspace()

g:doorboy_additional_quotations

In the doorboy definition, quotation means one character that opens a specific literal and closes it as well.

You can add quotations with letting g:doorboy_additional_quotations variable.

"
" g:doorboy_additional_quotations must be a dictionary,
" and which has filetypes as its keys and quotations as its values.
" (filetype '*' means any filetypes.)
"
let g:doorboy_additional_quotations = {
  \ '*': ['@'],
  \ 'coffee': ['/']
  \ }

If you find your customizing useful for all vimmers, please just send me a pull request. Thanks.

g:doorboy_nomap_quotations

You can keep some quotations from being mapped by doorboy with letting g:doorboy_nomap_quotations variable.

let g:doorboy_nomap_quotations = {
  \ 'javascript': ['/']
  \ }

g:doorboy_additional_brackets

You can add brackets with letting g:doorboy_additional_brackets variable.

let g:doorboy_additional_brackets = {
  \ 'html': ['<>']
  \ }

g:doorboy_nomap_brackets

You can keep some brackets from being mapped by doorboy with letting g:doorboy_nomap_brackets variable.

let g:doorboy_nomap_brackets = {
  \ 'vim': ['{}']
  \ }

Contribution

Fork it, then run the commands below for vim-flavored testing.

$ bundle install
$ git clone https://github.com/slim-template/vim-slim.git vim-slim
$ rake test

(The slim ftplugin in dooboy requires vim-slim, so you need to git-clone it in your workspace.)

blankslate.vimrc is an essential vim script file for manual testing.

$ vim -u blankslate.vimrc

Now you can try vim plugged in doorboy.vim

License

MIT License.

doorboy.vim's People

Contributors

itmammoth avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

doorboy.vim's Issues

Type | in regular expression

In Ruby syntax (# is the cursor)
When: /(.#)/
Type: |
Then: /(.|#|)/

Expected: /(.|#)/

| has special meaning in regular expressions.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.