From 1c447818359e957435e06d561f38f6f44b112d38 Mon Sep 17 00:00:00 2001 From: Shadman Date: Mon, 22 Feb 2021 09:56:20 +0600 Subject: [PATCH] docs: added diagnostics docs to lualine.txt(#111) --- doc/lualine.txt | 50 ++++++++++++++++++++++++++++++++++++------------- 1 file changed, 37 insertions(+), 13 deletions(-) diff --git a/doc/lualine.txt b/doc/lualine.txt index de47604..42ab87b 100644 --- a/doc/lualine.txt +++ b/doc/lualine.txt @@ -157,16 +157,17 @@ Lualine defaults~ Available components~ general~ - * branch - * encoding - * fileformat + * branch (git branch) + * diagnostics (diagnostics count from your prefered source) + * encoding (file encoding) + * fileformat (file format) * filename * filetype - * location - * mode - * progress + * location (location in file in line:column format) + * mode (vim mode) + * progress (%progress in file) plugin~ - * signify + * signify (signify status) -------------------------------------------------------------------------------- @@ -271,14 +272,38 @@ Component specific options~ These options are available for specific components only. List of options are given below. + + • diagnostics~ + • sources (nil) + displays diagnostic count from defined source. + array containing one or many string from set + {'nvim_lsp', 'coc', 'ale'} + + • sections ({'error', 'warn', 'info'}) + displays diagnostics of defined severity. + array containing one or many string from set + {'error', 'warn', 'info'} + + • color_error (DiffDelete foreground color) + changes diagnostic's error section foreground color. + color in #rrggbb format + + • color_warn (DiffText foreground color) + changes diagnostic's warn section foreground color + color in #rrggbb format + + • color_info (Normal foreground color) + changes diagnostic's info section foreground color + color in #rrggbb format + • filename~ - • file_status (true) + • file_status (true) Whether to display filemodified status in filename • shorten (true) Whether to display full/relative path with filename - • full_path (false) + • full_path (false) Whether to display full path when shorten is false • fileformat~ @@ -287,18 +312,17 @@ List of options are given below. are automaticaly extracted from colorscheme . If you want to change any of those you can use options given below. - • signify~ • colored (true) Whether to show colors - • color_added ('#90ee90') + • color_added (DiffAdd foreground color) Foreground color of added section - • color_modified ('#f0e130') + • color_modified (DiffChange foreground color) Foreground color of modified section - • color_removed ('#ff0038') + • color_removed (DiffDelete foreground color) Foreground color of removed section Example:~