|
|
*tidy.nvim.txt* For Neovim >= 0.9.0 Last change: 2023 June 17
|
|
|
|
|
|
==============================================================================
|
|
|
Table of Contents *tidy.nvim-table-of-contents*
|
|
|
|
|
|
1. tidy.nvim |tidy.nvim-tidy.nvim-|
|
|
|
- Features |tidy.nvim-tidy.nvim--features|
|
|
|
- Requirements |tidy.nvim-tidy.nvim--requirements|
|
|
|
- Installation |tidy.nvim-tidy.nvim--installation|
|
|
|
- Configuration |tidy.nvim-tidy.nvim--configuration|
|
|
|
- Usage |tidy.nvim-tidy.nvim--usage|
|
|
|
- About and Credits |tidy.nvim-tidy.nvim--about-and-credits|
|
|
|
|
|
|
==============================================================================
|
|
|
1. tidy.nvim *tidy.nvim-tidy.nvim-*
|
|
|
|
|
|
**tidy.nvim**removes trailing white space and empty lines on BufWritePre.
|
|
|
|
|
|
|
|
|
FEATURES *tidy.nvim-tidy.nvim--features*
|
|
|
|
|
|
- Remove white space at the end of every line on save
|
|
|
- Remove empty lines at the end of the buffer on save
|
|
|
|
|
|
|
|
|
REQUIREMENTS *tidy.nvim-tidy.nvim--requirements*
|
|
|
|
|
|
- Neovim >= 0.9.0
|
|
|
|
|
|
It may (should) work on lower versions, but is tested and updated using
|
|
|
nightly.
|
|
|
|
|
|
|
|
|
INSTALLATION *tidy.nvim-tidy.nvim--installation*
|
|
|
|
|
|
Your installation configuration will depend on your plugin manager. Below is
|
|
|
the basic installation (using default options) for lazy.nvim.
|
|
|
|
|
|
>lua
|
|
|
{
|
|
|
"mcauley-penney/tidy.nvim",
|
|
|
config = true,
|
|
|
}
|
|
|
<
|
|
|
|
|
|
|
|
|
CONFIGURATION *tidy.nvim-tidy.nvim--configuration*
|
|
|
|
|
|
tidy.nvim comes with the following options and their default settings:
|
|
|
|
|
|
>lua
|
|
|
{
|
|
|
filetype_exclude = {} -- Tidy will not be enabled for any filetype, e.g. "markdown", in this table
|
|
|
}
|
|
|
<
|
|
|
|
|
|
A more full example configuration for lazy.nvim would be:
|
|
|
|
|
|
>lua
|
|
|
{
|
|
|
"mcauley-penney/tidy.nvim",
|
|
|
config = {
|
|
|
filetype_exclude = { "markdown", "diff" }
|
|
|
},
|
|
|
init = function()
|
|
|
vim.keymap.set('n', "<leader>te", require("tidy").toggle, {})
|
|
|
end
|
|
|
}
|
|
|
<
|
|
|
|
|
|
|
|
|
USAGE *tidy.nvim-tidy.nvim--usage*
|
|
|
|
|
|
tidy.nvim comes with the following functions:
|
|
|
|
|
|
-------------------------------------------------------------------------------------
|
|
|
Lua Description
|
|
|
-------------------------- ----------------------------------------------------------
|
|
|
require("tidy").toggle() Turn tidy.nvim off for the current buffer a plugin
|
|
|
|
|
|
-------------------------------------------------------------------------------------
|
|
|
|
|
|
ABOUT AND CREDITS *tidy.nvim-tidy.nvim--about-and-credits*
|
|
|
|
|
|
I originally wrote this as a wrapper around a couple of vim regex commands used
|
|
|
for formatting files before I began using formatters. These commands are not
|
|
|
mine, please see the sources below. Even with real formatters in my setup now,
|
|
|
I still like and use this because I like these specific formats to be applied
|
|
|
to every buffer and don’t want to have a formatting tool installed for them.
|
|
|
|
|
|
- Vim Tips Wiki entry for removing unwanted spaces
|
|
|
<https://vim.fandom.com/wiki/Remove_unwanted_spaces#Automatically_removing_all_trailing_whitespace>
|
|
|
- `ib.`, the author of this Stack Overflow answer
|
|
|
<https://stackoverflow.com/a/7501902>
|
|
|
- This line
|
|
|
<https://github.com/gpanders/editorconfig.nvim/blob/ae3586771996b2fb1662eb0c17f5d1f4f5759bb7/lua/editorconfig.lua#L180>
|
|
|
in gpanders/editorconfig.nvim <https://github.com/gpanders/editorconfig.nvim>
|
|
|
for exposing me to the `keepjumps` and `keeppatterns` modifiers
|
|
|
|
|
|
==============================================================================
|
|
|
2. Links *tidy.nvim-links*
|
|
|
|
|
|
1. *tidy-demo*: https://github.com/mcauley-penney/tidy.nvim/assets/59481467/f3807c69-2b36-4a14-b83a-dd0f2829e096
|
|
|
|
|
|
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
|
|
|
|
|
|
vim:tw=78:ts=8:noet:ft=help:norl:
|
