cfb6e3db14
It is too expensive to check if ale is installed or not when ale is not instaled . It is not that expensive when is is installed. So anyone useing ale can just add ale to sources option in their config.
387 lines
14 KiB
Plaintext
387 lines
14 KiB
Plaintext
*lualine.txt* blazing fast and easy to configure statusline
|
|
*lualine.nvim* *lualine*
|
|
__ __ __ ______ __ __ __ __ ______
|
|
/\ \ /\ \/\ \ /\ __ \ /\ \ /\ \ /\ "-.\ \ /\ ___\
|
|
\ \ \____ \ \ \_\ \ \ \ __ \ \ \ \____ \ \ \ \ \ \-. \ \ \ __\
|
|
\ \_____\ \ \_____\ \ \_\ \_\ \ \_____\ \ \_\ \ \_\\"\_\ \ \_____\
|
|
\/_____/ \/_____/ \/_/\/_/ \/_____/ \/_/ \/_/ \/_/ \/_____/
|
|
|
|
Author: hoob3rt (https://github.com/hoob3rt)
|
|
License: MIT License
|
|
Repository: https://github.com/hoob3rt/lualine.nvim
|
|
|
|
==============================================================================
|
|
CONTENTS *lualine-contents*
|
|
|
|
1. lualine.nvim..........................................|lualine-lualine.nvim|
|
|
1.1. Usage and customization..............|lualine-usage_and_customization|
|
|
1.1.1 Starting lualine.........................|lualine-starting_lualine|
|
|
1.1.2 Setting a theme.....................................|lualine-theme|
|
|
1.1.3 Separators.....................................|lualine-separators|
|
|
1.1.4 Changing components............................|lualine-components|
|
|
1.1.5 Custom components.......................|lualine-custom_components|
|
|
1.1.6 Component options.......................|lualine-component_options|
|
|
1.1.7 Tabline...........................................|lualine-tabline|
|
|
1.1.8 Extensions.....................................|lualine-extensions|
|
|
1.1.8 Disabling lualine.................................|lualine-disable|
|
|
|
|
==============================================================================
|
|
USAGE AND CUSTOMIZATION *lualine-usage_and_customization*
|
|
|
|
Lualine has sections as shown below.
|
|
>
|
|
+-------------------------------------------------+
|
|
| A | B | C X | Y | Z |
|
|
+-------------------------------------------------+
|
|
|
|
Each sections holds it's components e.g. current vim's mode.
|
|
|
|
Default config~
|
|
>
|
|
require'lualine'.setup {
|
|
options = {
|
|
icons_enabled = true,
|
|
theme = 'auto',
|
|
component_separators = {'', ''},
|
|
section_separators = {'', ''},
|
|
disabled_filetypes = {}
|
|
},
|
|
sections = {
|
|
lualine_a = {'mode'},
|
|
lualine_b = {'branch', 'diff',
|
|
{'diagnostics', sources={'nvim_lsp', 'coc'}}},
|
|
lualine_c = {'filename'},
|
|
lualine_x = {'encoding', 'fileformat', 'filetype'},
|
|
lualine_y = {'progress'},
|
|
lualine_z = {'location'}
|
|
},
|
|
inactive_sections = {
|
|
lualine_a = {},
|
|
lualine_b = {},
|
|
lualine_c = {'filename'},
|
|
lualine_x = {'location'},
|
|
lualine_y = {},
|
|
lualine_z = {}
|
|
},
|
|
tabline = {},
|
|
extensions = {}
|
|
}
|
|
|
|
If you want to get your current lualine config. you can
|
|
do so with >
|
|
require'lualine'.get_config()
|
|
|
|
<
|
|
------------------------------------------------------------------------------
|
|
STARTING LUALINE *lualine-starting_lualine* *lualine.setup()*
|
|
>
|
|
require('lualine').setup()
|
|
|
|
------------------------------------------------------------------------------
|
|
SETTING A THEME *lualine-theme*
|
|
>
|
|
options = {theme = 'gruvbox'}
|
|
|
|
Available themes are listed here:
|
|
https://github.com/hoob3rt/lualine.nvim/blob/master/THEMES.md
|
|
|
|
Customizing themes~
|
|
>
|
|
local custom_gruvbox = require'lualine.themes.gruvbox'
|
|
|
|
-- Change the background of lualine_c section for normal mode
|
|
custom_gruvbox.normal.c.bg = '#112233' -- rgb colors are supported
|
|
|
|
require'lualine'.setup{
|
|
options = { theme = custom_gruvbox },
|
|
...
|
|
}
|
|
<
|
|
Theme structure is available here:
|
|
https://github.com/hoob3rt/lualine.nvim/blob/master/CONTRIBUTING.md#adding-a-theme
|
|
|
|
------------------------------------------------------------------------------
|
|
SEPARATORS *lualine-separators*
|
|
|
|
Lualine defines two kinds of seperators:
|
|
* |section_separators| - separators between sections
|
|
* |components_separators| - separators between components in sections
|
|
>
|
|
options = {
|
|
section_separators = {'', ''},
|
|
component_separators = {'', ''}
|
|
}
|
|
|
|
Disabling separators~
|
|
>
|
|
options = {section_separators = '', component_separators = ''}
|
|
|
|
------------------------------------------------------------------------------
|
|
CHANGING COMPONENTS IN LUALINE SECTIONS *lualine-components*
|
|
|
|
`sections = {lualine_a = {'mode'}}`
|
|
|
|
Available components~
|
|
general~
|
|
* |branch| (git branch)
|
|
* |diagnostics| (diagnostics count from your preferred source)
|
|
* |encoding| (file encoding)
|
|
* |fileformat| (file format)
|
|
* |filename|
|
|
* |filetype|
|
|
* |hostname|
|
|
* |location| (location in file in line:column format)
|
|
* |mode| (vim mode)
|
|
* |progress| (%progress in file)
|
|
* |diff| (git diff status)
|
|
|
|
------------------------------------------------------------------------------
|
|
CUSTOM COMPONENTS *lualine-custom_components*
|
|
|
|
Lua functions as lualine component~
|
|
>
|
|
local function hello()
|
|
return [[hello world]]
|
|
end
|
|
sections = {lualine_a = {hello}}
|
|
<
|
|
Vim functions as lualine component~
|
|
>
|
|
sections = {lualine_a = {'FugitiveHead'}}
|
|
<
|
|
Vim's statusline items as lualine component~
|
|
>
|
|
sections = {lualine_c = {'%=', '%t%m', '%3p'}}
|
|
<
|
|
|
|
Vim variables as lualine component~
|
|
|
|
Variables from `g:`, `v:`, `t:`, `w:`, `b:`, `o`, `go:`, `vo:`, `to:`, `wo:`, `bo:` scopes can be used.
|
|
See `:h lua-vim-variables` and `:h lua-vim-options` if you are not sure what to use.
|
|
>
|
|
sections = {lualine_a = {'g:coc_status', 'bo:filetype'}}
|
|
<
|
|
Lua expressions as lualine component~
|
|
|
|
You can use any valid lua expression as a component including
|
|
* oneliners
|
|
* global variables
|
|
* require statements
|
|
>
|
|
sections = {lualine_c = {"os.data('%a')", 'data', require'lsp-status'.status}}
|
|
|
|
`data` is a global variable in this example.
|
|
|
|
------------------------------------------------------------------------------
|
|
COMPONENT OPTIONS *lualine-component_options*
|
|
|
|
Component options can change the way a component behave.
|
|
There are two kinds of options:
|
|
* global options affecting all components
|
|
* local options affecting specific
|
|
|
|
Global options can be used as local options (can be applied to specific components)
|
|
but you cannot use local options as global.
|
|
Global option used locally overwrites the global, for example:
|
|
>
|
|
require'lualine'.setup {
|
|
options = {lower = true},
|
|
sections = {lualine_a = {{'mode', lower = false}}, lualine_b = {'branch'}}
|
|
}
|
|
|
|
`mode` will be displayed with `lower = false` and `branch` will be displayed with `lower = true`
|
|
|
|
Available options:~
|
|
|
|
Global options~
|
|
---------------
|
|
>
|
|
options = {
|
|
icons_enabled = 1, -- displays icons in alongside component
|
|
padding = 1, -- adds padding to the left and right of components
|
|
left_padding = 1, -- adds padding to the left of components
|
|
right_padding =1, -- adds padding to the right of components
|
|
upper = false, -- displays components in uppercase
|
|
lower = false, -- displays components in lowercase
|
|
format = nil -- format function, formats component's output
|
|
}
|
|
|
|
Local options~
|
|
---------------
|
|
>
|
|
sections = {
|
|
lualine_a = {
|
|
{
|
|
'mode',
|
|
icon = nil, -- displays icon in front of the component
|
|
separator = nil, -- Determines what separator to use for the component.
|
|
-- when a string is given it's treated as component_separator.
|
|
-- When a table is given it's treated as section_separator.
|
|
-- This options can be used to set colored separators
|
|
-- arround component. Option need to be set like `separator = {'', ''}`.
|
|
-- Where first element is left_separator and 2nd element is right separator.
|
|
-- Passing empty string disables that separator
|
|
condition = nil, -- condition function, component is loaded when function returns true
|
|
-- custom color for component in format
|
|
-- color = {fg = '#rrggbb', bg= '#rrggbb', gui='style'}
|
|
-- or highlight group
|
|
-- color = "WarningMsg"
|
|
color = nil,
|
|
-- Type option specifies what type a component is.
|
|
-- When type is omitted lualine will guess it.
|
|
-- Available types [format: type_name(example)]
|
|
-- mod(branch/filename), stl(%f/%m), var(g:coc_status/bo:modifiable),
|
|
-- luae(lua expressions), vimf(viml function name)
|
|
-- luae is short for lua-expression and vimf is short fror vim-function
|
|
-- vim_function(viml function name)
|
|
type = nil,
|
|
}
|
|
}
|
|
}
|
|
|
|
Component specific local options~
|
|
---------------
|
|
|
|
* diagnostics~
|
|
>
|
|
sections = {
|
|
lualine_a = {
|
|
{
|
|
'diagnostics',
|
|
-- table of diagnostic sources, available sources:
|
|
-- 'nvim_lsp', 'coc', 'ale', 'vim_lsp'
|
|
-- Or a function that returns a table like
|
|
-- {error=error_cnt, warning=warn_cnt, info=info_cnt, hint=hint_cnt}
|
|
sources = {},
|
|
-- displays diagnostics from defined severity
|
|
sections = {'error', 'warn', 'info', 'hint'},
|
|
-- all colors are in format #rrggbb
|
|
color_error = nil, -- changes diagnostic's error foreground color
|
|
color_warn = nil, -- changes diagnostic's warn foreground color
|
|
color_info = nil, -- Changes diagnostic's info foreground color
|
|
color_hint = nil, -- Changes diagnostic's hint foreground color
|
|
symbols = {error = 'E', warn = 'W', info = 'I', hint = 'H'}
|
|
update_in_insert = false, -- Update diagnostics in insert mode
|
|
}
|
|
}
|
|
}
|
|
|
|
* filename~
|
|
>
|
|
sections = {
|
|
lualine_a = {
|
|
{
|
|
'filename',
|
|
file_status = true, -- displays file status (readonly status, modified status)
|
|
path = 0 -- 0 = just filename, 1 = relative path, 2 = absolute path
|
|
shorting_target = 40 -- Shortens path to leave 40 space in the window
|
|
-- for other components. Terrible name any suggestions?
|
|
}
|
|
}
|
|
}
|
|
|
|
* filetype~
|
|
>
|
|
sections = {
|
|
lualine_a = {
|
|
{
|
|
'filetype',
|
|
colored = true, -- displays filetype icon in color if set to `true`
|
|
disable_text = false -- Display only icon for filetype
|
|
}
|
|
}
|
|
}
|
|
<
|
|
|
|
* diff~
|
|
>
|
|
sections = {
|
|
lualine_a = {
|
|
{
|
|
'diff',
|
|
colored = true, -- displays diff status in color if set to true
|
|
-- all colors are in format #rrggbb
|
|
color_added = nil, -- changes diff's added foreground color
|
|
color_modified = nil, -- changes diff's modified foreground color
|
|
color_removed = nil, -- changes diff's removed foreground color
|
|
symbols = {added = '+', modified = '~', removed = '-'} -- changes diff symbols
|
|
source = nil, -- A function that works as a data source for diff.
|
|
-- it must return a table like
|
|
{added = add_count, modified = modified_count, removed = removed_count }
|
|
-- Or nil on failure. Count <= 0 won't be displayed.
|
|
}
|
|
}
|
|
}
|
|
|
|
------------------------------------------------------------------------------
|
|
TABLINE *lualine-tabline*
|
|
|
|
You can use lualine to display components in tabline.
|
|
The configuration for tabline sections is exactly the same as for statusline.
|
|
>
|
|
tabline = {
|
|
lualine_a = {},
|
|
lualine_b = {'branch'},
|
|
lualine_c = {'filename'},
|
|
lualine_x = {},
|
|
lualine_y = {},
|
|
lualine_z = {},
|
|
}
|
|
<
|
|
This will show branch and filename component on top of neovim inside tabline.
|
|
|
|
You can also completely move your statuline to tabline by configuring
|
|
|lualine.tabline| and disabling |lualine.sections| and |lualine.inactive_sections|.
|
|
>
|
|
tabline = {
|
|
......
|
|
}
|
|
sections = {}
|
|
inactive_sections = {}
|
|
|
|
If you're looking for bufferline or want to show tabs in tabline . There are
|
|
manny awesome plugins that can do that. For example:
|
|
|
|
* [nvim-bufferline](https://github.com/akinsho/nvim-bufferline.lua)
|
|
* [tabline.nvim](https://github.com/kdheepak/tabline.nvim)
|
|
|
|
tabline.nvim even uses lualines theme by default 🙌
|
|
You can find a bigger list [here](https://github.com/rockerBOO/awesome-neovim#tabline)
|
|
|
|
------------------------------------------------------------------------------
|
|
EXTENSIONS *lualine-extensions*
|
|
|
|
Lualine extensions change statusline appearance for a window/buffer with
|
|
specified filetypes.
|
|
|
|
By default no extension are loaded to improve performance.
|
|
You can load extensions with:
|
|
>
|
|
extensions = {'quickfix'}
|
|
<
|
|
Available extensions~
|
|
* |chadtree|
|
|
* |fugitive|
|
|
* |fzf|
|
|
* |nerdtree|
|
|
* |nvim-tree|
|
|
* |quickfix|
|
|
*
|
|
|
|
Custom extensions~
|
|
|
|
You can define your own extensions.
|
|
If you think an extension might be useful for others then please submit a pr.
|
|
>
|
|
local my_extension = {sections = {lualine_a = 'mode'}, filetypes = {'lua'}}
|
|
require'lualine'.setup {extensions = {my_extension}}
|
|
|
|
------------------------------------------------------------------------------
|
|
DISABLING LUALINE *lualine-disable*
|
|
|
|
You can disable lualine for specific filetypes
|
|
|
|
`options = {disabled_filetypes = {'lua'}}`
|
|
------------------------------------------------------------------------------
|
|
vim:tw=80:sw=4:ts=8:et:ft=help:norl:et:
|