Skip to content

Migrate to version 3

Lukas Reineke edited this page Oct 4, 2023 · 4 revisions

This wiki page provides some guidelines to migrate indent-blankline from version 2 to version 3. If you still have questions after reading, please feel free to open an issue.

Configuration variables

There are no more global configuration variables. All configuration is done through the setup function, and the main entry point for it has changed to ibl, see :help ibl.setup(). Buffer local settings can be done with :help ibl.setup_buffer().

If you are using lazy.nvim, add main = "ibl" to the plugin definition for the new entry point.

{ "lukas-reineke/indent-blankline.nvim", main = "ibl", opts = {} }

Some important variables:

  • g:indent_blankline_char and g:indent_blankline_char_list are now :help ibl.config.indent.char
  • g:indent_blankline_filetype_exclude is now :help ibl.config.exclude.filetypes
  • g:indent_blankline_buftype_exclude is now :help ibl.config.exclude.buftypes
  • g:indent_blankline_show_current_context is now :help ibl.config.scope.enabled, and it is on by default

For all others, please see :help ibl.config

Highlights

The name of the highlight groups changed, please take a look at :help ibl.highlights

See also:

  • :help ibl.config.indent.highlight
  • :help ibl.config.whitespace.highlight
  • :help ibl.config.scope.highlight

Commands

All command names have changed, please take a look at :help ibl.commands

Tab characters and list

The behavior of tabs when list is set is different from version 2. Indent-blankline now tries to be more conservative, and uses :help lcs-tab for the tab character if :help list is set. You can change the character with :help ibl.config.indent.tab_char