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

Updating readme

Browse Source
This commit is contained in:
Alex Yatskov 2015-08-06 12:55:44 +09:00
parent 7fe27fa7ca
commit f2ad569b25
1 changed files with 21 additions and 122 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

143
README.md
View File

@ -2,34 +2,44 @@
ArgWrap 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.
All operations are easily reversible and correctly preserve the indentation of the surrounding code.
![](http://foosoft.net/projects/argwrap/img/demo.gif)
## Installation ## ## Installation ##
1. Clone or otherwise download the latest version of the ArgWrap extension from its 1. Clone or otherwise download ArgWrap extension from the [GitHub](https://github.com/FooSoft/vim-argwrap) page.
[GitHub](https://github.com/FooSoft/vim-argwrap) page. If you are using
[pathogen.vim](https://github.com/tpope/vim-pathogen) for plugin management you can clone the repository directly to If you are using [pathogen.vim](https://github.com/tpope/vim-pathogen) for plugin management you can clone the
your bundle directory: 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
``` ```
2. Create a keyboard binding for the `ArgWrap` command inside your `~/.vimrc` file. For example, to declare a normal 2. Create a keyboard binding for the `ArgWrap` command inside your `~/.vimrc` file.
mode mapping, add the following command:
For example, to declare a normal mode mapping, add the following command:
``` ```
nnoremap <silent> <leader>a :ArgWrap<CR> nnoremap <silent> <leader>a :ArgWrap<CR>
``` ```
## Usage ##
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).
2. Execute the keyboard binding you defined above to *toggle* the wrapping and unwrapping of arguments.
## Configuration ## ## Configuration ##
You can customize the wrapping/unwrapping behavior of this extension by setting values for any of the following optional You can customize the behavior of this extension by setting values for any of the following optional buffer and global
buffer and global variables in your `.vimrc` file: variables in your `.vimrc` file:
* `g:argwrap_wrap_closing_brace` or `b:argwrap_wrap_closing_brace` * `g:argwrap_wrap_closing_brace` or `b:argwrap_wrap_closing_brace`
Specifies if the closing brace should be wrapped to a new line. This setting is helpful when working with languages *Specifies if the closing brace should be wrapped to a new line.*
such as Google's [Go](https://golang.org/project/), which enforce coding style during compliation.
Brace wrapping enabled (default) Brace wrapping enabled (default)
@ -52,7 +62,7 @@ buffer and global variables in your `.vimrc` file:
* `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.*
`''`: do not add padding for any braces (empty string): `''`: do not add padding for any braces (empty string):
@ -73,114 +83,3 @@ buffer and global variables in your `.vimrc` file:
``` ```
let g:argwrap_padded_braces = '[{' let g:argwrap_padded_braces = '[{'
``` ```
## Usage ##
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).
2. Execute the keyboard binding you defined above to *toggle* the wrapping and unwrapping of arguments.
## Examples ##
Below are some examples of common use cases demonstrating the capabilities of ArgWrap. Note that the extension functions
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
to wrap them to improve code readability. If you position your cursor anywhere between the parenthesis and execute the
`ArgWrap` command, the argument list will be wrapped to one per line.
```
Foo(wibble, wobble, wubble)
```
Becomes this:
```
Foo(
wibble,
wobble,
wubble
)
```
List definitions work in a similar fashion:
```
foo = [bar, baz, qux, quux, corge]
```
Becomes this:
```
foo = [
bar,
baz,
qux,
quux,
corge
]
```
Dictionaries also work the way you expected them to:
```
foo = {bar: 1, baz: 3, qux: 3, quux: 7}
```
Becomes this:
```
foo = {
bar: 1,
baz: 3,
qux: 3,
quux: 7
}
```
Finally, nested combinations of all the above are also supported:
```
Foo([wibble, wobble, wubble], spam, {bar: baz, qux: [1, 3, 3, 7]})
```
Becomes this:
```
Foo(
[wibble, wobble, wubble],
spam,
{bar: baz, qux: [1, 3, 3, 7]}
)
```
You can continue argument expansion to:
```
Foo(
[
wibble,
wobble,
wubble
],
spam,
{
bar: baz,
qux: [
1,
3,
3,
7
]
}
)
```
The argument wrapping and unwrapping operations demonstrated above are easily reversible and correctly preserve the
indentation of the surrounding code. This extension has been tested to work in scenarios of various complexity, but if
you discover a problem don't hesitate to report it.