indentLine

https://github.com/yggdroot/indentline
Admin
indentLine is a Vim plugin that displays thin vertical lines at each indentation level for code...
Tokens:2,403
Snippets:40
Trust Score:8
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install indentLine via Vim native package management

Source: https://github.com/yggdroot/indentline/blob/master/README.md

Use these terminal commands to clone the repository into the native Vim package directory and generate help tags.

```bash
git clone https://github.com/Yggdroot/indentLine.git ~/.vim/pack/vendor/start/indentLine
vim -u NONE -c "helptags  ~/.vim/pack/vendor/start/indentLine/doc" -c "q"
```

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

### Configure GUI Colors

Source: https://github.com/yggdroot/indentline/blob/master/doc/indentLine.txt

Set the GUI color and background color for the indentation lines using hex codes.

```vim
let g:indentLine_color_gui = '#A4E57E'
```

```vim
let g:indentLine_bgcolor_gui = '#FF5F00'
```

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

### Configure File Type Inclusion

Source: https://github.com/yggdroot/indentline/blob/master/doc/indentLine.txt

Specify a list of file types where the plugin is enabled by default.

```vim
let g:indentLine_fileType = ['c', 'cpp']
```

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

### Configuration Variables

Source: https://github.com/yggdroot/indentline/blob/master/doc/indentLine.txt

Global variables used to configure the behavior of the indentLine plugin.

```APIDOC
## Configuration Variables

- **g:indentLine_fileType** (List) - Specifies file types where the plugin is enabled by default.
- **g:indentLine_fileTypeExclude** (List) - Specifies file types where the plugin is disabled by default.
- **g:indentLine_bufTypeExclude** (List) - Specifies buffer types where the plugin is disabled by default.
- **g:indentLine_bufNameExclude** (List) - Specifies buffer names (regex) where the plugin will not display.
- **g:indentLine_maxLines** (Number) - Threshold for buffer lines to switch to a more performant pattern.
- **g:indentLine_faster** (Number) - Set to 1 to improve performance (default 0).
- **g:indentLine_setConceal** (Number) - Set to 0 to prevent overwriting 'concealcursor' and 'conceallevel' (default 1).
- **g:indentLine_concealcursor** (String) - Toggles cursor lines behavior (default 'inc').
- **g:indentLine_conceallevel** (String) - Toggles the concealing behavior (default '2').
- **g:indentLine_leadingSpaceChar** (String) - Character used to show leading spaces.
- **g:indentLine_leadingSpaceEnabled** (Number) - Whether to show leading spaces by default (default 0).
- **g:indentLine_defaultGroup** (String) - Highlight group for default color values.
- **g:indentLine_autoResetWidth** (Number) - Whether to auto redraw after 'shiftwidth' or 'tabstop' change (default 1).
```

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

### Commands

Source: https://github.com/yggdroot/indentline/blob/master/doc/indentLine.txt

Commands available to control the indentLine plugin functionality in the current buffer.

```APIDOC
## Commands

### IndentLinesReset [number]
Redraws the indent lines. If the optional `number` is provided, it sets the width between two indent levels; otherwise, it uses the current 'shiftwidth' value.

### IndentLinesToggle
Toggles the display of indent lines for the current buffer.

### IndentLinesEnable
Enables the display of indent lines for the current buffer.

### IndentLinesDisable
Disables the display of indent lines for the current buffer.

### LeadingSpaceEnable
Enables the display of leading spaces for the current buffer.

### LeadingSpaceDisable
Disables the display of leading spaces for the current buffer.

### LeadingSpaceToggle
Toggles the display of leading spaces for the current buffer.
```

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

### Configure File Type Exclusion

Source: https://github.com/yggdroot/indentline/blob/master/doc/indentLine.txt

Specify a list of file types where the plugin is disabled by default.

```vim
let g:indentLine_fileTypeExclude = ['text', 'sh']
```

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

### Configure Indent Line Characters

Source: https://github.com/yggdroot/indentline/blob/master/doc/indentLine.txt

Set a list of characters to cycle through for different indentation levels.

```vim
let g:indentLine_char_list = ['|', '¦', '┆', '┊']
```

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

### Configure TTY Colors

