tidy.nvim 🧹

A function and autocommand pair that removes all

- trailing whitespace
- empty lines at the end of the buffer

on every BufWritePre.

Notes: See the cfg branch for increased functionality and configuration.

About

I wrote this as a wrapper around a few vim regex commands used for formatting files before I began using formatters. These commands are not mine, see the Credits section below for sources. My contribution is a basic conditional which protects the user from an error when the cursor is in the group of empty lines removed from the end of the buffer. 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. There really isn't a reason to have this in a plugin other than wanting to disseminate this for new users and people who didn't know you could do this. You could (should) instead just yank and put the code right in your config.

Installation

• Packer

use "mcauley-penney/tidy.nvim"

or with lazy-loading

use{ "mcauley-penney/tidy.nvim", event = "BufWritePre" }

Credits

• Vim Tips Wiki entry for removing unwanted spaces

• ib., the author of this Stack Overflow answer

• This line in gpanders/editorconfig.nvim for exposing me to the keepjumps and keeppatterns modifiers

Todo

• preserve undotree