Don't remove trailing whitespaces in diff as well as in data sections…

… in perl and ruby
pkryger · Oct 28, 2024 · f2c162a · f2c162a
1 parent 064cda8
commit f2c162a
Show file tree

Hide file tree

Showing 2 changed files with 106 additions and 4 deletions.
diff --git a/modules/init-look-and-feel.el b/modules/init-look-and-feel.el
@@ -267,18 +267,110 @@
 (use-package vlf-setup
   :ensure vlf)
 
+(defun exordium-delete-trailing-whitespace-in-buffer (&optional start end)
+  "Delete trailing whitespace in current buffer.
+Like `delete-trailing-whitespace', but any restrictions are
+ignored.
+
+Additionally, when called with a nil END and
+`exordium-delete-trailing-whitespace-skip-data' is non-nil it
+will not affect data sections in Ruby and Perl modes (with an
+exception of a perlpod).  When both END and
+`exordium-delete-trailing-whitespace-skip-data' are nil it will
+delete whitespace in the whole buffer.  When called with a
+non-nil END it will delete trailing whitespace up to END.
+
+If called interactively, START and END are the start/end of the
+region if the mark is active, or the whole buffer, up to data
+secion (when `exordium-delete-trailing-whitespace-skip-data' is
+non-nil), if the mark is inactive.
+
+The function doesn't delete trailing whitespaces when buffer is
+in `diff-mode', `exordium-delete-trailing-whitespace-skip-data'
+is non-nil, and the function has been called without a prefix argument.
+
+Depending on mode a data section starts after a line with a one
+of keywords __END__ or __DATA__ or a one of control
+characters (^D, ^Z) and ends at the end of file.  Such a
+preservation of whitespaces may be important for some types of
+data (i.e., patches) but should be to safe to clear it from
+others other (i.e., perlpod).  See
+https://perldoc.perl.org/perldata,
+https://perldoc.perl.org/perlpodspec, and
+https://docs.ruby-lang.org/en/3.3/Object.html for more details."
+  (interactive (progn
+                 (barf-if-buffer-read-only)
+                 (if (use-region-p)
+                     (list (region-beginning) (region-end))
+                   (list nil nil))))
+  (if (and exordium-delete-trailing-whitespace-skip-data
+           (not current-prefix-arg)
+           (derived-mode-p 'diff-mode))
+      (when (called-interactively-p 'any)
+        (message "Not deleting trailing whitespaces in %s mode. Call with prefix to override."
+                 major-mode))
+    (without-restriction
+      (let ((end
+             (or end
+                 (when-let ((exordium-delete-trailing-whitespace-skip-data)
+                            (data-keywords (cond
+                                       ((derived-mode-p 'ruby-mode
+                                                        'ruby-ts-mode
+                                                        'enh-ruby-mode)
+                                        '("__END__"))
+                                       ((derived-mode-p 'perl-mode
+                                                        'perl-ts-mode
+                                                        'cperl-mode)
+                                        '("__END__" "__DATA__" "" ""))))
+                            (perldoc-keywords '("pod" "head1" "head2" "head3"
+                                                "head4" "head5" "head6" "over"
+                                                "item" "back" "begin" "end"
+                                                "for" "encoding" "cut")))
+                   (save-excursion
+                     (save-match-data
+                       (goto-char (point-min))
+                       (when (re-search-forward
+                              (rx-to-string
+                               `(seq bol (or ,@data-keywords) (zero-or-more whitespace) eol)
+                               t)
+                              nil t)
+                         (let ((point (point)))
+                           (if (and (derived-mode-p 'perl-mode
+                                                    'perl-ts-mode
+                                                    'cperl-mode)
+                                    (message "perl")
+                                    (re-search-forward
+                                     (rx-to-string
+                                      `(seq "\n\n=" (or ,@perldoc-keywords)) t)
+                                     ;; 3 = two new lines, a "="
+                                     (+ point 3
+                                        (apply #'max (mapcar #'length perldoc-keywords)))
+                                     t))
+                               ;; trim whitespace till the end of buffer when in a perlpod
+                               nil
+                             ;; trim whitespace only up to data section
+                             point)))))))))
+        (delete-trailing-whitespace start end)))))
+
+(apply #'max (mapcar #'length '("pod" "head1" "head2" "head3"
+                                                "head4" "head5" "head6" "over"
+                                                "item" "back" "begin" "end"
+                                                "for" "encoding" "cut")))
+
 ;; Remove trailing blanks on save
 (define-minor-mode delete-trailing-whitespace-mode
-  "Remove trailing whitespace upon saving a buffer"
+  "Remove trailing whitespace upon saving a buffer.
+See `exordium-delete-trailing-whitespace-in-buffer' for more details."
   :lighter nil
   (if delete-trailing-whitespace-mode
-      (add-hook 'before-save-hook #'delete-trailing-whitespace nil t)
-    (remove-hook 'before-save-hook #'delete-trailing-whitespace t)))
+      (add-hook 'before-save-hook #'exordium-delete-trailing-whitespace-in-buffer nil t)
+    (remove-hook 'before-save-hook #'exordium-delete-trailing-whitespace-in-buffer t)))
 
 (define-globalized-minor-mode global-delete-trailing-whitespace-mode
   delete-trailing-whitespace-mode
   (lambda ()
-    (delete-trailing-whitespace-mode t)))
+    (delete-trailing-whitespace-mode t))
+  :group 'exordium)
 
 (when exordium-delete-trailing-whitespace
   (global-delete-trailing-whitespace-mode t))

diff --git a/modules/init-prefs.el b/modules/init-prefs.el
@@ -86,6 +86,16 @@ projects that have a lot of trailing whitespaces"
   :group 'exordium
   :type  'boolean)
 
+(defcustom exordium-delete-trailing-whitespace-skip-data t
+  "When t preserve whitespaces in Data section in Perl and Ruby modes.
+This variable is used by
+`exordium-delete-trailing-whitespace-in-buffer' (see docstring
+for details) and in consequence in
+`delete-trailing-whitespace-mode' and
+`global-delete-trailing-whitespace-mode'."
+  :group 'exordium
+  :type 'boolean)
+
 (defcustom exordium-enable-electric-pair-mode t
   "Enables electric-pair-mode."
   :group 'exordium