Source: https://github.com/yggdroot/indentline/blob/master/doc/indentLine.txt

Set the indentation line color for non-X terminals based on background brightness.

```vim
let g:indentLine_color_tty_light = 7
```

```vim
let g:indentLine_color_tty_dark = 1
```

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

### Set default highlight group

Source: https://github.com/yggdroot/indentline/blob/master/README.md

Uses an existing highlight group, such as 'SpecialKey', for indent line colors.

```vim
let g:indentLine_defaultGroup = 'SpecialKey'
```

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

### Configure Terminal Colors

Source: https://github.com/yggdroot/indentline/blob/master/doc/indentLine.txt

Set the terminal color and background color for the indentation lines.

```vim
let g:indentLine_color_term = 239
```

```vim
let g:indentLine_bgcolor_term = 202
```

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

### Disable indentLine by default

Source: https://github.com/yggdroot/indentline/blob/master/README.md

Prevents the plugin from enabling automatically on startup.

```vim
let g:indentLine_enabled = 0
```

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

### Configure Buffer Name Exclusion

Source: https://github.com/yggdroot/indentline/blob/master/doc/indentLine.txt

Specify a list of buffer names or regular expressions to exclude from display.

```vim
let g:indentLine_bufNameExclude = ['_.*', 'NERD_tree.*']
```

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

### Configure conceal behavior

Source: https://github.com/yggdroot/indentline/blob/master/README.md

Sets the default conceal cursor and level. The plugin requires a conceal level of 1 or 2 to function.

```vim
let g:indentLine_concealcursor = 'inc'
let g:indentLine_conceallevel = 2
```

```vim
let g:indentLine_setConceal = 0
```

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

### Configure Buffer Type Exclusion

Source: https://github.com/yggdroot/indentline/blob/master/doc/indentLine.txt

Specify a list of buffer types where the plugin is disabled by default.

```vim
let g:indentLine_bufTypeExclude = ['help', 'terminal']
```

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

### Customize conceal colors

Source: https://github.com/yggdroot/indentline/blob/master/README.md

Defines specific color values for terminal, GUI, and background settings.

```vim
" Vim
let g:indentLine_color_term = 239

" GVim
let g:indentLine_color_gui = '#A4E57E'

" none X terminal
let g:indentLine_color_tty_light = 7 " (default: 4)
let g:indentLine_color_dark = 1 " (default: 2)

" Background (Vim, GVim)
let g:indentLine_bgcolor_term = 202
let g:indentLine_bgcolor_gui = '#FF5F00'
```

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

### Configure Leading Space Character

Source: https://github.com/yggdroot/indentline/blob/master/doc/indentLine.txt

Define the character used to represent leading spaces.

```vim
let g:indentLine_leadingSpaceChar = '·'
```

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

### Configure Indent Line Character

Source: https://github.com/yggdroot/indentline/blob/master/doc/indentLine.txt

Set the character used for the indent line visual.

```vim
let g:indentLine_char = '┊'
```

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

### Change indent character

Source: https://github.com/yggdroot/indentline/blob/master/README.md

Sets the character used for indentation lines. UTF-8 characters require appropriate file encoding.

```vim
let g:indentLine_char = 'c'
```

```vim
let g:indentLine_char_list = ['|', '¦', '┆', '┊']
```

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

### Configure JSON syntax concealment

Source: https://github.com/yggdroot/indentline/blob/master/doc/indentLine.txt

Disables JSON quote concealment to ensure quotes remain visible in JSON files.

```vim
let g:vim_json_syntax_conceal = 0
```

```vim
:IndentLinesDisable
```

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

### Disable conceal for specific file types

Source: https://github.com/yggdroot/indentline/blob/master/README.md

Disables conceal features for JSON or Markdown files while keeping indentLine active.

```vim
let g:vim_json_conceal=0
```

```vim
let g:markdown_syntax_conceal=0
```

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

### Disable indentLine color overwriting

Source: https://github.com/yggdroot/indentline/blob/master/README.md

Prevents the plugin from overwriting the conceal color with grey, allowing the current colorscheme to take effect.

```vim
let g:indentLine_setColors = 0
```
Tokens:
Raw