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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
;;; flycheck-checkdoc.el --- Flycheck: Checkdoc runner -*- lexical-binding: t; -*-
;; Copyright (C) 2016 Sebastian Wiesner and Flycheck contributors
;; Author: Sebastian Wiesner <swiesner@lunaryorn.com>
;; This file is not part of GNU Emacs.
;; 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 file provides checkdoc linting for Flycheck. It's intended for
;; non-interactive use, see "make checkdoc".
;;; Code:
(unless (version<= "25" emacs-version)
(user-error "Emacs 25 required for checkdoc"))
(require 'subr-x)
(require 'seq)
(require 'f)
(require 'checkdoc)
(require 'flycheck-maint
(expand-file-name "flycheck-maint"
(file-name-directory (f-this-file))))
(defconst flycheck/source-dir (locate-dominating-file load-file-name "Cask")
"The source directory of Flycheck.")
(defun flycheck/checkdoc-get-current-errors ()
"Get the current checkdoc errors.
Return a list of all error messages from checkdoc, and erase the
error message buffer, so that the next checkdoc check starts
fresh without previous errors.
Each error is just a string with the complete human-readable
location and error message."
(with-current-buffer checkdoc-diagnostic-buffer
(unwind-protect
(progn
(goto-char (point-min))
;; Skip over the checkdoc header
(re-search-forward (rx line-start "***" (1+ not-newline)
": checkdoc-current-buffer"))
(forward-line 1)
(let ((text (buffer-substring-no-properties (point) (point-max))))
(and (not (string-empty-p text))
(split-string text "\n"))))
(kill-buffer))))
(defun flycheck/checkdoc-file (filename)
"Run checkdoc on FILENAME and return a list of errors.
Each error is just a string with the complete human-readable
location and error message."
(with-temp-buffer
;; Visit the file to make sure that the filename is set, as some checkdoc
;; lints only apply for buffers with filenames
(insert-file-contents filename 'visit)
(set-buffer-modified-p nil)
;; Switch to Emacs Lisp mode to give checkdoc the proper syntax table, etc.
(delay-mode-hooks (emacs-lisp-mode))
(setq delay-mode-hooks nil)
(checkdoc-current-buffer 'take-notes)
(flycheck/checkdoc-get-current-errors)))
(defun flycheck/batch-checkdoc ()
"Run checkdoc on all source files and exit."
(let ((errors (seq-mapcat #'flycheck/checkdoc-file
(flycheck/all-source-files))))
(seq-do (lambda (err) (message "%s" err)) errors)
(kill-emacs (if errors 1 0))))
;;; flycheck-checkdoc.el ends here
|
