| blob | 59edbe100e15a6dafa73d73f54a62f681dcb8043 |
1 ;;; checkdoc.el --- check documentation strings for style requirements -*- lexical-binding:t -*-
3 ;; Copyright (C) 1997-1998, 2001-2017 Free Software Foundation, Inc.
5 ;; Author: Eric M. Ludlam <zappo@gnu.org>
6 ;; Version: 0.6.2
7 ;; Keywords: docs, maint, lisp
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
25 ;;
26 ;; The Emacs Lisp manual has a nice chapter on how to write
27 ;; documentation strings. Many stylistic suggestions are fairly
28 ;; deterministic and easy to check for syntactically, but also easy
29 ;; to forget. The main checkdoc engine will perform the stylistic
30 ;; checks needed to make sure these styles are remembered.
31 ;;
32 ;; There are two ways to use checkdoc:
33 ;; 1) Periodically use `checkdoc' or `checkdoc-current-buffer'.
34 ;; `checkdoc' is a more interactive version of
35 ;; `checkdoc-current-buffer'
36 ;; 2) Use `checkdoc-minor-mode' to automatically check your
37 ;; documentation whenever you evaluate Lisp code with C-M-x
38 ;; or [menu-bar emacs-lisp eval-buffer]. Additional key-bindings
39 ;; are also provided under C-c ? KEY
40 ;; (require 'checkdoc)
41 ;; (add-hook 'emacs-lisp-mode-hook 'checkdoc-minor-mode)
42 ;;
43 ;; Using `checkdoc':
44 ;;
45 ;; The commands `checkdoc' and `checkdoc-ispell' are the top-level
46 ;; entry points to all of the different checks that are available. It
47 ;; breaks examination of your Lisp file into four sections (comments,
48 ;; documentation, messages, and spacing) and indicates its current
49 ;; state in a status buffer.
50 ;;
51 ;; The Comments check examines your headers, footers, and
52 ;; various tags (such as "Code:") to make sure that your code is ready
53 ;; for easy integration into existing systems.
54 ;;
55 ;; The Documentation check deals with documentation strings
56 ;; and their elements that help make Emacs easier to use.
57 ;;
58 ;; The Messages check ensures that the strings displayed in the
59 ;; minibuffer by some commands (such as `error' and `y-or-n-p')
60 ;; are consistent with the Emacs environment.
61 ;;
62 ;; The Spacing check cleans up white-space at the end of lines.
63 ;;
64 ;; The interface while working with documentation and messages is
65 ;; slightly different when being run in the interactive mode. The
66 ;; interface offers several options, including the ability to skip to
67 ;; the next error, or back up to previous errors. Auto-fixing is
68 ;; turned off at this stage, but you can use the `f' or `F' key to fix
69 ;; a given error (if the fix is available.)
70 ;;
71 ;; Auto-fixing:
72 ;;
73 ;; There are four classifications of style errors in terms of how
74 ;; easy they are to fix. They are simple, complex, really complex,
75 ;; and impossible. (Impossible really means that checkdoc does not
76 ;; have a fixing routine yet.) Typically white-space errors are
77 ;; classified as simple, and are auto-fixed by default. Typographic
78 ;; changes are considered complex, and the user is asked if they want
79 ;; the problem fixed before checkdoc makes the change. These changes
80 ;; can be done without asking if `checkdoc-autofix-flag' is properly
81 ;; set. Potentially redundant changes are considered really complex,
82 ;; and the user is always asked before a change is inserted. The
83 ;; variable `checkdoc-autofix-flag' controls how these types of errors
84 ;; are fixed.
85 ;;
86 ;; Spell checking text:
87 ;;
88 ;; The variable `checkdoc-spellcheck-documentation-flag' can be set
89 ;; to customize how spell checking is to be done. Since spell
90 ;; checking can be quite slow, you can optimize how best you want your
91 ;; checking done. The default is `defun', which spell checks each time
92 ;; `checkdoc-defun' or `checkdoc-eval-defun' is used. Setting to nil
93 ;; prevents spell checking during normal usage.
94 ;; Setting this variable to nil does not mean you cannot take
95 ;; advantage of the spell checking. You can instead use the
96 ;; interactive functions `checkdoc-ispell-*' to check the spelling of
97 ;; your documentation.
98 ;; There is a list of Lisp-specific words which checkdoc will
99 ;; install into Ispell on the fly, but only if Ispell is not already
100 ;; running. Use `ispell-kill-ispell' to make checkdoc restart it with
101 ;; these words enabled.
102 ;;
103 ;; Checking parameters:
104 ;;
105 ;; You might not always want a function to have its parameters listed
106 ;; in order. When this is the case, put the following comment just in
107 ;; front of the documentation string: "; checkdoc-order: nil" This
108 ;; overrides the value of `checkdoc-arguments-in-order-flag'.
109 ;;
110 ;; If you specifically wish to avoid mentioning a parameter of a
111 ;; function in the doc string (such as a hidden parameter, or a
112 ;; parameter which is very obvious like events), you can have checkdoc
113 ;; skip looking for it by putting the following comment just in front
114 ;; of the documentation string: "; checkdoc-params: (args go here)"
115 ;;
116 ;; Checking message strings:
117 ;;
118 ;; The text that follows the `error' and `y-or-n-p' commands is
119 ;; also checked. The documentation for `error' clearly states some
120 ;; simple style rules to follow which checkdoc will auto-fix for you.
121 ;; `y-or-n-p' also states that it should end in a space. I added that
122 ;; it should end in "? " since that is almost always used.
123 ;;
124 ;; Adding your own checks:
125 ;;
126 ;; You can experiment with adding your own checks by setting the
127 ;; hooks `checkdoc-style-functions' and `checkdoc-comment-style-functions'.
128 ;; Return a string which is the error you wish to report. The cursor
129 ;; position should be preserved.
130 ;;
131 ;; Error errors:
132 ;;
133 ;; Checkdoc does not always flag errors correctly. There are a
134 ;; couple ways you can coax your file into passing all of checkdoc's
135 ;; tests through buffer local variables.
136 ;;
137 ;; The variable `checkdoc-verb-check-experimental-flag' can be used
138 ;; to turn off the check for verb-voice in case you use words that are
139 ;; not semantically verbs, but are still in the incomplete list.
140 ;;
141 ;; The variable `checkdoc-symbol-words' can be a list of words that
142 ;; happen to also be symbols. This is not a problem for one-word
143 ;; symbols, but if you use a hyphenated word that is also a symbol,
144 ;; then you may need this.
145 ;;
146 ;; The symbol `checkdoc-force-docstrings-flag' can be set to nil if
147 ;; you have many undocumented functions you don't wish to document.
148 ;;
149 ;; See the above section "Checking Parameters" for details about
150 ;; parameter checking.
151 ;;
152 ;; Dependencies:
153 ;;
154 ;; This file requires lisp-mnt (Lisp maintenance routines) for the
155 ;; comment checkers.
156 ;;
157 ;; Requires custom for Emacs v20.
159 ;;; TO DO:
160 ;; Hook into the byte compiler on a defun/defvar level to generate
161 ;; warnings in the byte-compiler's warning/error buffer.
162 ;; Better ways to override more typical `eval' functions. Advice
163 ;; might be good but hard to turn on/off as a minor mode.
164 ;;
165 ;;; Maybe Do:
166 ;; Code sweep checks for "forbidden functions", proper use of hooks,
167 ;; proper keybindings, and other items from the manual that are
168 ;; not specifically docstring related. Would this even be useful?
170 ;;; Code:
181 "Support for doc string checking in Emacs Lisp."
187 "String to display in mode line when Checkdoc mode is enabled; nil for none."
192 "Non-nil means attempt auto-fixing of doc strings.
193 If this value is the symbol `query', then the user is queried before
194 any change is made. If the value is `automatic', then all changes are
195 made without asking unless the change is very-complex. If the value
196 is `semiautomatic' or any other value, then simple fixes are made
197 without asking, and complex changes are made by asking the user first.
198 The value `never' is the same as nil, never ask or change anything."
206 Setting this to nil will silently make fixes that require no user
207 interaction. See `checkdoc-autofix-flag' for auto-fixing details."
211 "Non-nil means that all checkable definitions should have documentation.
212 Style guide dictates that interactive functions MUST have documentation,
213 and that it's good but not required practice to make non user visible items
214 have doc strings."
216 ;;;###autoload(put 'checkdoc-force-docstrings-flag 'safe-local-variable #'booleanp)
219 "Non-nil means that files should have a History section or ChangeLog file.
220 This helps document the evolution of, and recent changes to, the package."
222 ;;;###autoload(put 'checkdoc-force-history-flag 'safe-local-variable #'booleanp)
225 "Non-nil means the first line of a docstring may end with a comma.
226 Ordinarily, a full sentence is required. This may be misleading when
227 there is a substantial caveat to the one-line description -- the comma
228 should be used when the first part could stand alone as a sentence, but
229 it indicates that a modifying clause follows."
231 ;;;###autoload(put 'checkdoc-permit-comma-termination-flag 'safe-local-variable #'booleanp)
234 "Non-nil means run Ispell on text based on value.
235 This is automatically set to nil if Ispell does not exist on your
236 system. Possible values are:
238 nil - Don't spell-check during basic style checks.
239 defun - Spell-check when style checking a single defun
240 buffer - Spell-check when style checking the whole buffer
241 interactive - Spell-check during any interactive check.
242 t - Always spell-check"
248 ;;;###autoload(put 'checkdoc-spellcheck-documentation-flag 'safe-local-variable #'booleanp)
253 ;;;###autoload(put 'checkdoc-ispell-list-words 'safe-local-variable #'checkdoc-list-of-strings-p)
257 Any more than this and a warning is generated suggesting that the construct
262 "Non-nil means warn if arguments appear out of order.
263 Setting this to nil will mean only checking that all the arguments
264 appear in the proper form in the documentation, not that they are in
265 the same order as they appear in the argument list. No mention is
266 made in the style guide relating to order."
268 ;;;###autoload(put 'checkdoc-arguments-in-order-flag 'safe-local-variable #'booleanp)
271 "Non-nil means warn if this file's package keywords are not recognized.
272 Currently, all recognized keywords must be on `finder-known-keywords'."
279 "Hook run after the standard style check is completed.
280 All functions must return nil or a string representing the error found.
281 Useful for adding new user implemented commands.
283 Each hook is called with two parameters, (DEFUNINFO ENDPOINT).
284 DEFUNINFO is the return value of `checkdoc-defun-info'. ENDPOINT is the
290 "Hook run after the standard comment style check is completed.
291 Must return nil if no errors are found, or a string describing the
298 "Non-nil means to attempt to check the voice of the doc string.
299 This check keys off some words which are commonly misused. See the
300 variable `checkdoc-common-verbs-wrong-voice' if you wish to add your own."
302 ;;;###autoload(put 'checkdoc-verb-check-experimental-flag 'safe-local-variable #'booleanp)
305 "Non-nil means generate warnings in a buffer for browsing.
306 Do not set this by hand, use a function like `checkdoc-current-buffer'
310 "A list of symbol names (strings) which also happen to make good words.
311 These words are ignored when unquoted symbols are searched for.
312 This should be set in an Emacs Lisp file's local variables."
314 ;;;###autoload(put 'checkdoc-symbol-words 'safe-local-variable #'checkdoc-list-of-strings-p)
316 ;;;###autoload
318 "Return t when OBJ is a list of strings."
319 ;; this is a function so it might be shared by checkdoc-proper-noun-list
320 ;; and/or checkdoc-ispell-lisp-words in the future
329 ;; "[.!?]" is for noun at end of a sentence, since those chars
330 ;; are symbol syntax in emacs-lisp-mode and so don't match \\_>.
331 ;; The \" allows it to be the last sentence in a docstring too.
336 ;;;###autoload(put 'checkdoc-proper-noun-regexp 'safe-local-variable 'stringp)
340 ;;;###autoload(put 'checkdoc-common-verbs-regexp 'safe-local-variable 'stringp)
422 )
423 "Alist of common words in the wrong voice and what should be used instead.
424 Set `checkdoc-verb-check-experimental-flag' to nil to avoid this costly
425 and experimental check. Do not modify this list without setting
426 the value of `checkdoc-common-verbs-regexp' to nil which cause it to
431 ;; When dealing with syntax in doc strings, make sure that - are
432 ;; encompassed in words so we can use cheap \\> to get the end of a symbol,
433 ;; not the end of a word in a conglomerate.
435 st)
438 ;;; Compatibility
439 ;;
455 ;;; User level commands
456 ;;
457 ;;;###autoload
459 "Interactively check the entire buffer for style errors.
460 The current status of the check will be displayed in a buffer which
461 the users will view as each check is completed."
467 ;; if the user set autofix to never, then that breaks the
468 ;; obviously requested asking implied by using this function.
469 ;; Set it to paranoia level.
472 'query
473 checkdoc-autofix-flag))
474 tmp)
476 ;; check the comments
484 ;; Check the documentation
491 ;; Check the message text
497 ;; Rogue spacing
506 "Display and update the status buffer for the current checkdoc mode.
507 CHECK is a list of four strings stating the current status of each
508 test; the nth string describes the status of the nth test."
521 ;;;###autoload
523 "Interactively check the current buffer for doc string errors.
524 Prefix argument START-HERE will start the checking from the current
525 point, otherwise the check starts at the beginning of the current
526 buffer. Allows navigation forward and backwards through document
527 errors. Does not check for comment or space warnings.
528 Optional argument SHOWSTATUS indicates that we should update the
529 checkdoc status window instead of the usual behavior."
535 ;; Due to a design flaw, this will never spell check
536 ;; docstrings.
539 ;; This is a workaround to perform spell checking.
542 ;;;###autoload
544 "Interactively check the current buffer for message string errors.
545 Prefix argument START-HERE will start the checking from the current
546 point, otherwise the check starts at the beginning of the current
547 buffer. Allows navigation forward and backwards through document
548 errors. Does not check for comment or space warnings.
549 Optional argument SHOWSTATUS indicates that we should update the
550 checkdoc status window instead of the usual behavior."
556 ;; Due to a design flaw, this will never spell check messages.
559 ;; This is a workaround to perform spell checking.
563 "Interactively loop over all errors that can be found by a given method.
565 If START-HERE is nil, searching starts at the beginning of the current
566 buffer, otherwise searching starts at START-HERE. SHOWSTATUS
567 expresses the verbosity of the search, and whether ending the search
568 will auto-exit this function.
570 FINDFUNC is a symbol representing a function that will position the
571 cursor, and return error message text to present to the user. It is
572 assumed that the cursor will stop just before a major sexp, which will
573 be highlighted to present the user with feedback as to the offending
574 style."
575 ;; Determine where to start the test
578 ;; Assign a flag to spellcheck flag
582 ;; Fetch the error list
586 c)
589 ;; Include whatever function point is in for good measure.
593 ;; The cursor should be just in front of the offending doc string
604 ;; Make sure the whole doc string is visible if possible.
628 ;; Exit condition
630 ;; Request an auto-fix
635 ;; `automatic-then-never' tells the autofix function
636 ;; to only allow one fix to be automatic. The autofix
637 ;; function will then set the flag to `never', allowing
638 ;; the checker to return a different error.
660 ;; Move to the next error (if available)
666 err-list nil)
672 ;; Go backwards in the list of errors
681 ;; Edit the buffer recursively.
692 err-list nil)
696 ;; Quit checkdoc
699 err-list nil
701 ;; Goofy stuff
712 ""
714 "f, y - auto Fix this warning without asking (if\
717 )
729 returnme))
732 "Interactively spell check doc strings in the current buffer.
733 If START-HERE is nil, searching starts at the beginning of the current
734 buffer, otherwise searching starts at START-HERE."
737 ;; Move point to where we need to start.
739 ;; Include whatever function point is in for good measure.
742 ;; Loop over docstrings.
752 "Interactively spell check messages in the current buffer.
753 If START-HERE is nil, searching starts at the beginning of the current
754 buffer, otherwise searching starts at START-HERE."
757 ;; Move point to where we need to start.
759 ;; Include whatever function point is in for good measure.
762 ;; Loop over message strings.
773 "Find and return the next checkdoc error list, or nil.
774 Only documentation strings are checked.
775 An error list is of the form (WARNING . POSITION) where WARNING is the
776 warning text, and POSITION is the point in the buffer where the error
777 was found. We can use points and not markers because we promise not
778 to edit the buffer before point without re-executing this check.
779 Argument ENABLE-FIX will enable auto-fixing while looking for the next
780 error. This argument assumes that the cursor is already positioned to
781 perform the fix."
792 ;; Quit.. restore position, Other errors, leave alone
794 msg)))
797 "Find and return the next checkdoc message related error list, or nil.
798 Only text for error and `y-or-n-p' strings are checked. See
799 `checkdoc-next-error' for details on the return value.
800 Argument ENABLE-FIX turns on the auto-fix feature. This argument
801 assumes that the cursor is already positioned to perform the fix."
814 ;; Quit.. restore position, Other errors, leave alone
816 msg)))
819 "Enter recursive edit to permit a user to fix some error checkdoc has found.
820 MSG is the error that was found, which is displayed in a help buffer."
835 ;;;###autoload
837 "Evaluate and check documentation for the current buffer.
838 Evaluation is done first because good documentation for something that
839 doesn't work is just not useful. Comments, doc strings, and rogue
840 spacing are all verified."
845 ;;;###autoload
847 "Check current buffer for document, comment, error style, and rogue spaces.
848 With a prefix argument (in Lisp, the argument TAKE-NOTES),
849 store all errors found in a warnings buffer,
850 otherwise stop after the first error."
854 ;; Assign a flag to spellcheck flag
859 checkdoc-autofix-flag))
864 ;; every test is responsible for returning the cursor.
876 ;;;###autoload
878 "Check FILE for document, comment, error style, and rogue spaces."
883 ;;;###autoload
885 "Start scanning the current buffer for documentation string style errors.
886 Only documentation strings are checked.
887 Use `checkdoc-continue' to continue checking if an error cannot be fixed.
888 Prefix argument TAKE-NOTES means to collect all the warning messages into
889 a separate buffer."
896 ;; Go back since we can't be here without success above.
898 nil))
900 ;;;###autoload
902 "Find the next doc string in the current buffer which has a style error.
903 Prefix argument TAKE-NOTES means to continue through the whole buffer and
904 save warnings in a separate buffer. Second optional argument START-POINT
905 is the starting location. If this is nil, `point-min' is used instead."
908 ;; Assign a flag to spellcheck flag
913 checkdoc-autofix-flag))
917 ;; If we are taking notes, encompass the whole buffer, otherwise
918 ;; the user is navigating down through the buffer.
920 ;; OK, let's look at the doc string.
933 "Move to the next doc string after point, and return t.
934 Return nil if there are no more doc strings."
938 found))
941 "When looking at a definition with a doc string, find it.
942 Move to the next doc string after point, and return t. When not
943 looking at a definition containing a doc string, return nil and
944 don't move point."
947 ;; Conservatively skip syntax errors.
951 ;; Require an initializer, i.e. ignore single-argument `defvar'
952 ;; forms, which never have a doc string.
955 ;; Skip over function or macro name, symbol to be defined, and
956 ;; initializer or argument list.
959 t)))
961 ;;;###autoload
963 "Find missing comment sections in the current Emacs Lisp file.
964 Prefix argument TAKE-NOTES non-nil means to save warnings in a
965 separate buffer. Otherwise print a message. This returns the error
966 if there is one."
980 e))
982 ;;;###autoload
984 "Find extra spaces at the end of lines in the current file.
985 Prefix argument TAKE-NOTES non-nil means to save warnings in a
986 separate buffer. Otherwise print a message. This returns the error
987 if there is one.
988 Optional argument INTERACT permits more interactive fixing."
996 e
1002 ;;;###autoload
1004 "Scan the buffer for occurrences of the error function, and verify text.
1005 Optional argument TAKE-NOTES causes all errors to be logged."
1014 e
1022 ;;;###autoload
1024 "Evaluate the current form with `eval-defun' and check its documentation.
1025 Evaluation is done first so the form will be read before the
1026 documentation is checked. If there is a documentation error, then the display
1027 of what was evaluated will be overwritten by the diagnostic message."
1032 ;;;###autoload
1034 "Examine the doc string of the function or variable under point.
1035 Call `error' if the doc string has problems. If NO-ERROR is
1036 non-nil, then do not call error, but call `message' instead.
1037 If the doc string passes the test, then check the function for rogue white
1038 space at the end of each line."
1058 ;;; Ispell interface for forcing a spell check
1059 ;;
1061 ;;;###autoload
1063 "Check the style and spelling of everything interactively.
1064 Calls `checkdoc' with spell-checking turned on.
1065 Prefix argument is the same as for `checkdoc'"
1070 ;;;###autoload
1072 "Check the style and spelling of the current buffer.
1073 Calls `checkdoc-current-buffer' with spell-checking turned on.
1074 Prefix argument is the same as for `checkdoc-current-buffer'"
1079 ;;;###autoload
1081 "Check the style and spelling of the current buffer interactively.
1082 Calls `checkdoc-interactive' with spell-checking turned on.
1083 Prefix argument is the same as for `checkdoc-interactive'"
1088 ;;;###autoload
1090 "Check the style and spelling of message text interactively.
1091 Calls `checkdoc-message-interactive' with spell-checking turned on.
1092 Prefix argument is the same as for `checkdoc-message-interactive'"
1096 nil current-prefix-arg)))
1098 ;;;###autoload
1100 "Check the style and spelling of message text interactively.
1101 Calls `checkdoc-message-text' with spell-checking turned on.
1102 Prefix argument is the same as for `checkdoc-message-text'"
1107 ;;;###autoload
1109 "Check the style and spelling of the current buffer.
1110 Calls `checkdoc-start' with spell-checking turned on.
1111 Prefix argument is the same as for `checkdoc-start'"
1116 ;;;###autoload
1118 "Check the style and spelling of the current buffer after point.
1119 Calls `checkdoc-continue' with spell-checking turned on.
1120 Prefix argument is the same as for `checkdoc-continue'"
1125 ;;;###autoload
1127 "Check the style and spelling of the current buffer's comments.
1128 Calls `checkdoc-comments' with spell-checking turned on.
1129 Prefix argument is the same as for `checkdoc-comments'"
1134 ;;;###autoload
1136 "Check the style and spelling of the current defun with Ispell.
1137 Calls `checkdoc-defun' with spell-checking turned on.
1138 Prefix argument is the same as for `checkdoc-defun'"
1143 ;;; Error Management
1144 ;;
1145 ;; Errors returned from checkdoc functions can have various
1146 ;; features and behaviors, so we need some ways of specifying
1147 ;; them, and making them easier to use in the wacked-out interfaces
1148 ;; people are requesting
1150 "Used to create the return error text returned from all engines.
1151 TEXT is the descriptive text of the error. START and END define the region
1152 it is sensible to highlight when describing the problem.
1153 Optional argument UNFIXABLE means that the error has no auto-fix available.
1155 A list of the form (TEXT START END UNFIXABLE) is returned if we are not
1156 generating a buffered list of errors."
1159 nil)
1163 "Return the text specified in the checkdoc ERR."
1164 ;; string-p part is for backwards compatibility
1168 "Return the start point specified in the checkdoc ERR."
1169 ;; string-p part is for backwards compatibility
1173 "Return the end point specified in the checkdoc ERR."
1174 ;; string-p part is for backwards compatibility
1178 "Return the t if we cannot autofix the error specified in the checkdoc ERR."
1179 ;; string-p part is for backwards compatibility
1182 ;;; Minor Mode specification
1183 ;;
1188 ;; Override some bindings
1194 ;; Add some new bindings under C-c ?
1212 ;; bind our submap into map
1214 map)
1217 ;; Add in a menubar with easy-menu
1220 nil checkdoc-minor-mode-map "Checkdoc Minor Mode Menu"
1226 "---"
1235 checkdoc-ispell-message-interactive t]
1240 buffer-file-name]
1242 "---"
1247 ))
1248 ;; XEmacs requires some weird stuff to add this menu in a minor mode.
1249 ;; What is it?
1251 ;;;###autoload
1253 "Toggle automatic docstring checking (Checkdoc minor mode).
1254 With a prefix argument ARG, enable Checkdoc minor mode if ARG is
1255 positive, and disable it otherwise. If called from Lisp, enable
1256 the mode if ARG is omitted or nil.
1258 In Checkdoc minor mode, the usual bindings for `eval-defun' which is
1259 bound to \\<checkdoc-minor-mode-map>\\[checkdoc-eval-defun] and `checkdoc-eval-current-buffer' are overridden to include
1260 checking of documentation strings.
1263 nil checkdoc-minor-mode-string nil
1266 ;;; Subst utils
1267 ;;
1269 "Run hooks in HOOKVAR with ARGS."
1272 ;; This method was similar to above. We ignore the warning
1273 ;; since we will use the above for future Emacs versions
1277 "Rebuild the contents of `checkdoc-common-verbs-regexp'."
1285 ;; Profiler says this is not yet faster than just calling assoc
1286 ;;(defun checkdoc-word-in-alist-vector (word vector)
1287 ;; "Check to see if WORD is in the car of an element of VECTOR.
1288 ;;VECTOR must be sorted. The CDR should be a replacement. Since the
1289 ;;word list is getting bigger, it is time for a quick bisecting search."
1290 ;; (let ((max (length vector)) (min 0) i
1291 ;; (found nil) (fw nil))
1292 ;; (setq i (/ max 2))
1293 ;; (while (and (not found) (/= min max))
1294 ;; (setq fw (car (aref vector i)))
1295 ;; (cond ((string= word fw) (setq found (cdr (aref vector i))))
1296 ;; ((string< word fw) (setq max i))
1297 ;; (t (setq min i)))
1298 ;; (setq i (/ (+ max min) 2))
1299 ;; )
1300 ;; found))
1302 ;;; Checking engines
1303 ;;
1305 "Return a message string if the current doc string is invalid.
1306 Check for style only, such as the first line always being a complete
1307 sentence, whitespace restrictions, and making sure there are no
1308 hard-coded key-codes such as C-[char] or mouse-[number] in the comment.
1309 See the style guide in the Emacs Lisp manual for more details."
1311 ;; Jump over comments between the last object and the doc string
1320 err
1321 ;; * Every command, function, or variable intended for users to know
1322 ;; about should have a documentation string.
1323 ;;
1324 ;; * An internal variable or subroutine of a Lisp program might as well
1325 ;; have a documentation string. In earlier Emacs versions, you could
1326 ;; save space by using a comment instead of a documentation string,
1327 ;; but that is no longer the case.
1332 ;; Sometimes old code has comments where the documentation should
1333 ;; be. Let's see if we can find the comment, and offer to turn it
1334 ;; into documentation for them.
1350 ;; Our point is at the beginning of the comment!
1351 ;; Insert a quote, then remove the comment chars.
1370 ;; quote any double-quote characters in the comment.
1376 "You should convert this comment to documentation"
1380 "All interactive functions should have documentation"
1381 "All variables and subroutines might as well have a \
1387 err)))
1390 "Return an error list or string if the current doc string is invalid.
1391 Depends on `checkdoc-this-string-valid' to reset the syntax table so that
1392 regexp short cuts work. FP is the function defun information."
1394 ;; Use a marker so if an early check modifies the text,
1395 ;; we won't accidentally lose our place. This could cause
1396 ;; end-of doc string whitespace to also delete the " char.
1402 ;; * *Do not* indent subsequent lines of a documentation string so that
1403 ;; the text is lined up in the source code with the text of the first
1404 ;; line. This looks nice in the source code, but looks bizarre when
1405 ;; users view the documentation. Remember that the indentation
1406 ;; before the starting double-quote is not part of the string!
1414 "Remove this whitespace? "
1416 nil
1418 "Second line should not have indentation"
1421 ;; * Check for '(' in column 0.
1428 nil
1430 "Open parenthesis in column 0 should be escaped"
1432 ;; * Do not start or end a documentation string with whitespace.
1445 nil
1447 "Documentation strings should not start or end with whitespace"
1448 start end))))
1449 ;; * The first line of the documentation string should consist of one
1450 ;; or two complete sentences that stand on their own as a summary.
1451 ;; `M-x apropos' displays just the first line, and if it doesn't
1452 ;; stand on its own, the result looks bad. In particular, start the
1453 ;; first line with a capital letter and end with a period.
1461 ;; A backslashed double quote at the end of a sentence
1463 ;; We might have to add a period in this case
1466 nil
1471 nil
1473 "First sentence should end with punctuation"
1476 ;; These are ok
1477 nil)
1479 nil)
1481 ;; If it is not a complete sentence, let's see if we can
1482 ;; predict a clever way to make it one.
1487 ;; Here we have found a complete sentence, but no break.
1490 "First line not a complete sentence. Add RET here? "
1501 ;; We can merge these lines! Replace this CR
1502 ;; with a space.
1505 ;; Let's see if there is enough room to draw the next
1506 ;; line's sentence up here. I often get hit w/
1507 ;; auto-fill moving my words around.
1517 "1st line not a complete sentence. Join these lines? "
1520 ;; They said yes. We have more fill work to do...
1529 ;; Continuation of above. Make sure our sentence is capitalized.
1536 t)
1537 nil
1539 "First line should be capitalized"
1541 nil))
1542 ;; * Don't write key sequences directly in documentation strings.
1543 ;; Instead, use the `\\[...]' construct to stand for them.
1548 ;; Find the first key sequence not in a sample
1558 ;; It is not practical to use `\\[...]' very many times, because
1559 ;; display of the documentation string will become slow. So use this
1560 ;; to describe the most important commands in your major mode, and
1561 ;; then use `\\{...}' to display the rest of the mode's keymap.
1569 ;; Ambiguous quoted symbol. When a symbol is both bound and fbound,
1570 ;; and is referred to in documentation, it should be prefixed with
1571 ;; something to disambiguate it. This check must be before the
1572 ;; 80 column check because it will probably break that.
1591 ;; We didn't actually replace anything. Here we find
1592 ;; out what special word form they wish to use as
1593 ;; a prefix.
1596 "Disambiguating Keyword (default variable): "
1608 nil)))
1609 ;; * Format the documentation string so that it fits in an
1610 ;; Emacs window on an 80-column screen. It is a good idea
1611 ;; for most lines to be no wider than 60 characters. The
1612 ;; first line can be wider if necessary to fit the
1613 ;; information that ought to be there.
1622 eol t))
1628 "Some lines are over 80 columns wide"
1630 ;; Here we deviate to tests based on a variable or function.
1631 ;; We must do this before checking for symbols in quotes because there
1632 ;; is a chance that just such a symbol might really be an argument.
1634 ;; This is if we are in a variable
1636 ;; * The documentation string for a variable that is a
1637 ;; yes-or-no flag should start with words such as Non-nil
1638 ;; means..., to make it clear that all non-nil values are
1639 ;; equivalent and indicate explicitly what nil and non-nil
1640 ;; mean.
1641 ;; * If a user option variable records a true-or-false
1642 ;; condition, give it a name that ends in `-flag'.
1644 ;; "True ..." should be "Non-nil ..."
1650 nil
1655 ;; If the variable has -flag in the name, make sure
1659 "Flag variable doc strings should usually start: Non-nil means"
1661 ;; Don't rename variable to "foo-flag". This is unnecessary
1662 ;; and such names often end up inconvenient when the variable
1663 ;; is later expanded to non-boolean values. --Stef
1664 ;; If the doc string starts with "Non-nil means"
1665 ;; (if (and (looking-at "\"\\*?Non-nil\\s-+means\\s-+")
1666 ;; (not (string-match "-flag$" (car fp))))
1667 ;; (let ((newname
1668 ;; (if (string-match "-p$" (car fp))
1669 ;; (concat (substring (car fp) 0 -2) "-flag")
1670 ;; (concat (car fp) "-flag"))))
1671 ;; (if (checkdoc-y-or-n-p
1672 ;; (format
1673 ;; "Rename to %s and Query-Replace all occurrences? "
1674 ;; newname))
1675 ;; (progn
1676 ;; (beginning-of-defun)
1677 ;; (query-replace-regexp
1678 ;; (concat "\\<" (regexp-quote (car fp)) "\\>")
1679 ;; newname))
1680 ;; (checkdoc-create-error
1681 ;; "Flag variable names should normally end in `-flag'" s
1682 ;; (marker-position e)))))
1683 ;; Done with variables
1684 ))
1686 ;; This if we are in a function definition
1688 ;; * When a function's documentation string mentions the value
1689 ;; of an argument of the function, use the argument name in
1690 ;; capital letters as if it were a name for that value. Thus,
1691 ;; the documentation string of the function `/' refers to its
1692 ;; second argument as `DIVISOR', because the actual argument
1693 ;; name is `divisor'.
1695 ;; Addendum: Make sure they appear in the doc in the same
1696 ;; order that they are found in the arg list.
1707 inopts t)
1712 ;; Require whitespace OR
1713 ;; ITEMth<space> OR
1714 ;; ITEMs<space>
1716 e t)))
1719 ;; If the symbol was not found, let's see if we
1720 ;; can find it with a different capitalization
1721 ;; and see if the user wants to capitalize it.
1725 ;; Require whitespace OR
1726 ;; ITEMth<space> OR
1727 ;; ITEMs<space>
1729 e t))
1733 "If this is the argument `%s', it should appear as %s. Fix? "
1739 ;; It wasn't found at all! Offer to attach this new symbol
1740 ;; to the end of the documentation string.
1743 "Add %s documentation to end of doc string? "
1745 ;; Now do some magic and invent a doc string.
1756 nil)
1759 "Argument `%s' should appear (as %s) in the doc string"
1766 "Arguments occur in the doc string out of order"
1768 ;; * For consistency, phrase the verb in the first sentence of a
1769 ;; documentation string for functions as an imperative.
1770 ;; For instance, use `Return the cons of A and
1771 ;; B.' in preference to `Returns the cons of A and B.'
1772 ;; Usually it looks good to do likewise for the rest of the
1773 ;; first paragraph. Subsequent paragraphs usually look better
1774 ;; if they have proper subjects.
1775 ;;
1776 ;; This is the least important of the above tests. Make sure
1777 ;; it occurs last.
1780 ;; Maybe rebuild the monster-regexp
1784 ;; check string-continuation
1791 checkdoc-common-verbs-regexp
1792 lim t))
1796 checkdoc-common-verbs-wrong-voice))
1806 replace t)
1809 ;; there was a match, but no replace
1813 original replace)
1815 ;; "Return true ..." should be "Return non-nil ..."
1821 nil
1825 ;; Done with functions
1826 )))
1827 ;;* When a documentation string refers to a Lisp symbol, write it as
1828 ;; it would be printed (which usually means in lower case), with
1829 ;; single-quotes around it. For example: ‘lambda’. There are two
1830 ;; exceptions: write t and nil without single-quotes. (For
1831 ;; compatibility with an older Emacs style, quoting with ` and '
1832 ;; also works, e.g., `lambda' is treated like ‘lambda’.)
1837 ;; Ignore manual page references like
1838 ;; git-config(1).
1840 e t))
1842 ;; A . is a \s_ char, so we must remove periods from
1843 ;; sentences more carefully.
1866 nil)))
1867 ;; t and nil case
1875 nil
1877 "Symbols t and nil should not appear in single quotes"
1879 ;; Here is some basic sentence formatting
1881 ;; Here are common proper nouns that should always appear capitalized.
1883 ;; Make sure the doc string has correctly spelled English words
1884 ;; in it. This function is extracted due to its complexity,
1885 ;; and reliance on the Ispell program.
1887 ;; User supplied checks
1889 ;; Done!
1890 )))
1893 "Return a list of details about the current sexp.
1894 It is a list of the form:
1895 (NAME VARIABLE INTERACTIVE NODOCPARAMS PARAMETERS ...)
1896 where NAME is the name, VARIABLE is t if this is a `defvar',
1897 INTERACTIVE is nil if this is not an interactive function, otherwise
1898 it is the position of the `interactive' call, and PARAMETERS is a
1899 string which is the name of each variable in the function's argument
1900 list. The NODOCPARAMS is a sublist of parameters specified by a checkdoc
1901 comment for a given defun. If the first element is not a string, then
1902 the token checkdoc-order: <TOKEN> exists, and TOKEN is a symbol read
1903 from the comment."
1919 ;; The variable spot
1921 ;; Interactive
1926 t)
1927 ret)))
1931 ;; Overload th main obarray so read doesn't intern the
1932 ;; local symbols of the function we are checking.
1933 ;; Without this we end up cluttering the symbol space w/
1934 ;; useless symbols.
1936 ;; Ok, check for checkdoc parameter comment here
1944 t)
1950 t)
1964 sl1)
1965 ret)))
1966 ;; Read the list of parameters, but do not put the symbols in
1967 ;; the standard obarray.
1969 ;; This is because read will intern nil if it doesn't into the
1970 ;; new obarray.
1979 "Return non-nil if the current point is in a code fragment.
1980 A code fragment is identified by an open parenthesis followed by a
1981 symbol which is a valid function or a word in all CAPS, or a parenthesis
1983 is allowed while searching for the bounding parenthesis."
1994 ;; if this string is function bound, we are in
1995 ;; sample code. If it has a - or : character in
1996 ;; the name, then it is probably supposed to be bound
1997 ;; but isn't yet.
2006 The text checked is between START and LIMIT."
2017 "Check all text between BEGIN and END for lower case proper nouns.
2018 These are Emacs centric proper nouns which should be capitalized for
2019 consistency. Return an error list if any are not fixed, but
2020 internally skip over no answers.
2021 If the offending word is in a piece of quoted text, then it is skipped."
2035 ;; surrounded by /, as in a URL or filename: /emacs/
2039 ;; info or url links left alone
2041 help-xref-info-regexp))
2043 help-xref-url-regexp)))
2046 text)
2048 nil
2050 ;; If there is already an error, then generate
2051 ;; the warning output if applicable
2055 "Name %s should appear capitalized as %s"
2057 b e))
2060 "Name %s should appear capitalized as %s"
2062 bb b be e)))))))
2066 "Make sure all sentences have double spaces between BEGIN and END."
2083 ;; piece of an abbreviation
2084 ;; FIXME etc
2089 b e
2090 "There should be two spaces after a period. Fix? "
2092 nil
2094 ;; If there is already an error, then generate
2095 ;; the warning output if applicable
2098 "There should be two spaces after a period"
2099 b e))
2101 "There should be two spaces after a period"
2102 bb b be e)))))))
2105 ;;; Ispell engine
2106 ;;
2111 "Initialize Ispell process (default version) with Lisp words.
2112 The words used are from `checkdoc-ispell-lisp-words'. If `ispell'
2113 cannot be loaded, then set `checkdoc-spellcheck-documentation-flag' to
2114 nil."
2120 ;; This code copied in part from ispell.el Emacs 19.34
2126 "Run the Ispell tools on the doc string between point and END.
2127 Since Ispell isn't Lisp-smart, we must pre-process the doc string
2128 before using the Ispell engine on it."
2130 ;; If the user wants no questions or fixing, then we must
2131 ;; disable spell checking as not useful.
2134 nil
2141 ;; Skip lists describing meta-syntax, or bound variables
2149 ;; This is probably repetitive in most cases, but not always.
2150 nil
2151 ;; Find out how we spell-check this word.
2153 ;; All caps w/ option th, or s tacked on the end
2154 ;; for pluralization or number.
2157 )
2158 nil
2167 ;; Nothing here.
2168 )))))
2170 err))))
2172 ;;; Rogue space checking engine
2173 ;;
2175 "Return a message list if there is a line with white space at the end.
2176 If `checkdoc-autofix-flag' permits, delete that whitespace instead.
2177 If optional arguments START and END are non-nil, bound the check to
2178 this region.
2179 Optional argument INTERACT may permit the user to fix problems on the fly."
2183 ;; If end is nil, it means end of buffer to search anyway
2185 ;; Check for an error if `? ' or `?\ ' is used at the end of a line.
2186 ;; (It's dangerous)
2191 "Don't use `? ' at the end of a line. \
2192 News agents may remove it"
2194 ;; If interactive is passed down, give them a chance to fix things.
2201 ;; Check for, and potentially remove whitespace appearing at the
2202 ;; end of different lines.
2205 ;; There is no documentation in the Emacs Lisp manual about this check,
2206 ;; it is intended to help clean up messy code and reduce the file size.
2208 ;; This is not a complex activity
2212 nil
2215 ;; Return an error and leave the cursor at that spot, or restore
2216 ;; the cursor.
2220 nil)))
2222 ;;; Comment checking engine
2223 ;;
2232 "Return a message list if this file does not match the Emacs standard.
2233 This checks for style only, such as the first line, Commentary:,
2234 Code:, and others referenced in the style guide."
2236 nil
2238 ;; Old XEmacs don't have `lm-commentary-mark'
2247 ;; This file has been set up where ERR is a variable. Each check is
2248 ;; asked, and the function will make sure that if the user does not
2249 ;; auto-fix some error, that we still move on to the next auto-fix,
2250 ;; AND we remember the past errors.
2252 err
2253 ;; Lisp Maintenance checks first
2254 ;; Was: (lm-verify) -> not flexible enough for some people
2255 ;; * Summary at the beginning of the file:
2257 ;; This certifies as very complex so always ask unless
2258 ;; it's set to never
2267 nil))
2269 err
2271 ;; * Commentary Section
2278 nil t)
2291 nil nil t)))
2292 nil)
2293 err))
2295 err
2297 ;; * History section. Say nothing if there is a file ChangeLog
2302 nil
2308 nil t)
2320 err))
2322 err
2324 ;; * Code section
2327 pos)
2329 ;; match ";;;###autoload" cookie to keep it with the form
2336 nil t))
2344 nil)
2348 nil)
2349 err))
2351 err
2353 ;; * A footer. Not compartmentalized from lm-verify: too bad.
2354 ;; The following is partially clipped from lm-verify
2362 nil t))
2369 fn fn fe)
2371 err))
2372 ;; The below checks will not return errors if the user says NO
2374 ;; Let's spellcheck the commentary section. This is the only
2375 ;; section that is easy to pick out, and it is also the most
2376 ;; visible section (with the finder).
2382 ;; Since the comments talk about Lisp, use the
2383 ;; specialized spell-checker we also used for doc
2384 ;; strings.
2389 err
2391 ;; Generic Full-file checks (should be comment related)
2393 err))
2394 ;; Done with full file comment checks
2395 err)))
2398 "Return t if point is outside the bounds of a valid sexp."
2405 ;;; `error' and `message' text verifier.
2406 ;;
2408 "Search between BEG and END for a style error with message text.
2409 Optional arguments BEG and END represent the boundary of the check.
2410 The default boundary is the entire buffer."
2417 e))
2420 "Move cursor to the next checkable message string after point.
2421 Return the message classification.
2422 Argument END is the maximum bounds to search in."
2441 nil
2443 return))
2446 "Return or fix errors found in strings passed to a message display function.
2447 According to the documentation for the function `error', the error list
2448 should not end with a period, and should start with a capital letter.
2449 The function `y-or-n-p' has similar constraints.
2450 Argument TYPE specifies the type of question, such as `error' or `y-or-n-p'."
2451 ;; If type is nil, then attempt to derive it.
2463 ;; From the documentation of the symbol `error':
2464 ;; In Emacs, the convention is that error messages start with a capital
2465 ;; letter but *do not* end with a period. Please follow this convention
2466 ;; for the sake of consistency.
2471 "Capitalize your message text? "
2473 t)))
2475 "Messages should start with a capital letter"
2477 nil)
2478 ;; In general, sentences should have two spaces after the period.
2482 ;; Look for proper nouns in this region too.
2486 ;; Here are message type specific questions.
2493 "Remove period from error? "
2494 ""
2495 t)))
2497 "Error messages should *not* end with a period"
2499 nil)
2500 ;; `y-or-n-p' documentation explicitly says:
2501 ;; It should end in a space; `y-or-n-p' adds `(y or n) ' to it.
2502 ;; I added the ? requirement. Without it, it is unclear that we
2503 ;; ask a question and it appears to be an undocumented style.
2508 nil
2512 ;; If we see a ?, then replace with "? ".
2518 nil
2530 nil
2543 nil
2547 ;; Now, let's just run the spell checker on this guy.
2550 )))
2552 ;;; Auto-fix helper functions
2553 ;;
2555 "Like `y-or-n-p', but pays attention to `checkdoc-autofix-flag'.
2556 Argument QUESTION is the prompt passed to `y-or-n-p'."
2560 nil
2567 "Highlight between START and END and queries the user with QUESTION.
2568 If the user says yes, or if `checkdoc-autofix-flag' permits, replace
2569 the region marked by START and END with REPLACEWITH. If optional flag
2570 COMPLEX is non-nil, then we may ask the user a question. See the
2571 documentation for `checkdoc-autofix-flag' for details.
2573 If a section is auto-replaced without asking the user, this function
2574 will pause near the fixed code so the user will briefly see what
2575 happened.
2577 This function returns non-nil if the text was replaced.
2579 This function will not modify `match-data'."
2596 ;; On the off chance this is automatic, display
2597 ;; the question anyway so the user knows what's
2598 ;; going on.
2610 ret)))
2612 ;;; Warning management
2613 ;;
2627 "Set up the major mode for the buffer containing the list of errors."
2629 checkdoc-output-error-regex-alist)
2631 checkdoc-output-font-lock-keywords))
2634 "The name to use for a checkdoc buffer in the error list."
2640 "Initialize the checkdoc diagnostic buffer for a pass.
2641 Create the header so that the string CHECK-TYPE is displayed as the
2642 function called to create the messages."
2654 "Store POINT and MSG as errors in the checkdoc diagnostic buffer."
2669 "Display the checkdoc diagnostic buffer in a temporary window."
2681 nil)))
2684 "Return a list of package keywords for the current file."
2692 ;;;###autoload
2694 "Find package keywords that aren't in `finder-known-keywords'."
2720 ;;; checkdoc.el ends here