https://github.com/ericbn/vim-relativize

This Vim plugin only shows relative line numbers when you need them.
https://github.com/ericbn/vim-relativize

vim vim-plugin

Last synced: about 1 year ago
JSON representation

This Vim plugin only shows relative line numbers when you need them.

• Host: GitHub
• URL: https://github.com/ericbn/vim-relativize
• Owner: ericbn
• Created: 2016-08-31T17:14:36.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2017-12-16T19:02:17.000Z (over 8 years ago)
• Last Synced: 2025-03-25T09:47:46.646Z (about 1 year ago)
• Topics: vim, vim-plugin
• Language: Vim script
• Homepage:
• Size: 6.84 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# relativize.vim

This plugin only shows relative line numbers when you need them: in the current

window, and if you're not in insert mode. Otherwise, it will give you the

absolute numbers. As suggested by [Jeff

Kreeftmeijer](http://jeffkreeftmeijer.com/2012/relative-line-numbers-in-vim-for-super-fast-movement/).

## Installation

- Using [pathogen.vim](https://github.com/tpope/vim-pathogen):

        cd ~/.vim/bundle

        git clone git://github.com/ericbn/vim-relativize.git

- Using [vim-plug](https://github.com/junegunn/vim-plug):

        Plug 'ericbn/vim-relativize'

## Configuration

Add one of the following to your `.vimrc` depending on the initial look you

want:

- Relative line numbers when you need them:

        set relativenumber

- Relative numbers when you need them, with the absolute line number in the

  current line (requires at least Vim 7.4):

        set number relativenumber

- Absolute line numbers all the time (toggle relative numbers when you need

  them with `:RelativizeToggle`):

        set number

- No numbers at all (use the map below to switch numbers from appearing, will

  first switch to absolute line numbers):

  (nothing)

You can toggle relative line numbers from appearing with `:RelativizeToggle`.

To map a key (e.g. F2) to this command, add the following to your

`.vimrc`:

    nnoremap   :RelativizeToggle

To map a key (e.g. F3) to switch the numbers from appearing or not

at all, add this to your `.vimrc`:

    nnoremap   :let [&number, &relativenumber] =

      \ [!&number && (g:relativize_with_number \|\| !g:relativize_enabled),

      \ !&relativenumber && g:relativize_enabled]

## Why another 'relativenumber' plugin?

This is a no-nonsense plugin with only 27 lines of code. I believe this is how

a plugin for such a simple feature should be. It is flexible, and plays well

with other plugins without the need for extra configuration options.

If you want a plugin that needs more configuration options, try

[numbertoggle](https://github.com/jeffkreeftmeijer/vim-numbertoggle),

[numbers.vim](https://github.com/myusuf3/numbers.vim),

[vim-relativity](https://github.com/kennykaye/vim-relativity),

[vim-autonumber](https://github.com/foriequal0/vim-autonumber),

[RelativeNumberCurrentWindow](https://github.com/vim-scripts/RelativeNumberCurrentWindow)

or [smartnumber.vim](https://github.com/mopp/smartnumber.vim).

To have relative line numbering only in operator-pending mode, try

[RelOps](https://github.com/vim-scripts/RelOps).

If you want an even simpler plugin, that will only switch between absolute and

relative line numbers on a mapped key or lead shortcut, try

[toggle-numbers.vim](https://github.com/fullybaked/toggle-numbers.vim) or

[vim-toggle-relative-line-numbers](https://github.com/gangleri/vim-toggle-relative-line-numbers).

## License

Copyright © Eric Nielsen. Distributed under the same terms as Vim itself.  See

`:help license`.