alex/vim-argwrap
1
Fork 0
Code Releases 1 Activity

Updating README

Browse Source
This commit is contained in:
Alex Yatskov 2015-07-09 17:11:53 +09:00
parent 7c300e80f7
commit 9f937dec9c
1 changed files with 49 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -1,22 +1,14 @@
# argwrap.vim # ArgWrap #
argwrap.vim is an industrial strength argument wrapping and unwrapping extension for the [Vim](http://www.vim.org/) text ArgWrap is an industrial strength argument wrapping and unwrapping extension for the [Vim](http://www.vim.org/) text
editor. It can be used for collapsing and expanding everything from function calls to array and dictionary definitions. editor. It can be used for collapsing and expanding everything from function calls to array and dictionary definitions.
The online resources listed below can be accessed to download new versions of this extension and to access other related
information.
* [GitHub](https://github.com/FooSoft/vim-argwrap/) ## Installation ##
* [Homepage](http://foosoft.net/projects/vim-argwrap/)
* [Vim Awesome](http://vimawesome.com/plugin/vim-argwrap)
* [Vim.org](http://www.vim.org/scripts/script.php?script_id=5062)
## Installation 1. Clone or otherwise download the latest version of the ArgWrap extension from its
[GitHub](https://github.com/FooSoft/vim-argwrap) page. If you are using
1. Clone or otherwise download the latest version of the *argwrap.vim* extension from its [pathogen.vim](https://github.com/tpope/vim-pathogen) for plugin management you can clone the repository directly to
[GitHub](https://github.com/FooSoft/vim-argwrap) page (the script is also available for download through your bundle directory:
[Vim.org](http://www.vim.org/scripts/script.php?script_id=5062)). If you are using
[pathogen.vim](https://github.com/tpope/vim-pathogen) for plugin management (you should) you can clone the
repository directly to your bundle directory:
``` ```
$ git clone https://github.com/FooSoft/vim-argwrap ~/.vim/bundle/vim-argwrap $ git clone https://github.com/FooSoft/vim-argwrap ~/.vim/bundle/vim-argwrap
@ -29,13 +21,15 @@ information.
nnoremap <silent> <leader>a :ArgWrap<CR> nnoremap <silent> <leader>a :ArgWrap<CR>
``` ```
3. You can customize the wrapping/unwrapping behavior of this extension by setting values for any of the following ## Configuration ##
optional buffer and global variables in your `.vimrc` file:
* `g:argwrap_wrap_closing_brace` or `b:argwrap_wrap_closing_brace` You can customize the wrapping/unwrapping behavior of this extension by setting values for any of the following optional
buffer and global variables in your `.vimrc` file:
Specifies if the closing brace should be wrapped to a new line. This setting is helpful when working with * `g:argwrap_wrap_closing_brace` or `b:argwrap_wrap_closing_brace`
languages such as Google's [Go](https://golang.org/project/), which enforce coding style during compliation.
Specifies if the closing brace should be wrapped to a new line. This setting is helpful when working with languages
such as Google's [Go](https://golang.org/project/), which enforce coding style during compliation.
Brace wrapping enabled (default) Brace wrapping enabled (default)
@ -56,7 +50,7 @@ information.
wubble) wubble)
``` ```
* `g:argwrap_padded_braces` or `b:argwrap_wrap_closing_brace` * `g:argwrap_padded_braces` or `b:argwrap_wrap_closing_brace`
Specifies which brace types should be padded on the inside with spaces: Specifies which brace types should be padded on the inside with spaces:
@ -80,17 +74,17 @@ information.
let g:argwrap_padded_braces = '[{' let g:argwrap_padded_braces = '[{'
``` ```
## Usage ## Usage ##
1. Position the cursor *inside* of the scope of the parenthesis, brackets or curly braces you wish to wrap/unwrap (not 1. Position the cursor *inside* of the scope of the parenthesis, brackets or curly braces you wish to wrap/unwrap (not
on top, before or after them). on top, before or after them).
2. Execute the keyboard binding you defined above to *toggle* the wrapping and unwrapping of arguments. 2. Execute the keyboard binding you defined above to *toggle* the wrapping and unwrapping of arguments.
## Examples ## Examples ##
Below are some examples of common use cases demonstrating the capabilities of argwrap.vim. Note that the extension Below are some examples of common use cases demonstrating the capabilities of ArgWrap. Note that the extension functions
functions identically regardless if it is being applied to a function call, list or dictionary definition. identically regardless if it is being applied to a function call, list or dictionary definition.
Let's begin with a simple function invocation. When there are many arguments being passed to the function, we often wish Let's begin with a simple function invocation. When there are many arguments being passed to the function, we often wish
to wrap them to improve code readability. If you position your cursor anywhere between the parenthesis and execute the to wrap them to improve code readability. If you position your cursor anywhere between the parenthesis and execute the