aboutsummaryrefslogtreecommitdiffstats
path: root/emacs/.emacs.d/local-lisp/destroy-trailing-whitespace.el
blob: ed170dfb579e8a010b3a00d124582da70a0be52c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
;;; destroy-trailing-whitespace.el --- Destroy all trailing whitespace  -*- lexical-binding: t; -*-

;; Copyright (C) 2016  Tom Willemse

;; Author: Tom Willemse <chelys@drd>
;; Keywords: convenience

;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; This library offers a single mode that will delete all trailing
;; whitespace before saving any file. It tries to be intelligent
;; enough to only do this for modes where trailing whitespace is not
;; meaningful. Currently it only keeps whitespace around in
;; `markdown-mode' since it uses two spaces at the end of a line to
;; signify a line break.
;;
;; To use this mode in all buffers, add the following to your init
;; file:
;;
;;    (require 'destroy-trailing-whitespace)
;;    (global-destroy-trailing-whitespace-mode)
;;
;; To use this mode in just some buffers add it to your preferred
;; hook. For example, to use it only in `prog-mode' buffers:
;;
;;    (require 'destroy-trailing-whitespace)
;;    (add-hook 'prog-mode-hook 'destroy-trailing-whitespace-mode)

;;; Code:

(defun destroy-trailing-whitespace ()
  "Delete trailing whitespace everywhere, except in Markdown buffers."
  (if (not (eq major-mode 'markdown-mode))
      (delete-trailing-whitespace)))

;;;###autoload
(define-minor-mode destroy-trailing-whitespace-mode
  "Destroy all trailing whitespace before saving the buffer."
  :lighter ""
  (if destroy-trailing-whitespace-mode
      (add-hook 'before-save-hook 'delete-trailing-whitespace nil :local)
    (remove-hook 'before-save-hook 'delete-trailing-whitespace :local)))

;;;###autoload
(define-minor-mode global-destroy-trailing-whitespace-mode
  "Destroy all trailing whitespace before saving any open buffer."
  :lighter "" :global t
  (if global-destroy-trailing-whitespace-mode
      (add-hook 'before-save-hook 'destroy-trailing-whitespace)
    (remove-hook 'before-save-hook 'destroy-trailing-whitespace)))

(provide 'destroy-trailing-whitespace)
;;; destroy-trailing-whitespace.el ends here