diff options
| author | Stefan Kangas <stefan@marxist.se> | 2021-09-26 01:20:55 +0200 |
|---|---|---|
| committer | Stefan Kangas <stefan@marxist.se> | 2021-09-28 01:12:36 +0200 |
| commit | 3cabf64131b93e1b0510a01bcce8efde38b20bc4 (patch) | |
| tree | 5f4cc8d403d690e614f799214df31ff58ac6b6bc /lisp | |
| parent | 6bec21243d20df015875ee8576bc722224480acb (diff) | |
| download | emacs-3cabf64131b93e1b0510a01bcce8efde38b20bc4.tar.gz emacs-3cabf64131b93e1b0510a01bcce8efde38b20bc4.tar.bz2 emacs-3cabf64131b93e1b0510a01bcce8efde38b20bc4.zip | |
checkdoc: Allow Lisp symbols to start a message
* lisp/emacs-lisp/checkdoc.el (checkdoc-message-text-engine): Allow
Lisp symbols to start a message.
(checkdoc--error-bad-format-p): New helper function.
* test/lisp/emacs-lisp/checkdoc-tests.el
(checkdoc-test-error-format-is-good)
(checkdoc-test-error-format-is-bad): New helper functions.
(checkdoc-tests-error-message-bad-format-p)
(checkdoc-tests-error-message-bad-format-p/defined-symbols)
(checkdoc-tests-error-message-bad-format-p/not-capitalized):
New tests.
Diffstat (limited to 'lisp')
| -rw-r--r-- | lisp/emacs-lisp/checkdoc.el | 37 |
1 files changed, 30 insertions, 7 deletions
diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el index b3707bb7863..5ea2f59ee60 100644 --- a/lisp/emacs-lisp/checkdoc.el +++ b/lisp/emacs-lisp/checkdoc.el @@ -164,6 +164,7 @@ (require 'cl-lib) (require 'help-mode) ;; for help-xref-info-regexp (require 'thingatpt) ;; for handy thing-at-point-looking-at +(require 'lisp-mode) ;; for lisp-mode-symbol-regexp (require 'dired) ;; for dired-get-filename and dired-map-over-marks (require 'lisp-mnt) @@ -2575,6 +2576,30 @@ Argument END is the maximum bounds to search in." (setq return type)))) return)) +(defun checkdoc--error-bad-format-p () + "Return non-nil if the start of error message at point has the wrong format. +The correct format is \"Foo\" or \"some-symbol: Foo\". See also +`error' and Info node `(elisp) Documentation Tips'." + (save-excursion + ;; Skip the first quote character in string. + (forward-char 1) + ;; A capital letter is always okay. + (unless (let ((case-fold-search nil)) + (looking-at (rx (or upper-case "%s")))) + ;; A defined Lisp symbol is always okay. + (unless (and (looking-at (rx (group (regexp lisp-mode-symbol-regexp)))) + (or (fboundp (intern (match-string 1))) + (boundp (intern (match-string 1))))) + ;; Other Lisp symbols are sometimes okay. + (rx-let ((c (? "\\\n"))) ; `c' is for a continued line + (let ((case-fold-search nil) + (some-symbol (rx (regexp lisp-mode-symbol-regexp) + c ":" c (+ (any " \t\n")))) + (lowercase-str (rx c (group (any "a-z") (+ wordchar))))) + (if (looking-at some-symbol) + (looking-at (concat some-symbol lowercase-str)) + (looking-at lowercase-str)))))))) + (defun checkdoc--fix-y-or-n-p () "Fix `y-or-n-p' prompt to end with \"?\" or \"? \". The space is technically redundant, but also more compatible with @@ -2622,16 +2647,14 @@ Argument TYPE specifies the type of question, such as `error' or `y-or-n-p'." ;; In Emacs, the convention is that error messages start with a capital ;; letter but *do not* end with a period. Please follow this convention ;; for the sake of consistency. - (if (and (save-excursion (forward-char 1) - (looking-at "[a-z]\\w+")) + (if (and (checkdoc--error-bad-format-p) (not (checkdoc-autofix-ask-replace - (match-beginning 0) (match-end 0) + (match-beginning 1) (match-end 1) "Capitalize your message text?" - (capitalize (match-string 0)) + (capitalize (match-string 1)) t))) - (checkdoc-create-error - "Messages should start with a capital letter" - (match-beginning 0) (match-end 0)) + (checkdoc-create-error "Messages should start with a capital letter" + (match-beginning 1) (match-end 1)) nil) ;; In general, sentences should have two spaces after the period. (checkdoc-sentencespace-region-engine (point) |