Skip to content

Commit

Permalink
Add document for editorconfig-trim-whitespaces-mode
Browse files Browse the repository at this point in the history
  • Loading branch information
10sr committed Dec 17, 2018
1 parent f16d342 commit ad04b36
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,24 @@ Possible known values are:
* `editorconfig-core-get-properties-hash`
* Always use built-in Emacs-Lisp implementation to get properties


### `editorconfig-trim-whitespaces-mode`

Buffer local minor-mode to use to trim trailing whitespaces.

If set, enable that mode when `trim_trailing_whitespace` is set to true.
Otherwise, use `delete-trailing-whitespace'.

One possible value is
[`ws-butler-mode`](https://github.com/lewang/ws-butler), with which
only lines touched get trimmed. To use it, add following to yo
init.el:

``` emacs-lisp
(setq editorconfig-trim-whitespaces-mode
'ws-butler-mode)
```

## Testing

Make and [CMake](https://cmake.org) must be installed to run the tests.
Expand Down

0 comments on commit ad04b36

Please sign in to comment.