aboutsummaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2018-05-31 13:48:06 +1200
committerTom Ryder <tom@sanctum.geek.nz>2018-05-31 13:50:36 +1200
commitd64a7405e3bbfcb10cef99eb2795130504bce3ae (patch)
tree675389d9a5587f13aa8afd24041ef7541db7ef18 /README.markdown
downloadvim-strip-trailing-whitespace-d64a7405e3bbfcb10cef99eb2795130504bce3ae.tar.gz
vim-strip-trailing-whitespace-d64a7405e3bbfcb10cef99eb2795130504bce3ae.zip
Initial commitv0.1.0
Copied with minimal changes from tejr's dotfiles suite, v0.36.0.
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..0fc2117
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,31 @@
+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 `<Plug>` mapping
+- Provide a user command to do the stripping as well if wanted
+- Strip trailing lines as well as trailing spaces
+- 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 emit output
+- 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/