From fb3c25becd1e4a565c4339b000b96ff519544dbd Mon Sep 17 00:00:00 2001 From: Tom Ryder Date: Sun, 10 Jun 2018 01:38:47 +1200 Subject: Refactor majorly for 0.2.0 - Do report counts of trimmed and deleted lines (and distinguish them accurately) - Fully backport to 6.0 (no cursor() func in that version) - Don't substitute on lines without trailing space --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..0f7d95c --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +strip\_trailing\_whitespace.vim +=============================== + +This plugin provides a mapping target and an optional custom command with the +author's approach to stripping trailing whitespace from an entire buffer, +including removing empty or whitespace-only lines at the end of the buffer, +without making command noise and without moving the cursor from its current +position. + +This is a very commonly written and implemented plugin, but I wrote my own +because I could not find a plugin that did this in exactly the way I wanted: + +- Provide a `` mapping +- Provide a user command to do the stripping as well if wanted +- Strip trailing lines as well as trailing spaces, reporting both +- Work with even very old Vim (>=6.0) +- Work with a single `undo` +- Don't move the cursor +- Don't change the search pattern +- Don't define an `autocmd` +- Don't force a key mapping +- Don't define a global function + +License +------- + +Copyright (c) [Tom Ryder][1]. Distributed under the same terms as Vim itself. +See `:help license`. + +[1]: https://sanctum.geek.nz/ -- cgit v1.2.3