all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
blob b3cc943ac0892b195efc21fd0979b0e523ec0999 2210 bytes (raw)
name: test/lisp/emacs-lisp/checkdoc-tests.el 	 # note: path name is non-authoritative(*)

 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
 
;;; checkdoc-tests.el --- unit tests for checkdoc.el  -*- lexical-binding: t; -*-

;; Copyright (C) 2016-2019 Free Software Foundation, Inc.

;; Author: Philipp Stephani <phst@google.com>

;; This file is part of GNU Emacs.

;; GNU Emacs 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.

;; GNU Emacs 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 GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.

;;; Commentary:

;; Unit tests for lisp/emacs-lisp/checkdoc.el.

;;; Code:

(require 'checkdoc)

(require 'elisp-mode)
(require 'ert)

(ert-deftest checkdoc-tests--bug-24998 ()
  "Checks that Bug#24998 is fixed."
  (with-temp-buffer
    (emacs-lisp-mode)
    (insert "(defun foo())")
    (should-error (checkdoc-defun) :type 'user-error)))

(ert-deftest checkdoc-tests--next-docstring ()
  "Checks that the one-argument form of `defvar' works.
See the comments in Bug#24998."
  (with-temp-buffer
    (emacs-lisp-mode)
    (insert "(defvar foo)
\(defvar foo bar \"baz\")
\(require 'foo)")
    (goto-char (point-min))
    (should (checkdoc-next-docstring))
    (should (looking-at-p "\"baz\")"))
    (should-not (checkdoc-next-docstring))))

(ert-deftest checkdoc-tests--cl-defun ()
  "Identify formal arguments from arbitary lisp code."
  (with-temp-buffer
    (let ((checkdoc-autofix-flag 'never))
      (emacs-lisp-mode)
      (insert "(cl-defun foo(&key bar &aux (baz (baz bar))) \"BAR BAZ.\")")
      (should-not (checkdoc-defun)))))

(ert-deftest checkdoc-tests--cl-defmethod ()
  "Identify formal arguments from object types."
  (with-temp-buffer
    (let ((checkdoc-autofix-flag 'never))
      (emacs-lisp-mode)
      (insert "(cl-defmethod foo((a list)) \"Return A.\")")
      (should-not (checkdoc-defun)))))

;;; checkdoc-tests.el ends here

debug log:

solving b3cc943ac0 ...
found b3cc943ac0 in https://yhetil.org/emacs/87sgodiv57.fsf@dick/
found 1cefc4c366 in https://git.savannah.gnu.org/cgit/emacs.git
preparing index
index prepared:
100644 1cefc4c36628e60910c8d09b1eac9c5596ae1ebc	test/lisp/emacs-lisp/checkdoc-tests.el

applying [1/1] https://yhetil.org/emacs/87sgodiv57.fsf@dick/
diff --git a/test/lisp/emacs-lisp/checkdoc-tests.el b/test/lisp/emacs-lisp/checkdoc-tests.el
index 1cefc4c366..b3cc943ac0 100644

Checking patch test/lisp/emacs-lisp/checkdoc-tests.el...
Applied patch test/lisp/emacs-lisp/checkdoc-tests.el cleanly.

index at:
100644 b3cc943ac0892b195efc21fd0979b0e523ec0999	test/lisp/emacs-lisp/checkdoc-tests.el

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

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.