GNU logs - #78264, boring messages

Message sent to monnier@HIDDEN, editorconfig@HIDDEN, bug-gnu-emacs@HIDDEN:

Subject: bug#78264: [PATCH] simple.el (delete-trailing-whitespace-mode): New minor mode
Resent-From: Stefan Monnier <monnier@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: monnier@HIDDEN, editorconfig@HIDDEN, bug-gnu-emacs@HIDDEN
Resent-Date: Mon, 05 May 2025 16:03:02 +0000
Resent-Message-ID: <handler.78264.B.17464609367342 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: 78264 <at> debbugs.gnu.org
Cc: <monnier@HIDDEN>, EditorConfig Team <editorconfig@HIDDEN>
From: Stefan Monnier <monnier@HIDDEN>
Date: Mon, 05 May 2025 12:01:22 -0400
Message-ID: <jwv5xif11yl.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="=-=-="
Received-SPF: pass client-ip=132.204.25.50;
 envelope-from=monnier@HIDDEN; helo=mailscanner.iro.umontreal.ca
X-Spam_score_int: -42
X-Spam_score: -4.3
X-Spam_bar: ----
X-Spam_report: (-4.3 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
 DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_MED=-2.3,
 RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001,
 SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-Spam-Score: 0.0 (/)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

--=-=-=
Content-Type: text/plain

Tags: patch

While

    (add-hook 'before-save-hook #'delete-trailing-whitespace nil t)

is simple enough to put into one's init file, it's a bit rough around
the edges (e.g. for read-only buffers, or interaction with
editorconfig).  So I suggest we add a simple
`delete-trailing-whitespace-mode` minor mode.

Comments?  Objections?


        Stefan


 In GNU Emacs 31.0.50 (build 1, i686-pc-linux-gnu, GTK+ Version 3.24.49,
 cairo version 1.18.4) of 2025-05-01 built on alfajor
Repository revision: 3555aa795435c6c150e9291386cb776acd35e564
Repository branch: work
Windowing system distributor 'The X.Org Foundation', version 11.0.12101016
System Description: Debian GNU/Linux trixie/sid

Configured using:
 'configure -C --enable-checking --enable-check-lisp-object-type --with-modules --with-cairo --with-tiff=ifavailable
 'CFLAGS=-Wall -g3 -Og -Wno-pointer-sign'
 PKG_CONFIG_PATH=/home/monnier/lib/pkgconfig'


--=-=-=
Content-Type: text/patch
Content-Disposition: attachment;
 filename=0001-simple.el-delete-trailing-whitespace-mode-New-minor-.patch

From 5740c9b27883de86888df8d201e5daed97d7dd0b Mon Sep 17 00:00:00 2001
From: Stefan Monnier <monnier@HIDDEN>
Date: Mon, 5 May 2025 11:55:29 -0400
Subject: [PATCH] simple.el (delete-trailing-whitespace-mode): New minor mode

Partly motivated by bug#78097.

* lisp/simple.el (delete-trailing-whitespace-if-possible): New function.
(delete-trailing-whitespace-mode): New minor mode.

* lisp/editorconfig.el (editorconfig-trim-whitespaces-mode):
Change default to `delete-trailing-whitespace-mode`.
(editorconfig--get-trailing-ws): Simplify accordingly.
(editorconfig--add-hook-safe-p): Delete function.  Don't touch
`safe-local-eval-function` any more.
---
 etc/NEWS             |  4 ++++
 lisp/editorconfig.el | 38 +++++++++++---------------------------
 lisp/simple.el       | 15 +++++++++++++++
 3 files changed, 30 insertions(+), 27 deletions(-)

diff --git a/etc/NEWS b/etc/NEWS
index 146cdedaa43..8efb6e6ae07 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -2034,6 +2034,10 @@ the file name, using the minibuffer's "future history".
 
 * New Modes and Packages in Emacs 31.1
 
+** New minor mode 'delete-trailing-whitespace-mode'.
+A simple buffer-local mode that runs 'delete-trailing-whitespace'
+before saving the buffer.
+
 ** New major mode 'conf-npmrc-mode'.
 A major mode based on 'conf-mode' for editing ".npmrc" files.
 
diff --git a/lisp/editorconfig.el b/lisp/editorconfig.el
index 7cdd79fa3b0..bfc8ef46ed3 100644
--- a/lisp/editorconfig.el
+++ b/lisp/editorconfig.el
@@ -277,13 +277,13 @@ editorconfig-indentation-alist
   :version "30.1"
   :risky t)
 
