[](https://github.com/echasnovski/mini.nvim/blob/main/LICENSE) ### Work with trailing whitespace See more details in [Features](#features) and [help file](../doc/mini-trailspace.txt). --- ⦿ This is a part of [mini.nvim](https://github.com/echasnovski/mini.nvim) library. Please use [this link](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-trailspace.md) 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'](https://github.com/echasnovski/mini.nvim/blob/main/CONTRIBUTING.md) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories. ## Demo https://user-images.githubusercontent.com/24854248/173045420-7aaf21b6-1d2e-4333-8a23-dea7e49c3a01.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 mini.deps

Github repo	Branch	Code snippet
'mini.nvim' library	Main	Follow recommended 'mini.deps' installation
	Stable
Standalone plugin	Main	add('echasnovski/mini.trailspace')
	Stable	add({ source = 'echasnovski/mini.trailspace', checkout = 'stable' })

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 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 : 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 ```lua -- 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](https://github.com/ntpeters/vim-better-whitespace)