You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
88 lines
3.2 KiB
88 lines
3.2 KiB
;;; 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)
|
|
(let ((checkdoc-arguments-in-order-flag 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
|