-(defcustom editorconfig-trim-whitespaces-mode nil
+(defcustom editorconfig-trim-whitespaces-mode #'delete-trailing-whitespace-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'."
   :version "30.1"
-  :type 'symbol)
+  :type 'function)
 
 (defvar-local editorconfig-properties-hash nil
   "Hash object of EditorConfig properties that was enabled for current buffer.
@@ -542,33 +542,17 @@ editorconfig--delete-trailing-whitespace
   "Call `delete-trailing-whitespace' unless the buffer is read-only."
   (unless buffer-read-only (delete-trailing-whitespace)))
 
-;; Arrange for our (eval . (add-hook ...)) "local var" to be considered safe.
-(defun editorconfig--add-hook-safe-p (exp)
-  (equal exp '(add-hook 'before-save-hook
-                        #'editorconfig--delete-trailing-whitespace nil t)))
-(let ((predicates (get 'add-hook 'safe-local-eval-function)))
-  (when (functionp predicates)
-    (setq predicates (list predicates)))
-  (unless (memq #'editorconfig--add-hook-safe-p predicates)
-    (put 'add-hook 'safe-local-eval-function #'editorconfig--add-hook-safe-p)))
-
 (defun editorconfig--get-trailing-ws (props)
   "Get vars to trim of trailing whitespace according to PROPS."
-  (pcase (gethash 'trim_trailing_whitespace props)
-    ("true"
-     `((eval
-        . ,(if editorconfig-trim-whitespaces-mode
-               `(,editorconfig-trim-whitespaces-mode 1)
-             '(add-hook 'before-save-hook
-                        #'editorconfig--delete-trailing-whitespace nil t)))))
-    ("false"
-     ;; Just do it right away rather than return a (VAR . VAL), which
-     ;; would be probably more trouble than it's worth.
-     (when editorconfig-trim-whitespaces-mode
-       (funcall editorconfig-trim-whitespaces-mode 0))
-     (remove-hook 'before-save-hook
-                  #'editorconfig--delete-trailing-whitespace t)
-     nil)))
+  (let ((fun (or editorconfig-trim-whitespaces-mode
+                 #'delete-trailing-whitespace-mode)))
+    (pcase (gethash 'trim_trailing_whitespace props)
+      ("true" `((eval . (,fun 1))))
+      ("false"
+       ;; Just do it right away rather than return a (VAR . VAL), which
+       ;; would be probably more trouble than it's worth.
+       (funcall fun 0)
+       nil))))
 
 (defun editorconfig--get-line-length (props)
   "Get the max line length (`fill-column') to PROPS."
diff --git a/lisp/simple.el b/lisp/simple.el
index 486092de2c8..f686907ad68 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -888,6 +888,21 @@ delete-trailing-whitespace
   ;; Return nil for the benefit of `write-file-functions'.
   nil)
 
+(defun delete-trailing-whitespace-if-possible ()
+  "Call `delete-trailing-whitespace' unless the buffer is read-only."
+  (unless buffer-read-only (delete-trailing-whitespace)))
+
+(define-minor-mode delete-trailing-whitespace-mode
+  "Delete trailing whitespace before saving the current buffer."
+  :global nil
+  (cond
+   (delete-trailing-whitespace-mode
+    (add-hook 'before-save-hook
+              #'delete-trailing-whitespace-if-possible nil t))
+   (t
+    (remove-hook 'before-save-hook
+                 #'delete-trailing-whitespace-if-possible t))))
+
 (defun newline-and-indent (&optional arg)
   "Insert a newline, then indent according to major mode.
 Indentation is done using the value of `indent-line-function'.
-- 
2.47.2


--=-=-=--

Message sent:

Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-Mailer: MIME-tools 5.505 (Entity 5.505)
Content-Type: text/plain; charset=utf-8
X-Loop: help-debbugs@HIDDEN
From: help-debbugs@HIDDEN (GNU bug Tracking System)
To: Stefan Monnier <monnier@HIDDEN>
Subject: bug#78264: Acknowledgement ([PATCH] simple.el (delete-trailing-whitespace-mode):
 New minor mode)
Message-ID: <handler.78264.B.17464609367342.ack <at> debbugs.gnu.org>
References: <jwv5xif11yl.fsf@HIDDEN>
X-Gnu-PR-Message: ack 78264
X-Gnu-PR-Package: emacs
X-Gnu-PR-Keywords: patch
Reply-To: 78264 <at> debbugs.gnu.org
Date: Mon, 05 May 2025 16:03:02 +0000

Thank you for filing a new bug report with debbugs.gnu.org.

This is an automatically generated reply to let you know your message
has been received.

Your message is being forwarded to the package maintainers and other
interested parties for their attention; they will reply in due course.

As you requested using X-Debbugs-CC, your message was also forwarded to
  <monnier@HIDDEN>, EditorConfig Team <editorconfig@googlegroups.=
com>
(after having been given a bug report number, if it did not have one).

Your message has been sent to the package maintainer(s):
 bug-gnu-emacs@HIDDEN

If you wish to submit further information on this problem, please
send it to 78264 <at> debbugs.gnu.org.

Please do not send mail to help-debbugs@HIDDEN unless you wish
to report a problem with the Bug-tracking system.

--=20
78264: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D78264
GNU Bug Tracking System
Contact help-debbugs@HIDDEN with problems

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#78264: [PATCH] simple.el (delete-trailing-whitespace-mode): New minor mode
Resent-From: Sean Whitton <spwhitton@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Sat, 10 May 2025 08:46:02 +0000
Resent-Message-ID: <handler.78264.B78264.174686671710053 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: 78264 <at> debbugs.gnu.org
Cc: Stefan Monnier <monnier@HIDDEN>, EditorConfig Team <editorconfig@HIDDEN>
Feedback-ID: 20115:3760:null:purelymail
From: Sean Whitton <spwhitton@HIDDEN>
In-Reply-To: <jwv5xif11yl.fsf@HIDDEN>
References: <jwv5xif11yl.fsf@HIDDEN>
Date: Sat, 10 May 2025 09:45:05 +0100
Message-ID: <874ixsx3am.fsf@HIDDEN>
User-Agent: Gnus/5.13 (Gnus v5.13)
MIME-Version: 1.0
Content-Type: text/plain
Precedence: list
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>

Hello,

Seems reasonable, though can we make sure Emacs will let you enable it
from .dir-locals.el for a repository without generating warnings?
I.e. set whatever is needed to trust it as a minor mode enabled from
there (which may be nothing).

-- 
Sean Whitton

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#78264: [PATCH] simple.el (delete-trailing-whitespace-mode): New minor mode
Resent-From: Eli Zaretskii <eliz@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Sat, 10 May 2025 09:11:02 +0000
Resent-Message-ID: <handler.78264.B78264.174686824415724 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: Sean Whitton <spwhitton@HIDDEN>
Cc: 78264 <at> debbugs.gnu.org, monnier@HIDDEN, editorconfig@HIDDEN
Date: Sat, 10 May 2025 12:10:31 +0300
Message-Id: <86tt5sbzlk.fsf@HIDDEN>
From: Eli Zaretskii <eliz@HIDDEN>
In-Reply-To: <874ixsx3am.fsf@HIDDEN> (message from Sean
 Whitton on Sat, 10 May 2025 09:45:05 +0100)
References: <jwv5xif11yl.fsf@HIDDEN>
 <874ixsx3am.fsf@HIDDEN>
Precedence: list
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>

> Cc: Stefan Monnier <monnier@HIDDEN>,
>  EditorConfig Team <editorconfig@HIDDEN>
> From: Sean Whitton <spwhitton@HIDDEN>
> Date: Sat, 10 May 2025 09:45:05 +0100
> 
> Seems reasonable, though can we make sure Emacs will let you enable it
> from .dir-locals.el for a repository without generating warnings?
> I.e. set whatever is needed to trust it as a minor mode enabled from
> there (which may be nothing).

Is this really useful to turn on for _every_ file in a directory?
What about files where trailing whitespace is significant (patches,
for example)?

Message sent to bug-gnu-emacs@HIDDEN:

X-Loop: help-debbugs@HIDDEN
Subject: bug#78264: [PATCH] simple.el (delete-trailing-whitespace-mode): New minor mode
Resent-From: Stefan Monnier <monnier@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Sat, 10 May 2025 09:44:02 +0000
Resent-Message-ID: <handler.78264.B78264.174687019123333 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
X-GNU-PR-Message: followup 78264
X-GNU-PR-Package: emacs
X-GNU-PR-Keywords: patch
To: Sean Whitton <spwhitton@HIDDEN>
Cc: 78264 <at> debbugs.gnu.org, EditorConfig Team <editorconfig@HIDDEN>
Received: via spool by 78264-submit <at> debbugs.gnu.org id=B78264.174687019123333
          (code B ref 78264); Sat, 10 May 2025 09:44:02 +0000
Received: (at 78264) by debbugs.gnu.org; 10 May 2025 09:43:11 +0000
Received: from localhost ([127.0.0.1]:43999 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1uDgje-00064H-Rt
	for submit <at> debbugs.gnu.org; Sat, 10 May 2025 05:43:11 -0400
Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:6897)
 by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.84_2) (envelope-from <monnier@HIDDEN>)
 id 1uDgjY-00063N-Iz
 for 78264 <at> debbugs.gnu.org; Sat, 10 May 2025 05:43:05 -0400
Received: from pmg2.iro.umontreal.ca (localhost.localdomain [127.0.0.1])
 by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id 408448087F;
 Sat, 10 May 2025 05:42:59 -0400 (EDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca;
 s=mail; t=1746870178;
 bh=0k1cLANc9vLnZ9pY+j4DIXgdkqUZTmJIQ5Ft0vs42Rk=;
 h=From:To:Cc:Subject:In-Reply-To:References:Date:From;
 b=MwLPKVhLVsEqxfRVEhMsI//cUEaALP3zUiUyNLGDQBBJNB8DqiL0awXMY/Kkaa4AN
 +u3cpYoYE11AV8M7q76jp9XvVPEqMnrhhfN2NzwpD/2dOaxjZBZi1H+gRmpEzrSq5/
 zh9Hm4ID+ZYYhHBGGjEbve9OTJFepKmcMTRT+Ac+quqh4QXb33gjRcxZBJ5CSy1BKa
 yIdWo+cXt0H3VjDVKPWmlsrxU9Hbr+5aFifM0MQE1+HeDElx+3AYMiS+YXBRR0LFFJ
 qG21oNwQQ4pAujKUm6mo+QHDS89puHtoWf3vvGgjOv+6Rs8Hua0COG9bPNoGkiTMVi
 V8SiAyT0z71mQ==
Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1])
 by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id 7DE19805C1;
 Sat, 10 May 2025 05:42:58 -0400 (EDT)
Received: from pastel (104-195-232-56.cpe.teksavvy.com [104.195.232.56])
 by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 4F0B91204D2;
 Sat, 10 May 2025 05:42:58 -0400 (EDT)
From: Stefan Monnier <monnier@HIDDEN>
In-Reply-To: <874ixsx3am.fsf@HIDDEN>
Message-ID: <jwvikm8ls4b.fsf-monnier+emacs@HIDDEN>
References: <jwv5xif11yl.fsf@HIDDEN>
 <874ixsx3am.fsf@HIDDEN>
Date: Sat, 10 May 2025 05:42:57 -0400
User-Agent: Gnus/5.13 (Gnus v5.13)
MIME-Version: 1.0
Content-Type: text/plain
X-SPAM-INFO: Spam detection results:  0
 ALL_TRUSTED                -1 Passed through trusted hosts only via SMTP
 AWL -0.075 Adjusted score from AWL reputation of From: address
 BAYES_00                 -1.9 Bayes spam probability is 0 to 1%
 DKIM_SIGNED               0.1 Message has a DKIM or DK signature,
 not necessarily valid
 DKIM_VALID -0.1 Message has at least one valid DKIM or DK signature
 DKIM_VALID_AU -0.1 Message has a valid DKIM or DK signature from author's
 domain
 DKIM_VALID_EF -0.1 Message has a valid DKIM or DK signature from envelope-from
 domain
X-SPAM-LEVEL: 
X-Spam-Score: -2.3 (--)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -3.3 (---)

> Seems reasonable, though can we make sure Emacs will let you enable it
> from .dir-locals.el for a repository without generating warnings?
> I.e. set whatever is needed to trust it as a minor mode enabled from
> there (which may be nothing).

AFAIK this is already the case for all minor modes.

I didn't check with `.dir-locals.el` but I did check with
`.editorconfig`, which should show the same behavior.



        Sefan

Last modified: Sat, 10 May 2025 09:45:01 UTC

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997 nCipher Corporation Ltd, 1994-97 Ian Jackson.