Updating README
This commit is contained in:
parent
7c300e80f7
commit
9f937dec9c
104
README.md
104
README.md
@ -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.
|
||||
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/)
|
||||
* [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 ##
|
||||
|
||||
## Installation
|
||||
|
||||
1. Clone or otherwise download the latest version of the *argwrap.vim* extension from its
|
||||
[GitHub](https://github.com/FooSoft/vim-argwrap) page (the script is also available for download through
|
||||
[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:
|
||||
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
|
||||
[pathogen.vim](https://github.com/tpope/vim-pathogen) for plugin management you can clone the repository directly to
|
||||
your bundle directory:
|
||||
|
||||
```
|
||||
$ git clone https://github.com/FooSoft/vim-argwrap ~/.vim/bundle/vim-argwrap
|
||||
@ -29,68 +21,70 @@ information.
|
||||
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
|
||||
optional buffer and global variables in your `.vimrc` file:
|
||||
## Configuration ##
|
||||
|
||||
* `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
|
||||
languages such as Google's [Go](https://golang.org/project/), which enforce coding style during compliation.
|
||||
* `g:argwrap_wrap_closing_brace` or `b:argwrap_wrap_closing_brace`
|
||||
|
||||
Brace wrapping enabled (default)
|
||||
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.
|
||||
|
||||
```
|
||||
Foo(
|
||||
wibble,
|
||||
wobble,
|
||||
wubble
|
||||
)
|
||||
```
|
||||
Brace wrapping enabled (default)
|
||||
|
||||
Brace wrapping disabled (`let g:argwrap_wrap_closing_brace = 0`)
|
||||
```
|
||||
Foo(
|
||||
wibble,
|
||||
wobble,
|
||||
wubble
|
||||
)
|
||||
```
|
||||
|
||||
```
|
||||
Foo(
|
||||
wibble,
|
||||
wobble,
|
||||
wubble)
|
||||
```
|
||||
Brace wrapping disabled (`let g:argwrap_wrap_closing_brace = 0`)
|
||||
|
||||
* `g:argwrap_padded_braces` or `b:argwrap_wrap_closing_brace`
|
||||
```
|
||||
Foo(
|
||||
wibble,
|
||||
wobble,
|
||||
wubble)
|
||||
```
|
||||
|
||||
Specifies which brace types should be padded on the inside with spaces:
|
||||
* `g:argwrap_padded_braces` or `b:argwrap_wrap_closing_brace`
|
||||
|
||||
`''`: do not add padding for any braces (empty string):
|
||||
Specifies which brace types should be padded on the inside with spaces:
|
||||
|
||||
```
|
||||
[1, 2, 3]
|
||||
{1, 2, 3}
|
||||
```
|
||||
`''`: do not add padding for any braces (empty string):
|
||||
|
||||
`'['`: padding for square braces only (curly braces are not padded):
|
||||
```
|
||||
[1, 2, 3]
|
||||
{1, 2, 3}
|
||||
```
|
||||
|
||||
```
|
||||
[ 1, 2, 3 ]
|
||||
{1, 2, 3}
|
||||
```
|
||||
`'['`: padding for square braces only (curly braces are not padded):
|
||||
|
||||
Padding can be specified for multiple brace types as follows:
|
||||
```
|
||||
[ 1, 2, 3 ]
|
||||
{1, 2, 3}
|
||||
```
|
||||
|
||||
```
|
||||
let g:argwrap_padded_braces = '[{'
|
||||
```
|
||||
Padding can be specified for multiple brace types as follows:
|
||||
|
||||
## Usage
|
||||
```
|
||||
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
|
||||
## Examples ##
|
||||
|
||||
Below are some examples of common use cases demonstrating the capabilities of argwrap.vim. Note that the extension
|
||||
functions identically regardless if it is being applied to a function call, list or dictionary definition.
|
||||
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
|
||||
|
||||
Loading…
Reference in New Issue
Block a user