mawdac/mini.trailspace

Neovim Lua plugin to manage trailspace (highlight and remove). Part of 'mini.nvim' library.

Work with trailing whitespace

See more details in Features and help file.

---

⦿ This is a part of mini.nvim library. Please use this link if you want to mention this module.

⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.

⦿ See the repository page to learn about common design principles and configuration recipes.

---

If you want to help this project grow but don't know where to start, check out contributing guides of 'mini.nvim' or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.

Demo

demo-trailspace.mp4

Features

• Highlighting is done only in modifiable buffer by default, only in Normal mode, and stops in Insert mode and when leaving window.
• Trim all trailing whitespace with MiniTrailspace.trim().
• Trim all trailing empty lines with MiniTrailspace.trim_last_lines().

Installation

This plugin can be installed as part of 'mini.nvim' library (recommended) or as a standalone Git repository.

There are two branches to install from:

• main (default, recommended) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).
• stable will be updated only upon releases with code tested during public beta-testing phase in main branch.

Here are code snippets for some common installation methods (use only one):

With folke/lazy.nvim

Github repo	Branch	Code snippet
'mini.nvim' library	Main	{ 'echasnovski/mini.nvim', version = false },
	Stable	{ 'echasnovski/mini.nvim', version = '*' },
Standalone plugin	Main	{ 'echasnovski/mini.trailspace', version = false },
	Stable	{ 'echasnovski/mini.trailspace', version = '*' },

With wbthomason/packer.nvim

Github repo	Branch	Code snippet
'mini.nvim' library	Main	use 'echasnovski/mini.nvim'
	Stable	use { 'echasnovski/mini.nvim', branch = 'stable' }
Standalone plugin	Main	use 'echasnovski/mini.trailspace'
	Stable	use { 'echasnovski/mini.trailspace', branch = 'stable' }

With junegunn/vim-plug

Github repo	Branch	Code snippet
'mini.nvim' library	Main	Plug 'echasnovski/mini.nvim'
	Stable	Plug 'echasnovski/mini.nvim', { 'branch': 'stable' }
Standalone plugin	Main	Plug 'echasnovski/mini.trailspace'
	Stable	Plug 'echasnovski/mini.trailspace', { 'branch': 'stable' }

Important: don't forget to call require('mini.trailspace').setup() to enable its functionality.

Note: if you are on Windows, there might be problems with too long file paths (like error: unable to create file <some file name>: Filename too long). Try doing one of the following:

• Enable corresponding git global config value: git config --system core.longpaths true. Then try to reinstall.
• Install plugin in other place with shorter path.

Default config

-- No need to copy this inside `setup()`. Will be used automatically.
{
  -- Highlight only in normal buffers (ones with empty 'buftype'). This is
  -- useful to not show trailing whitespace where it usually doesn't matter.
  only_in_normal_buffers = true,
}

Similar plugins

• ntpeters/vim-better-whitespace