From: Stefan Kangas <stefankangas@gmail.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 59920@debbugs.gnu.org
Subject: bug#59920: [PATCH] Make checkdoc warn if not using lexical-binding
Date: Sat, 10 Dec 2022 15:26:03 -0800 [thread overview]
Message-ID: <CADwFkmnmZAF_fHQ1C9c-0Yw6eG5mpB7gu0jc07Ta8ep9ZH5prw@mail.gmail.com> (raw)
In-Reply-To: <83o7sczl1x.fsf@gnu.org>
[-- Attachment #1: Type: text/plain, Size: 146 bytes --]
Eli Zaretskii <eliz@gnu.org> writes:
> I just think we should allow turning off this warning.
Agreed, thanks. I've added that in the attached.
[-- Attachment #2: 0001-Make-checkdoc-warn-if-not-using-lexical-binding.patch --]
[-- Type: text/x-diff, Size: 3656 bytes --]
From 1a90d2b6f3243274af347d3cf296f32293f68cc7 Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefankangas@gmail.com>
Date: Fri, 9 Dec 2022 10:58:22 +0100
Subject: [PATCH] Make checkdoc warn if not using lexical-binding
* lisp/emacs-lisp/checkdoc.el (checkdoc-file-comments-engine):
Warn if there is no lexical-binding cookie.
---
etc/NEWS | 8 ++++++++
lisp/emacs-lisp/checkdoc.el | 39 +++++++++++++++++++++++++++++++++++++
2 files changed, 47 insertions(+)
diff --git a/etc/NEWS b/etc/NEWS
index 0c1fdfc454..1ed6a31197 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -76,6 +76,14 @@ using this new option. (Or set 'display-buffer-alist' directly.)
After manually editing 'eshell-aliases-file', you can use
'M-x eshell-read-aliases-list' to load the edited aliases.
+** checkdoc
+
+---
+*** New checkdock warning if not using lexical-binding.
+Checkdoc now warns if the first line of an Emacs Lisp file does not
+end with a "-*- lexical-binding: t -*-" cookie. Customize the user
+option 'checkdoc-lexical-binding-flag' to nil to disable this warning.
+
\f
* New Modes and Packages in Emacs 30.1
diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el
index 3bddb93b64..0a2d9680fe 100644
--- a/lisp/emacs-lisp/checkdoc.el
+++ b/lisp/emacs-lisp/checkdoc.el
@@ -120,6 +120,14 @@
;; simple style rules to follow which checkdoc will auto-fix for you.
;; `y-or-n-p' and `yes-or-no-p' should also end in "?".
;;
+;; Lexical binding:
+;;
+;; We recommend always using lexical binding in new code, and
+;; converting old code to use it. Checkdoc warns if you don't have
+;; the recommended string "-*- lexical-binding: t -*-" at the top of
+;; the file. You can disable this check with the user option
+;; `checkdoc-lexical-binding-flag'.
+;;
;; Adding your own checks:
;;
;; You can experiment with adding your own checks by setting the
@@ -330,6 +338,12 @@ checkdoc-column-zero-backslash-before-paren
:type 'boolean
:version "28.1")
+(defcustom checkdoc-lexical-binding-flag t
+ "Non-nil means generate warnings if file is not using lexical binding.
+See Info node `(elisp) Converting to Lexical Binding' for more."
+ :type 'boolean
+ :version "29.1")
+
;; This is how you can use checkdoc to make mass fixes on the Emacs
;; source tree:
;;
@@ -2369,6 +2383,31 @@ checkdoc-file-comments-engine
(point-min) (save-excursion (goto-char (point-min))
(line-end-position))))
nil))
+ (when checkdoc-lexical-binding-flag
+ (setq
+ err
+ ;; Lexical binding cookie.
+ (if (not (save-excursion
+ (save-restriction
+ (goto-char (point-min))
+ (narrow-to-region (point) (pos-eol))
+ (re-search-forward
+ (rx "-*-" (* (* nonl) ";")
+ (* space) "lexical-binding:" (* space) "t" (* space)
+ (* ";" (* nonl))
+ "-*-")
+ nil t))))
+ (let ((pos (save-excursion (goto-char (point-min))
+ (goto-char (pos-eol))
+ (point))))
+ (if (checkdoc-y-or-n-p "There is no lexical-binding cookie! Add one?")
+ (progn
+ (goto-char pos)
+ (insert " -*- lexical-binding: t -*-"))
+ (checkdoc-create-error
+ "The first line should end with \"-*- lexical-binding: t -*-\""
+ pos (1+ pos) t)))
+ nil)))
(setq
err
(or
--
2.35.1
next prev parent reply other threads:[~2022-12-10 23:26 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-09 10:10 bug#59920: [PATCH] Make checkdoc warn if not using lexical-binding Stefan Kangas
2022-12-09 12:25 ` Eli Zaretskii
2022-12-09 12:42 ` Stefan Kangas
2022-12-09 14:52 ` Eli Zaretskii
2022-12-10 23:26 ` Stefan Kangas [this message]
2022-12-11 7:29 ` Eli Zaretskii
2022-12-12 2:21 ` Stefan Kangas
2023-09-01 20:07 ` Stefan Kangas
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CADwFkmnmZAF_fHQ1C9c-0Yw6eG5mpB7gu0jc07Ta8ep9ZH5prw@mail.gmail.com \
--to=stefankangas@gmail.com \
--cc=59920@debbugs.gnu.org \
--cc=eliz@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.