Something went wrong. Try again.
Library of 45+ independent Lua modules improving Neovim experience with minimal effort nvim-mini.org/mini.nvim
Something went wrong. Try again.
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091*mini.trailspace* Trailspace (highlight and remove)
MIT License Copyright (c) 2021 Evgeni Chasnovski
------------------------------------------------------------------------------ *MiniTrailspace*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()|.
# Setup ~
This module needs a setup with `require('mini.trailspace').setup({})`(replace `{}` with your `config` table). It will create global Lua table`MiniTrailspace` which you can use for scripting or manually (with`:lua MiniTrailspace.*`).
See |MiniTrailspace.config| for `config` structure and default values.
You can override runtime config settings locally to buffer inside`vim.b.minitrailspace_config` which should have same structure as`MiniTrailspace.config`. See |mini.nvim-buffer-local-config| for more details.
# Highlight groups ~*MiniTrailspace-hl-groups*
- `MiniTrailspace` - highlight group for trailing space.
To change any highlight group, set it directly with |nvim_set_hl()|.
# Disabling ~
To disable, set `vim.g.minitrailspace_disable` (globally) or`vim.b.minitrailspace_disable` (for a buffer) to `true`. Considering highnumber of different scenarios and customization intentions, writing exactrules for disabling module's functionality is left to user. See|mini.nvim-disabling-recipes| for common recipes. Note: after disablingthere might be highlighting left; it will be removed after nexthighlighting update (see |events| and `MiniTrailspace` |:augroup|).
------------------------------------------------------------------------------ *MiniTrailspace.setup()* `MiniTrailspace.setup`({config})Module setup
Parameters ~{config} `(table|nil)` Module config table. See |MiniTrailspace.config|.
Usage ~>lua require('mini.trailspace').setup() -- use default config -- OR require('mini.trailspace').setup({}) -- replace {} with your config table<------------------------------------------------------------------------------ *MiniTrailspace.config* `MiniTrailspace.config`Defaults ~>lua MiniTrailspace.config = { -- 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, }<------------------------------------------------------------------------------ *MiniTrailspace.highlight()* `MiniTrailspace.highlight`()Highlight trailing whitespace in current window
------------------------------------------------------------------------------ *MiniTrailspace.unhighlight()* `MiniTrailspace.unhighlight`()Unhighlight trailing whitespace in current window
------------------------------------------------------------------------------ *MiniTrailspace.trim()* `MiniTrailspace.trim`()Trim trailing whitespace
------------------------------------------------------------------------------ *MiniTrailspace.trim_last_lines()* `MiniTrailspace.trim_last_lines`()Trim last blank lines
vim:tw=78:ts=8:noet:ft=help:norl: