372 lines
18 KiB
Markdown
372 lines
18 KiB
Markdown
|
# vim-airline
|
||
|
|
|
||
|
|
[](https://saythanks.io/to/cb%40256bit.org)
|
||
|
|
[](https://github.com/vim-airline/vim-airline/actions?query=workflow%3Areviewdog+event%3Apush+branch%3Amaster)
|
||
|
|
[](https://github.com/vim-airline/vim-airline/actions?query=workflow%3ACI)
|
||
|
|
|
||
|
|
Lean & mean status/tabline for vim that's light as air.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
When the plugin is correctly loaded, there will be a nice statusline at the
|
||
|
|
bottom of each vim window.
|
||
|
|
|
||
|
|
That line consists of several sections, each one displaying some piece of
|
||
|
|
information. By default (without configuration) this line will look like this:
|
||
|
|
|
||
|
|
```
|
||
|
|
+-----------------------------------------------------------------------------+
|
||
|
|
|~ |
|
||
|
|
|~ |
|
||
|
|
|~ VIM - Vi IMproved |
|
||
|
|
|~ |
|
||
|
|
|~ version 8.2 |
|
||
|
|
|~ by Bram Moolenaar et al. |
|
||
|
|
|~ Vim is open source and freely distributable |
|
||
|
|
|~ |
|
||
|
|
|~ type :h :q<Enter> to exit |
|
||
|
|
|~ type :help<Enter> or <F1> for on-line help |
|
||
|
|
|~ type :help version8<Enter> for version info |
|
||
|
|
|~ |
|
||
|
|
|~ |
|
||
|
|
+-----------------------------------------------------------------------------+
|
||
|
|
| A | B | C X | Y | Z | [...] |
|
||
|
|
+-----------------------------------------------------------------------------+
|
||
|
|
```
|
||
|
|
|
||
|
|
The statusline is the colored line at the bottom, which contains the sections
|
||
|
|
(possibly in different colors):
|
||
|
|
|
||
|
|
section|meaning (example)
|
||
|
|
-------|------------------
|
||
|
|
A | displays the mode + additional flags like crypt/spell/paste (INSERT)
|
||
|
|
B | Environment status (VCS information - branch, hunk summary (master), [battery][61] level)
|
||
|
|
C | filename + read-only flag (~/.vim/vimrc RO)
|
||
|
|
X | filetype (vim)
|
||
|
|
Y | file encoding[fileformat] (utf-8[unix])
|
||
|
|
Z | current position in the file
|
||
|
|
[...] | additional sections (warning/errors/statistics) from external plugins (e.g. YCM, syntastic, ...)
|
||
|
|
|
||
|
|
The information in Section Z looks like this:
|
||
|
|
|
||
|
|
`10% ☰ 10/100 ln : 20`
|
||
|
|
|
||
|
|
This means:
|
||
|
|
```
|
||
|
|
10% - 10 percent down the top of the file
|
||
|
|
☰ 10 - current line 10
|
||
|
|
/100 ln - of 100 lines
|
||
|
|
: 20 - current column 20
|
||
|
|
```
|
||
|
|
|
||
|
|
For a better look, those sections can be colored differently, depending on various conditions
|
||
|
|
(e.g. the mode or whether the current file is 'modified')
|
||
|
|
|
||
|
|
# Features
|
||
|
|
|
||
|
|
* Tiny core written with extensibility in mind ([open/closed principle][8]).
|
||
|
|
* Integrates with a variety of plugins, including: [vim-bufferline][6],
|
||
|
|
[fugitive][4], [flog][62], [unite][9], [ctrlp][10], [minibufexpl][15], [gundo][16],
|
||
|
|
[undotree][17], [nerdtree][18], [tagbar][19], [vim-gitgutter][29],
|
||
|
|
[vim-signify][30], [quickfixsigns][39], [syntastic][5], [eclim][34],
|
||
|
|
[lawrencium][21], [virtualenv][31], [tmuxline][35], [taboo.vim][37],
|
||
|
|
[ctrlspace][38], [vim-bufmru][47], [vimagit][50], [denite][51],
|
||
|
|
[vim.battery][61] and more.
|
||
|
|
* Looks good with regular fonts and provides configuration points so you can use unicode or powerline symbols.
|
||
|
|
* Optimized for speed - loads in under a millisecond.
|
||
|
|
* Extensive suite of themes for popular color schemes including [solarized][23] (dark and light), [tomorrow][24] (all variants), [base16][32] (all variants), [molokai][25], [jellybeans][26] and others.
|
||
|
|
Note these are now external to this plugin. More details can be found in the [themes repository][46].
|
||
|
|
* Supports 7.2 as the minimum Vim version.
|
||
|
|
* The master branch tries to be as stable as possible, and new features are merged in only after they have gone through a [full regression test][33].
|
||
|
|
* Unit testing suite.
|
||
|
|
|
||
|
|
## Straightforward customization
|
||
|
|
|
||
|
|
If you don't like the defaults, you can replace all sections with standard `statusline` syntax. Give your statusline that you've built over the years a face lift.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Themes
|
||
|
|
|
||
|
|
Themes have moved to
|
||
|
|
another repository as of [this commit][45].
|
||
|
|
|
||
|
|
Install the themes as you would this plugin (Vundle example):
|
||
|
|
|
||
|
|
```vim
|
||
|
|
Plugin 'vim-airline/vim-airline'
|
||
|
|
Plugin 'vim-airline/vim-airline-themes'
|
||
|
|
```
|
||
|
|
|
||
|
|
See [vim-airline-themes][46] for more.
|
||
|
|
|
||
|
|
## Automatic truncation
|
||
|
|
|
||
|
|
Sections and parts within sections can be configured to automatically hide when the window size shrinks.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Smarter tab line
|
||
|
|
|
||
|
|
Automatically displays all buffers when there's only one tab open.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
This is disabled by default; add the following to your vimrc to enable the extension:
|
||
|
|
|
||
|
|
let g:airline#extensions#tabline#enabled = 1
|
||
|
|
|
||
|
|
Separators can be configured independently for the tabline, so here is how you can define "straight" tabs:
|
||
|
|
|
||
|
|
let g:airline#extensions#tabline#left_sep = ' '
|
||
|
|
let g:airline#extensions#tabline#left_alt_sep = '|'
|
||
|
|
|
||
|
|
In addition, you can also choose which path formatter airline uses. This affects how file paths are
|
||
|
|
displayed in each individual tab as well as the current buffer indicator in the upper right.
|
||
|
|
To do so, set the `formatter` field with:
|
||
|
|
|
||
|
|
let g:airline#extensions#tabline#formatter = 'default'
|
||
|
|
|
||
|
|
Here is a complete list of formatters with screenshots:
|
||
|
|
|
||
|
|
#### `default`
|
||
|
|
|
||
|
|
|
||
|
|
#### `jsformatter`
|
||
|
|
|
||
|
|
|
||
|
|
#### `unique_tail`
|
||
|
|
|
||
|
|
|
||
|
|
#### `unique_tail_improved`
|
||
|
|
|
||
|
|
|
||
|
|
## Seamless integration
|
||
|
|
|
||
|
|
vim-airline integrates with a variety of plugins out of the box. These extensions will be lazily loaded if and only if you have the other plugins installed (and of course you can turn them off).
|
||
|
|
|
||
|
|
#### [ctrlp.vim][10]
|
||
|
|
|
||
|
|
|
||
|
|
#### [unite.vim][9]
|
||
|
|
|
||
|
|
|
||
|
|
#### [denite.nvim][51]
|
||
|
|
|
||
|
|
|
||
|
|
#### [tagbar][19]
|
||
|
|
|
||
|
|
|
||
|
|
#### [csv.vim][28]
|
||
|
|
|
||
|
|
|
||
|
|
#### [syntastic][5]
|
||
|
|
|
||
|
|
|
||
|
|
#### hunks ([vim-gitgutter][29] & [vim-signify][30] & [coc-git][59])
|
||
|
|
|
||
|
|
|
||
|
|
#### [vimagit][50]
|
||
|
|
|
||
|
|
|
||
|
|
#### [flog][62]
|
||
|
|
|
||
|
|
|
||
|
|
#### [virtualenv][31]
|
||
|
|
|
||
|
|
|
||
|
|
#### [tmuxline][35]
|
||
|
|
|
||
|
|
|
||
|
|
#### [promptline][36]
|
||
|
|
|
||
|
|
|
||
|
|
#### [ctrlspace][38]
|
||
|
|
|
||
|
|
|
||
|
|
#### [xkb-switch][48]/[xkb-layout][49]
|
||
|
|
|
||
|
|
|
||
|
|
#### [vimtex][53]
|
||
|
|
|
||
|
|
|
||
|
|
#### [localsearch][54]
|
||
|
|
|
||
|
|
|
||
|
|
#### [LanguageClient][57]
|
||
|
|
|
||
|
|
|
||
|
|
#### [Vim-CMake][60]
|
||
|
|
|
||
|
|
|
||
|
|
#### [vim.battery][61]
|
||
|
|
|
||
|
|
|
||
|
|
## Extras
|
||
|
|
|
||
|
|
vim-airline also supplies some supplementary stand-alone extensions. In addition to the tabline extension mentioned earlier, there is also:
|
||
|
|
|
||
|
|
#### whitespace
|
||
|
|
|
||
|
|
|
||
|
|
### statusline on top
|
||
|
|
The statusline can alternatively be drawn on top, making room for other plugins to use the statusline:
|
||
|
|
The example shows a custom statusline setting, that imitates Vims default statusline, while allowing
|
||
|
|
to call custom functions. Use `:let g:airline_statusline_ontop=1` to enable it.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Configurable and extensible
|
||
|
|
|
||
|
|
#### Fine-tuned configuration
|
||
|
|
|
||
|
|
Every section is composed of parts, and you can reorder and reconfigure them at will.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
Sections can contain accents, which allows for very granular control of visuals (see configuration [here](https://github.com/vim-airline/vim-airline/issues/299#issuecomment-25772886)).
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
#### Extensible pipeline
|
||
|
|
|
||
|
|
Completely transform the statusline to your liking. Build out the statusline as you see fit by extracting colors from the current colorscheme's highlight groups.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
# Rationale
|
||
|
|
|
||
|
|
There's already [powerline][2], why yet another statusline?
|
||
|
|
|
||
|
|
* 100% vimscript; no python needed.
|
||
|
|
|
||
|
|
What about [vim-powerline][1]?
|
||
|
|
|
||
|
|
* vim-powerline has been deprecated in favor of the newer, unifying powerline, which is under active development; the new version is written in python at the core and exposes various bindings such that it can style statuslines not only in vim, but also tmux, bash, zsh, and others.
|
||
|
|
|
||
|
|
# Where did the name come from?
|
||
|
|
|
||
|
|
I wrote the initial version on an airplane, and since it's light as air it turned out to be a good name. Thanks for flying vim!
|
||
|
|
|
||
|
|
# Installation
|
||
|
|
|
||
|
|
This plugin follows the standard runtime path structure, and as such it can be installed with a variety of plugin managers:
|
||
|
|
|
||
|
|
| Plugin Manager | Install with... |
|
||
|
|
| ------------- | ------------- |
|
||
|
|
| [Pathogen][11] | `git clone https://github.com/vim-airline/vim-airline ~/.vim/bundle/vim-airline`<br/>Remember to run `:Helptags` to generate help tags |
|
||
|
|
| [NeoBundle][12] | `NeoBundle 'vim-airline/vim-airline'` |
|
||
|
|
| [Vundle][13] | `Plugin 'vim-airline/vim-airline'` |
|
||
|
|
| [Plug][40] | `Plug 'vim-airline/vim-airline'` |
|
||
|
|
| [VAM][22] | `call vam#ActivateAddons([ 'vim-airline' ])` |
|
||
|
|
| [Dein][52] | `call dein#add('vim-airline/vim-airline')` |
|
||
|
|
| [minpac][55] | `call minpac#add('vim-airline/vim-airline')` |
|
||
|
|
| pack feature (native Vim 8 package feature)| `git clone https://github.com/vim-airline/vim-airline ~/.vim/pack/dist/start/vim-airline`<br/>Remember to run `:helptags ~/.vim/pack/dist/start/vim-airline/doc` to generate help tags |
|
||
|
|
| manual | copy all of the files into your `~/.vim` directory |
|
||
|
|
|
||
|
|
# Documentation
|
||
|
|
|
||
|
|
`:help airline`
|
||
|
|
|
||
|
|
# Integrating with powerline fonts
|
||
|
|
|
||
|
|
For the nice looking powerline symbols to appear, you will need to install a patched font. Instructions can be found in the official powerline [documentation][20]. Prepatched fonts can be found in the [powerline-fonts][3] repository.
|
||
|
|
|
||
|
|
Finally, you can add the convenience variable `let g:airline_powerline_fonts = 1` to your vimrc which will automatically populate the `g:airline_symbols` dictionary with the powerline symbols.
|
||
|
|
|
||
|
|
# FAQ
|
||
|
|
|
||
|
|
Solutions to common problems can be found in the [Wiki][27].
|
||
|
|
|
||
|
|
# Performance
|
||
|
|
|
||
|
|
Whoa! Everything got slow all of a sudden...
|
||
|
|
|
||
|
|
vim-airline strives to make it easy to use out of the box, which means that by default it will look for all compatible plugins that you have installed and enable the relevant extension.
|
||
|
|
|
||
|
|
Many optimizations have been made such that the majority of users will not see any performance degradation, but it can still happen. For example, users who routinely open very large files may want to disable the `tagbar` extension, as it can be very expensive to scan for the name of the current function.
|
||
|
|
|
||
|
|
The [minivimrc][7] project has some helper mappings to troubleshoot performance related issues.
|
||
|
|
|
||
|
|
If you don't want all the bells and whistles enabled by default, you can define a value for `g:airline_extensions`. When this variable is defined, only the extensions listed will be loaded; an empty array would effectively disable all extensions (e.g. `:let g:airline_extensions = []`).
|
||
|
|
|
||
|
|
Also, you can enable caching of the various syntax highlighting groups. This will try to prevent some of the more expensive `:hi` calls in Vim, which seem to be expensive in the Vim core at the expense of possibly not being one hundred percent correct all the time (especially if you often change highlighting groups yourself using `:hi` commands). To set this up do `:let g:airline_highlighting_cache = 1`. A `:AirlineRefresh` will however clear the cache.
|
||
|
|
|
||
|
|
In addition you might want to check out the [dark_minimal theme][56], which does not change highlighting groups once they are defined. Also please check the [FAQ][27] for more information on how to diagnose and fix the problem.
|
||
|
|
|
||
|
|
# Screenshots
|
||
|
|
|
||
|
|
A full list of screenshots for various themes can be found in the [Wiki][14].
|
||
|
|
|
||
|
|
# Maintainers
|
||
|
|
|
||
|
|
The project is currently being maintained by [Christian Brabandt][42] and [Bailey Ling][41].
|
||
|
|
|
||
|
|
If you are interested in becoming a maintainer (we always welcome more maintainers), please [go here][43].
|
||
|
|
|
||
|
|
# License
|
||
|
|
|
||
|
|
[MIT License][58]. Copyright (c) 2013-2021 Bailey Ling & Contributors.
|
||
|
|
|
||
|
|
[1]: https://github.com/Lokaltog/vim-powerline
|
||
|
|
[2]: https://github.com/powerline/powerline
|
||
|
|
[3]: https://github.com/Lokaltog/powerline-fonts
|
||
|
|
[4]: https://github.com/tpope/vim-fugitive
|
||
|
|
[5]: https://github.com/scrooloose/syntastic
|
||
|
|
[6]: https://github.com/bling/vim-bufferline
|
||
|
|
[7]: https://github.com/bling/minivimrc
|
||
|
|
[8]: http://en.wikipedia.org/wiki/Open/closed_principle
|
||
|
|
[9]: https://github.com/Shougo/unite.vim
|
||
|
|
[10]: https://github.com/ctrlpvim/ctrlp.vim
|
||
|
|
[11]: https://github.com/tpope/vim-pathogen
|
||
|
|
[12]: https://github.com/Shougo/neobundle.vim
|
||
|
|
[13]: https://github.com/VundleVim/Vundle.vim
|
||
|
|
[14]: https://github.com/vim-airline/vim-airline/wiki/Screenshots
|
||
|
|
[15]: https://github.com/techlivezheng/vim-plugin-minibufexpl
|
||
|
|
[16]: https://github.com/sjl/gundo.vim
|
||
|
|
[17]: https://github.com/mbbill/undotree
|
||
|
|
[18]: https://github.com/preservim/nerdtree
|
||
|
|
[19]: https://github.com/majutsushi/tagbar
|
||
|
|
[20]: https://powerline.readthedocs.org/en/master/installation.html#patched-fonts
|
||
|
|
[21]: https://github.com/ludovicchabant/vim-lawrencium
|
||
|
|
[22]: https://github.com/MarcWeber/vim-addon-manager
|
||
|
|
[23]: https://github.com/altercation/solarized
|
||
|
|
[24]: https://github.com/chriskempson/tomorrow-theme
|
||
|
|
[25]: https://github.com/tomasr/molokai
|
||
|
|
[26]: https://github.com/nanotech/jellybeans.vim
|
||
|
|
[27]: https://github.com/vim-airline/vim-airline/wiki/FAQ
|
||
|
|
[28]: https://github.com/chrisbra/csv.vim
|
||
|
|
[29]: https://github.com/airblade/vim-gitgutter
|
||
|
|
[30]: https://github.com/mhinz/vim-signify
|
||
|
|
[31]: https://github.com/jmcantrell/vim-virtualenv
|
||
|
|
[32]: https://github.com/chriskempson/base16-vim
|
||
|
|
[33]: https://github.com/vim-airline/vim-airline/wiki/Test-Plan
|
||
|
|
[34]: http://eclim.org
|
||
|
|
[35]: https://github.com/edkolev/tmuxline.vim
|
||
|
|
[36]: https://github.com/edkolev/promptline.vim
|
||
|
|
[37]: https://github.com/gcmt/taboo.vim
|
||
|
|
[38]: https://github.com/vim-ctrlspace/vim-ctrlspace
|
||
|
|
[39]: https://github.com/tomtom/quickfixsigns_vim
|
||
|
|
[40]: https://github.com/junegunn/vim-plug
|
||
|
|
[41]: https://github.com/bling
|
||
|
|
[42]: https://github.com/chrisbra
|
||
|
|
[43]: https://github.com/vim-airline/vim-airline/wiki/Becoming-a-Maintainer
|
||
|
|
[45]: https://github.com/vim-airline/vim-airline/commit/d7fd8ca649e441b3865551a325b10504cdf0711b
|
||
|
|
[46]: https://github.com/vim-airline/vim-airline-themes#vim-airline-themes--
|
||
|
|
[47]: https://github.com/mildred/vim-bufmru
|
||
|
|
[48]: https://github.com/ierton/xkb-switch
|
||
|
|
[49]: https://github.com/vovkasm/input-source-switcher
|
||
|
|
[50]: https://github.com/jreybert/vimagit
|
||
|
|
[51]: https://github.com/Shougo/denite.nvim
|
||
|
|
[52]: https://github.com/Shougo/dein.vim
|
||
|
|
[53]: https://github.com/lervag/vimtex
|
||
|
|
[54]: https://github.com/mox-mox/vim-localsearch
|
||
|
|
[55]: https://github.com/k-takata/minpac/
|
||
|
|
[56]: https://github.com/vim-airline/vim-airline-themes/blob/master/autoload/airline/themes/dark_minimal.vim
|
||
|
|
[57]: https://github.com/autozimu/LanguageClient-neovim
|
||
|
|
[58]: https://github.com/vim-airline/vim-airline/blob/master/LICENSE
|
||
|
|
[59]: https://github.com/neoclide/coc-git
|
||
|
|
[60]: https://github.com/cdelledonne/vim-cmake
|
||
|
|
[61]: http://github.com/lambdalisue/battery.vim/
|
||
|
|
[62]: http://github.com/rbong/vim-flog/
|