https://github.com/tommcdo/vim-lion

A simple alignment operator for Vim text editor
https://github.com/tommcdo/vim-lion

Last synced: 3 days ago
JSON representation

A simple alignment operator for Vim text editor

• Host: GitHub
• URL: https://github.com/tommcdo/vim-lion
• Owner: tommcdo
• Created: 2013-03-16T16:47:24.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2022-06-09T08:33:15.000Z (over 2 years ago)
• Last Synced: 2024-08-02T05:13:22.989Z (3 months ago)
• Language: Vim script
• Size: 33.2 KB
• Stars: 494
• Watchers: 11
• Forks: 15
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
lion.vim

========

Lion.vim is a tool for aligning text by some character. It defines some

Vim operators that can be used with motion commands to align a targeted

block of text.

The two operators are `gl` and `gL`. `gl` will add spaces to the left of

the alignment character, and `gL` will add spaces to the right. Both

operators accept a count, a motion, and a single character. Without a

count, all occurrences of the character will be aligned.

For example, `glip=` will turn

```php

$i = 5;

$username = 'tommcdo';

$stuff = array(1, 2, 3);

```

into

```php

$i        = 5;

$username = 'tommcdo';

$stuff    = array(1, 2, 3);

```

Typing `3gLi(,` with the cursor somewhere inside `(` and `)` will turn

```php

$names = array(

    'bill', 'samantha', 'ray', 'ronald',

    'mo', 'harry', 'susan', 'ted',

    'timothy', 'bob', 'wolverine', 'cat',

    'lion', 'alfred', 'batman', 'linus',

);

```

into

```php

$names = array(

    'bill',    'samantha', 'ray',       'ronald',

    'mo',      'harry',    'susan',     'ted',

    'timothy', 'bob',      'wolverine', 'cat',

    'lion',    'alfred',   'batman',    'linus',

);

```

It is also possible to align text by a pattern. To enter a pattern, use `/` as

the alignment character (e.g. `glip/`) and then you will be prompted to input

the pattern. To align by `/`, simply leave the pattern empty (by pressing

`Enter`).

Installation

------------

If you don't have a preferred installation method, I recommend

installing [pathogen.vim](https://github.com/tpope/vim-pathogen), and

then simply copy and paste:

```sh

cd ~/.vim/bundle

git clone git://github.com/tommcdo/vim-lion.git

```

Once help tags have been generated, you can view the manual with

`:help lion`.

Options

-------

Option |                Description |                      Default

--- | --- | ---

`g:lion_create_maps`    | Whether to create mappings       | `1`

`b:lion_squeeze_spaces`
`g:lion_squeeze_spaces` | Squeeze extra spaces             | `0`

`g:lion_map_right`      | Mapping for right-align operator | `gl`

`g:lion_map_left`       | Mapping for left-align operator  | `gL`

If you set: `let b:lion_squeeze_spaces = 1`, and hit `glip=`, you will turn

```php

$i      = 5;

$user     = 'tommcdo';

$stuff  = array(1, 2, 3);

```

into:

```php

$i     = 5;

$user  = 'tommcdo';

$stuff = array(1, 2, 3);

```

instead of (`b:lion_squeeze_spaces = 0`):

```php

$i        = 5;

$user     = 'tommcdo';

$stuff    = array(1, 2, 3);

```