| blob | e93294d6cc277ef91a82b5f7e1fca58c6683da4d |
1 ;;; checkdoc.el --- check documentation strings for style requirements -*- lexical-binding:t -*-
3 ;; Copyright (C) 1997-1998, 2001-2016 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
300 "Regular expression used to identify a defun.
304 "Non-nil means to attempt to check the voice of the doc string.
305 This check keys off some words which are commonly misused. See the
306 variable `checkdoc-common-verbs-wrong-voice' if you wish to add your own."
308 ;;;###autoload(put 'checkdoc-verb-check-experimental-flag 'safe-local-variable #'booleanp)
311 "Non-nil means generate warnings in a buffer for browsing.
312 Do not set this by hand, use a function like `checkdoc-current-buffer'
316 "A list of symbol names (strings) which also happen to make good words.
317 These words are ignored when unquoted symbols are searched for.
318 This should be set in an Emacs Lisp file's local variables."
320 ;;;###autoload(put 'checkdoc-symbol-words 'safe-local-variable #'checkdoc-list-of-strings-p)
322 ;;;###autoload
324 "Return t when OBJ is a list of strings."
325 ;; this is a function so it might be shared by checkdoc-proper-noun-list
326 ;; and/or checkdoc-ispell-lisp-words in the future
335 ;; "[.!?]" is for noun at end of a sentence, since those chars
336 ;; are symbol syntax in emacs-lisp-mode and so don't match \\_>.
337 ;; The \" allows it to be the last sentence in a docstring too.
342 ;;;###autoload(put 'checkdoc-proper-noun-regexp 'safe-local-variable 'stringp)
346 ;;;###autoload(put 'checkdoc-common-verbs-regexp 'safe-local-variable 'stringp)
428 )
429 "Alist of common words in the wrong voice and what should be used instead.
430 Set `checkdoc-verb-check-experimental-flag' to nil to avoid this costly
431 and experimental check. Do not modify this list without setting
432 the value of `checkdoc-common-verbs-regexp' to nil which cause it to
437 ;; When dealing with syntax in doc strings, make sure that - are
438 ;; encompassed in words so we can use cheap \\> to get the end of a symbol,
439 ;; not the end of a word in a conglomerate.
441 st)
444 ;;; Compatibility
445 ;;
461 ;;; User level commands
462 ;;
463 ;;;###autoload
465 "Interactively check the entire buffer for style errors.
466 The current status of the check will be displayed in a buffer which
467 the users will view as each check is completed."
473 ;; if the user set autofix to never, then that breaks the
474 ;; obviously requested asking implied by using this function.
475 ;; Set it to paranoia level.
478 'query
479 checkdoc-autofix-flag))
480 tmp)
482 ;; check the comments
490 ;; Check the documentation
497 ;; Check the message text
503 ;; Rogue spacing
512 "Display and update the status buffer for the current checkdoc mode.
513 CHECK is a list of four strings stating the current status of each
514 test; the nth string describes the status of the nth test."
527 ;;;###autoload
529 "Interactively check the current buffer for doc string errors.
530 Prefix argument START-HERE will start the checking from the current
531 point, otherwise the check starts at the beginning of the current
532 buffer. Allows navigation forward and backwards through document
533 errors. Does not check for comment or space warnings.
534 Optional argument SHOWSTATUS indicates that we should update the
535 checkdoc status window instead of the usual behavior."
541 ;; Due to a design flaw, this will never spell check
542 ;; docstrings.
545 ;; This is a workaround to perform spell checking.
548 ;;;###autoload
550 "Interactively check the current buffer for message string errors.
551 Prefix argument START-HERE will start the checking from the current
552 point, otherwise the check starts at the beginning of the current
553 buffer. Allows navigation forward and backwards through document
554 errors. Does not check for comment or space warnings.
555 Optional argument SHOWSTATUS indicates that we should update the
556 checkdoc status window instead of the usual behavior."
562 ;; Due to a design flaw, this will never spell check messages.
565 ;; This is a workaround to perform spell checking.
569 "Interactively loop over all errors that can be found by a given method.
571 If START-HERE is nil, searching starts at the beginning of the current
572 buffer, otherwise searching starts at START-HERE. SHOWSTATUS
573 expresses the verbosity of the search, and whether ending the search
574 will auto-exit this function.
576 FINDFUNC is a symbol representing a function that will position the
577 cursor, and return error message text to present to the user. It is
578 assumed that the cursor will stop just before a major sexp, which will
579 be highlighted to present the user with feedback as to the offending
580 style."
581 ;; Determine where to start the test
584 ;; Assign a flag to spellcheck flag
588 ;; Fetch the error list
592 c)
595 ;; Include whatever function point is in for good measure.
599 ;; The cursor should be just in front of the offending doc string
610 ;; Make sure the whole doc string is visible if possible.
634 ;; Exit condition
636 ;; Request an auto-fix
641 ;; `automatic-then-never' tells the autofix function
642 ;; to only allow one fix to be automatic. The autofix
643 ;; function will then set the flag to `never', allowing
644 ;; the checker to return a different error.
666 ;; Move to the next error (if available)
672 err-list nil)
678 ;; Go backwards in the list of errors
687 ;; Edit the buffer recursively.
698 err-list nil)
702 ;; Quit checkdoc
705 err-list nil
707 ;; Goofy stuff
718 ""
720 "f, y - auto Fix this warning without asking (if\
723 )
735 returnme))
738 "Interactively spell check doc strings in the current buffer.
739 If START-HERE is nil, searching starts at the beginning of the current
740 buffer, otherwise searching starts at START-HERE."
743 ;; Move point to where we need to start.
745 ;; Include whatever function point is in for good measure.
748 ;; Loop over docstrings.
758 "Interactively spell check messages in the current buffer.
759 If START-HERE is nil, searching starts at the beginning of the current
760 buffer, otherwise searching starts at START-HERE."
763 ;; Move point to where we need to start.
765 ;; Include whatever function point is in for good measure.
768 ;; Loop over message strings.
779 "Find and return the next checkdoc error list, or nil.
780 Only documentation strings are checked.
781 An error list is of the form (WARNING . POSITION) where WARNING is the
782 warning text, and POSITION is the point in the buffer where the error
783 was found. We can use points and not markers because we promise not
784 to edit the buffer before point without re-executing this check.
785 Argument ENABLE-FIX will enable auto-fixing while looking for the next
786 error. This argument assumes that the cursor is already positioned to
787 perform the fix."
798 ;; Quit.. restore position, Other errors, leave alone
800 msg)))
803 "Find and return the next checkdoc message related error list, or nil.
804 Only text for error and `y-or-n-p' strings are checked. See
805 `checkdoc-next-error' for details on the return value.
806 Argument ENABLE-FIX turns on the auto-fix feature. This argument
807 assumes that the cursor is already positioned to perform the fix."
820 ;; Quit.. restore position, Other errors, leave alone
822 msg)))
825 "Enter recursive edit to permit a user to fix some error checkdoc has found.
826 MSG is the error that was found, which is displayed in a help buffer."
841 ;;;###autoload
843 "Evaluate and check documentation for the current buffer.
844 Evaluation is done first because good documentation for something that
845 doesn't work is just not useful. Comments, doc strings, and rogue
846 spacing are all verified."
851 ;;;###autoload
853 "Check current buffer for document, comment, error style, and rogue spaces.
854 With a prefix argument (in Lisp, the argument TAKE-NOTES),
855 store all errors found in a warnings buffer,
856 otherwise stop after the first error."
860 ;; Assign a flag to spellcheck flag
865 checkdoc-autofix-flag))
870 ;; every test is responsible for returning the cursor.
882 ;;;###autoload
884 "Check FILE for document, comment, error style, and rogue spaces."
889 ;;;###autoload
891 "Start scanning the current buffer for documentation string style errors.
892 Only documentation strings are checked.
893 Use `checkdoc-continue' to continue checking if an error cannot be fixed.
894 Prefix argument TAKE-NOTES means to collect all the warning messages into
895 a separate buffer."
902 ;; Go back since we can't be here without success above.
904 nil))
906 ;;;###autoload
908 "Find the next doc string in the current buffer which has a style error.
909 Prefix argument TAKE-NOTES means to continue through the whole buffer and
910 save warnings in a separate buffer. Second optional argument START-POINT
911 is the starting location. If this is nil, `point-min' is used instead."
914 ;; Assign a flag to spellcheck flag
919 checkdoc-autofix-flag))
923 ;; If we are taking notes, encompass the whole buffer, otherwise
924 ;; the user is navigating down through the buffer.
926 ;; OK, let's look at the doc string.
939 "Move to the next doc string after point, and return t.
940 Return nil if there are no more doc strings."
942 nil
943 ;; search drops us after the identifier. The next sexp is either
944 ;; the argument list or the value of the variable. skip it.
947 t))
949 ;;;###autoload
951 "Find missing comment sections in the current Emacs Lisp file.
952 Prefix argument TAKE-NOTES non-nil means to save warnings in a
953 separate buffer. Otherwise print a message. This returns the error
954 if there is one."
968 e))
970 ;;;###autoload
972 "Find extra spaces at the end of lines in the current file.
973 Prefix argument TAKE-NOTES non-nil means to save warnings in a
974 separate buffer. Otherwise print a message. This returns the error
975 if there is one.
976 Optional argument INTERACT permits more interactive fixing."
984 e
990 ;;;###autoload
992 "Scan the buffer for occurrences of the error function, and verify text.
993 Optional argument TAKE-NOTES causes all errors to be logged."
1002 e
1010 ;;;###autoload
1012 "Evaluate the current form with `eval-defun' and check its documentation.
1013 Evaluation is done first so the form will be read before the
1014 documentation is checked. If there is a documentation error, then the display
1015 of what was evaluated will be overwritten by the diagnostic message."
1020 ;;;###autoload
1022 "Examine the doc string of the function or variable under point.
1023 Call `error' if the doc string has problems. If NO-ERROR is
1024 non-nil, then do not call error, but call `message' instead.
1025 If the doc string passes the test, then check the function for rogue white
1026 space at the end of each line."
1031 ;; I found this more annoying than useful.
1032 ;;(if (not no-error)
1033 ;; (message "Cannot check this sexp's doc string."))
1034 nil
1035 ;; search drops us after the identifier. The next sexp is either
1036 ;; the argument list or the value of the variable. skip it.
1055 ;;; Ispell interface for forcing a spell check
1056 ;;
1058 ;;;###autoload
1060 "Check the style and spelling of everything interactively.
1061 Calls `checkdoc' with spell-checking turned on.
1062 Prefix argument is the same as for `checkdoc'"
1067 ;;;###autoload
1069 "Check the style and spelling of the current buffer.
1070 Calls `checkdoc-current-buffer' with spell-checking turned on.
1071 Prefix argument is the same as for `checkdoc-current-buffer'"
1076 ;;;###autoload
1078 "Check the style and spelling of the current buffer interactively.
1079 Calls `checkdoc-interactive' with spell-checking turned on.
1080 Prefix argument is the same as for `checkdoc-interactive'"
1085 ;;;###autoload
1087 "Check the style and spelling of message text interactively.
1088 Calls `checkdoc-message-interactive' with spell-checking turned on.
1089 Prefix argument is the same as for `checkdoc-message-interactive'"
1093 nil current-prefix-arg)))
1095 ;;;###autoload
1097 "Check the style and spelling of message text interactively.
1098 Calls `checkdoc-message-text' with spell-checking turned on.
1099 Prefix argument is the same as for `checkdoc-message-text'"
1104 ;;;###autoload
1106 "Check the style and spelling of the current buffer.
1107 Calls `checkdoc-start' with spell-checking turned on.
1108 Prefix argument is the same as for `checkdoc-start'"
1113 ;;;###autoload
1115 "Check the style and spelling of the current buffer after point.
1116 Calls `checkdoc-continue' with spell-checking turned on.
1117 Prefix argument is the same as for `checkdoc-continue'"
1122 ;;;###autoload
1124 "Check the style and spelling of the current buffer's comments.
1125 Calls `checkdoc-comments' with spell-checking turned on.
1126 Prefix argument is the same as for `checkdoc-comments'"
1131 ;;;###autoload
1133 "Check the style and spelling of the current defun with Ispell.
1134 Calls `checkdoc-defun' with spell-checking turned on.
1135 Prefix argument is the same as for `checkdoc-defun'"
1140 ;;; Error Management
1141 ;;
1142 ;; Errors returned from checkdoc functions can have various
1143 ;; features and behaviors, so we need some ways of specifying
1144 ;; them, and making them easier to use in the wacked-out interfaces
1145 ;; people are requesting
1147 "Used to create the return error text returned from all engines.
1148 TEXT is the descriptive text of the error. START and END define the region
1149 it is sensible to highlight when describing the problem.
1150 Optional argument UNFIXABLE means that the error has no auto-fix available.
1152 A list of the form (TEXT START END UNFIXABLE) is returned if we are not
1153 generating a buffered list of errors."
1156 nil)
1160 "Return the text specified in the checkdoc ERR."
1161 ;; string-p part is for backwards compatibility
1165 "Return the start point specified in the checkdoc ERR."
1166 ;; string-p part is for backwards compatibility
1170 "Return the end point specified in the checkdoc ERR."
1171 ;; string-p part is for backwards compatibility
1175 "Return the t if we cannot autofix the error specified in the checkdoc ERR."
1176 ;; string-p part is for backwards compatibility
1179 ;;; Minor Mode specification
1180 ;;
1185 ;; Override some bindings
1191 ;; Add some new bindings under C-c ?
1209 ;; bind our submap into map
1211 map)
1214 ;; Add in a menubar with easy-menu
1217 nil checkdoc-minor-mode-map "Checkdoc Minor Mode Menu"
1223 "---"
1232 checkdoc-ispell-message-interactive t]
1237 buffer-file-name]
1239 "---"
1244 ))
1245 ;; XEmacs requires some weird stuff to add this menu in a minor mode.
1246 ;; What is it?
1248 ;;;###autoload
1250 "Toggle automatic docstring checking (Checkdoc minor mode).
1251 With a prefix argument ARG, enable Checkdoc minor mode if ARG is
1252 positive, and disable it otherwise. If called from Lisp, enable
1253 the mode if ARG is omitted or nil.
1255 In Checkdoc minor mode, the usual bindings for `eval-defun' which is
1256 bound to \\<checkdoc-minor-mode-map>\\[checkdoc-eval-defun] and `checkdoc-eval-current-buffer' are overridden to include
1257 checking of documentation strings.
1260 nil checkdoc-minor-mode-string nil
1263 ;;; Subst utils
1264 ;;
1266 "Run hooks in HOOKVAR with ARGS."
1269 ;; This method was similar to above. We ignore the warning
1270 ;; since we will use the above for future Emacs versions
1274 "Rebuild the contents of `checkdoc-common-verbs-regexp'."
1282 ;; Profiler says this is not yet faster than just calling assoc
1283 ;;(defun checkdoc-word-in-alist-vector (word vector)
1284 ;; "Check to see if WORD is in the car of an element of VECTOR.
1285 ;;VECTOR must be sorted. The CDR should be a replacement. Since the
1286 ;;word list is getting bigger, it is time for a quick bisecting search."
1287 ;; (let ((max (length vector)) (min 0) i
1288 ;; (found nil) (fw nil))
1289 ;; (setq i (/ max 2))
1290 ;; (while (and (not found) (/= min max))
1291 ;; (setq fw (car (aref vector i)))
1292 ;; (cond ((string= word fw) (setq found (cdr (aref vector i))))
1293 ;; ((string< word fw) (setq max i))
1294 ;; (t (setq min i)))
1295 ;; (setq i (/ (+ max min) 2))
1296 ;; )
1297 ;; found))
1299 ;;; Checking engines
1300 ;;
1302 "Return a message string if the current doc string is invalid.
1303 Check for style only, such as the first line always being a complete
1304 sentence, whitespace restrictions, and making sure there are no
1305 hard-coded key-codes such as C-[char] or mouse-[number] in the comment.
1306 See the style guide in the Emacs Lisp manual for more details."
1308 ;; Jump over comments between the last object and the doc string
1317 err
1318 ;; * Every command, function, or variable intended for users to know
1319 ;; about should have a documentation string.
1320 ;;
1321 ;; * An internal variable or subroutine of a Lisp program might as well
1322 ;; have a documentation string. In earlier Emacs versions, you could
1323 ;; save space by using a comment instead of a documentation string,
1324 ;; but that is no longer the case.
1329 ;; Sometimes old code has comments where the documentation should
1330 ;; be. Let's see if we can find the comment, and offer to turn it
1331 ;; into documentation for them.
1347 ;; Our point is at the beginning of the comment!
1348 ;; Insert a quote, then remove the comment chars.
1367 ;; quote any double-quote characters in the comment.
1373 "You should convert this comment to documentation"
1377 "All interactive functions should have documentation"
1378 "All variables and subroutines might as well have a \
1384 err)))
1387 "Return an error list or string if the current doc string is invalid.
1388 Depends on `checkdoc-this-string-valid' to reset the syntax table so that
1389 regexp short cuts work. FP is the function defun information."
1391 ;; Use a marker so if an early check modifies the text,
1392 ;; we won't accidentally lose our place. This could cause
1393 ;; end-of doc string whitespace to also delete the " char.
1399 ;; * *Do not* indent subsequent lines of a documentation string so that
1400 ;; the text is lined up in the source code with the text of the first
1401 ;; line. This looks nice in the source code, but looks bizarre when
1402 ;; users view the documentation. Remember that the indentation
1403 ;; before the starting double-quote is not part of the string!
1411 "Remove this whitespace? "
1413 nil
1415 "Second line should not have indentation"
1418 ;; * Check for '(' in column 0.
1425 nil
1427 "Open parenthesis in column 0 should be escaped"
1429 ;; * Do not start or end a documentation string with whitespace.
1442 nil
1444 "Documentation strings should not start or end with whitespace"
1445 start end))))
1446 ;; * The first line of the documentation string should consist of one
1447 ;; or two complete sentences that stand on their own as a summary.
1448 ;; `M-x apropos' displays just the first line, and if it doesn't
1449 ;; stand on its own, the result looks bad. In particular, start the
1450 ;; first line with a capital letter and end with a period.
1458 ;; A backslashed double quote at the end of a sentence
1460 ;; We might have to add a period in this case
1463 nil
1468 nil
1470 "First sentence should end with punctuation"
1473 ;; These are ok
1474 nil)
1476 nil)
1478 ;; If it is not a complete sentence, let's see if we can
1479 ;; predict a clever way to make it one.
1484 ;; Here we have found a complete sentence, but no break.
1487 "First line not a complete sentence. Add RET here? "
1498 ;; We can merge these lines! Replace this CR
1499 ;; with a space.
1502 ;; Let's see if there is enough room to draw the next
1503 ;; line's sentence up here. I often get hit w/
1504 ;; auto-fill moving my words around.
1514 "1st line not a complete sentence. Join these lines? "
1517 ;; They said yes. We have more fill work to do...
1526 ;; Continuation of above. Make sure our sentence is capitalized.
1533 t)
1534 nil
1536 "First line should be capitalized"
1538 nil))
1539 ;; * Don't write key sequences directly in documentation strings.
1540 ;; Instead, use the `\\[...]' construct to stand for them.
1545 ;; Find the first key sequence not in a sample
1555 ;; It is not practical to use `\\[...]' very many times, because
1556 ;; display of the documentation string will become slow. So use this
1557 ;; to describe the most important commands in your major mode, and
1558 ;; then use `\\{...}' to display the rest of the mode's keymap.
1566 ;; Ambiguous quoted symbol. When a symbol is both bound and fbound,
1567 ;; and is referred to in documentation, it should be prefixed with
1568 ;; something to disambiguate it. This check must be before the
1569 ;; 80 column check because it will probably break that.
1588 ;; We didn't actually replace anything. Here we find
1589 ;; out what special word form they wish to use as
1590 ;; a prefix.
1593 "Disambiguating Keyword (default variable): "
1605 nil)))
1606 ;; * Format the documentation string so that it fits in an
1607 ;; Emacs window on an 80-column screen. It is a good idea
1608 ;; for most lines to be no wider than 60 characters. The
1609 ;; first line can be wider if necessary to fit the
1610 ;; information that ought to be there.
1619 eol t))
1625 "Some lines are over 80 columns wide"
1627 ;; Here we deviate to tests based on a variable or function.
1628 ;; We must do this before checking for symbols in quotes because there
1629 ;; is a chance that just such a symbol might really be an argument.
1631 ;; This is if we are in a variable
1633 ;; * The documentation string for a variable that is a
1634 ;; yes-or-no flag should start with words such as Non-nil
1635 ;; means..., to make it clear that all non-nil values are
1636 ;; equivalent and indicate explicitly what nil and non-nil
1637 ;; mean.
1638 ;; * If a user option variable records a true-or-false
1639 ;; condition, give it a name that ends in `-flag'.
1641 ;; "True ..." should be "Non-nil ..."
1647 nil
1652 ;; If the variable has -flag in the name, make sure
1656 "Flag variable doc strings should usually start: Non-nil means"
1658 ;; Don't rename variable to "foo-flag". This is unnecessary
1659 ;; and such names often end up inconvenient when the variable
1660 ;; is later expanded to non-boolean values. --Stef
1661 ;; If the doc string starts with "Non-nil means"
1662 ;; (if (and (looking-at "\"\\*?Non-nil\\s-+means\\s-+")
1663 ;; (not (string-match "-flag$" (car fp))))
1664 ;; (let ((newname
1665 ;; (if (string-match "-p$" (car fp))
1666 ;; (concat (substring (car fp) 0 -2) "-flag")
1667 ;; (concat (car fp) "-flag"))))
1668 ;; (if (checkdoc-y-or-n-p
1669 ;; (format
1670 ;; "Rename to %s and Query-Replace all occurrences? "
1671 ;; newname))
1672 ;; (progn
1673 ;; (beginning-of-defun)
1674 ;; (query-replace-regexp
1675 ;; (concat "\\<" (regexp-quote (car fp)) "\\>")
1676 ;; newname))
1677 ;; (checkdoc-create-error
1678 ;; "Flag variable names should normally end in `-flag'" s
1679 ;; (marker-position e)))))
1680 ;; Done with variables
1681 ))
1683 ;; This if we are in a function definition
1685 ;; * When a function's documentation string mentions the value
1686 ;; of an argument of the function, use the argument name in
1687 ;; capital letters as if it were a name for that value. Thus,
1688 ;; the documentation string of the function `/' refers to its
1689 ;; second argument as `DIVISOR', because the actual argument
1690 ;; name is `divisor'.
1692 ;; Addendum: Make sure they appear in the doc in the same
1693 ;; order that they are found in the arg list.
1704 inopts t)
1709 ;; Require whitespace OR
1710 ;; ITEMth<space> OR
1711 ;; ITEMs<space>
1713 e t)))
1716 ;; If the symbol was not found, let's see if we
1717 ;; can find it with a different capitalization
1718 ;; and see if the user wants to capitalize it.
1722 ;; Require whitespace OR
1723 ;; ITEMth<space> OR
1724 ;; ITEMs<space>
1726 e t))
1730 "If this is the argument `%s', it should appear as %s. Fix? "
1736 ;; It wasn't found at all! Offer to attach this new symbol
1737 ;; to the end of the documentation string.
1740 "Add %s documentation to end of doc string? "
1742 ;; Now do some magic and invent a doc string.
1753 nil)
1756 "Argument `%s' should appear (as %s) in the doc string"
1763 "Arguments occur in the doc string out of order"
1765 ;; * For consistency, phrase the verb in the first sentence of a
1766 ;; documentation string for functions as an imperative.
1767 ;; For instance, use `Return the cons of A and
1768 ;; B.' in preference to `Returns the cons of A and B.'
1769 ;; Usually it looks good to do likewise for the rest of the
1770 ;; first paragraph. Subsequent paragraphs usually look better
1771 ;; if they have proper subjects.
1772 ;;
1773 ;; This is the least important of the above tests. Make sure
1774 ;; it occurs last.
1777 ;; Maybe rebuild the monster-regexp
1781 ;; check string-continuation
1788 checkdoc-common-verbs-regexp
1789 lim t))
1793 checkdoc-common-verbs-wrong-voice))
1803 replace t)
1806 ;; there was a match, but no replace
1810 original replace)
1812 ;; "Return true ..." should be "Return non-nil ..."
1818 nil
1822 ;; Done with functions
1823 )))
1824 ;;* When a documentation string refers to a Lisp symbol, write it as
1825 ;; it would be printed (which usually means in lower case), with
1826 ;; single-quotes around it. For example: ‘lambda’. There are two
1827 ;; exceptions: write t and nil without single-quotes. (For
1828 ;; compatibility with an older Emacs style, quoting with ` and '
1829 ;; also works, e.g., `lambda' is treated like ‘lambda’.)
1834 ;; Ignore manual page references like
1835 ;; git-config(1).
1837 e t))
1839 ;; A . is a \s_ char, so we must remove periods from
1840 ;; sentences more carefully.
1863 nil)))
1864 ;; t and nil case
1872 nil
1874 "Symbols t and nil should not appear in single quotes"
1876 ;; Here is some basic sentence formatting
1878 ;; Here are common proper nouns that should always appear capitalized.
1880 ;; Make sure the doc string has correctly spelled English words
1881 ;; in it. This function is extracted due to its complexity,
1882 ;; and reliance on the Ispell program.
1884 ;; User supplied checks
1886 ;; Done!
1887 )))
1890 "Return a list of details about the current sexp.
1891 It is a list of the form:
1892 (NAME VARIABLE INTERACTIVE NODOCPARAMS PARAMETERS ...)
1893 where NAME is the name, VARIABLE is t if this is a `defvar',
1894 INTERACTIVE is nil if this is not an interactive function, otherwise
1895 it is the position of the `interactive' call, and PARAMETERS is a
1896 string which is the name of each variable in the function's argument
1897 list. The NODOCPARAMS is a sublist of parameters specified by a checkdoc
1898 comment for a given defun. If the first element is not a string, then
1899 the token checkdoc-order: <TOKEN> exists, and TOKEN is a symbol read
1900 from the comment."
1916 ;; The variable spot
1918 ;; Interactive
1923 t)
1924 ret)))
1928 ;; Overload th main obarray so read doesn't intern the
1929 ;; local symbols of the function we are checking.
1930 ;; Without this we end up cluttering the symbol space w/
1931 ;; useless symbols.
1933 ;; Ok, check for checkdoc parameter comment here
1941 t)
1947 t)
1961 sl1)
1962 ret)))
1963 ;; Read the list of parameters, but do not put the symbols in
1964 ;; the standard obarray.
1966 ;; This is because read will intern nil if it doesn't into the
1967 ;; new obarray.
1976 "Return non-nil if the current point is in a code fragment.
1977 A code fragment is identified by an open parenthesis followed by a
1978 symbol which is a valid function or a word in all CAPS, or a parenthesis
1980 is allowed while searching for the bounding parenthesis."
1991 ;; if this string is function bound, we are in
1992 ;; sample code. If it has a - or : character in
1993 ;; the name, then it is probably supposed to be bound
1994 ;; but isn't yet.
2003 The text checked is between START and LIMIT."
2014 "Check all text between BEGIN and END for lower case proper nouns.
2015 These are Emacs centric proper nouns which should be capitalized for
2016 consistency. Return an error list if any are not fixed, but
2017 internally skip over no answers.
2018 If the offending word is in a piece of quoted text, then it is skipped."
2032 ;; surrounded by /, as in a URL or filename: /emacs/
2036 ;; info or url links left alone
2038 help-xref-info-regexp))
2040 help-xref-url-regexp)))
2043 text)
2045 nil
2047 ;; If there is already an error, then generate
2048 ;; the warning output if applicable
2052 "Name %s should appear capitalized as %s"
2054 b e))
2057 "Name %s should appear capitalized as %s"
2059 bb b be e)))))))
2063 "Make sure all sentences have double spaces between BEGIN and END."
2080 ;; piece of an abbreviation
2081 ;; FIXME etc
2086 b e
2087 "There should be two spaces after a period. Fix? "
2089 nil
2091 ;; If there is already an error, then generate
2092 ;; the warning output if applicable
2095 "There should be two spaces after a period"
2096 b e))
2098 "There should be two spaces after a period"
2099 bb b be e)))))))
2102 ;;; Ispell engine
2103 ;;
2108 "Initialize Ispell process (default version) with Lisp words.
2109 The words used are from `checkdoc-ispell-lisp-words'. If `ispell'
2110 cannot be loaded, then set `checkdoc-spellcheck-documentation-flag' to
2111 nil."
2117 ;; This code copied in part from ispell.el Emacs 19.34
2123 "Run the Ispell tools on the doc string between point and END.
2124 Since Ispell isn't Lisp-smart, we must pre-process the doc string
2125 before using the Ispell engine on it."
2127 ;; If the user wants no questions or fixing, then we must
2128 ;; disable spell checking as not useful.
2131 nil
2138 ;; Skip lists describing meta-syntax, or bound variables
2146 ;; This is probably repetitive in most cases, but not always.
2147 nil
2148 ;; Find out how we spell-check this word.
2150 ;; All caps w/ option th, or s tacked on the end
2151 ;; for pluralization or number.
2154 )
2155 nil
2164 ;; Nothing here.
2165 )))))
2167 err))))
2169 ;;; Rogue space checking engine
2170 ;;
2172 "Return a message list if there is a line with white space at the end.
2173 If `checkdoc-autofix-flag' permits, delete that whitespace instead.
2174 If optional arguments START and END are non-nil, bound the check to
2175 this region.
2176 Optional argument INTERACT may permit the user to fix problems on the fly."
2180 ;; If end is nil, it means end of buffer to search anyway
2182 ;; Check for an error if `? ' or `?\ ' is used at the end of a line.
2183 ;; (It's dangerous)
2188 "Don't use `? ' at the end of a line. \
2189 News agents may remove it"
2191 ;; If interactive is passed down, give them a chance to fix things.
2198 ;; Check for, and potentially remove whitespace appearing at the
2199 ;; end of different lines.
2202 ;; There is no documentation in the Emacs Lisp manual about this check,
2203 ;; it is intended to help clean up messy code and reduce the file size.
2205 ;; This is not a complex activity
2209 nil
2212 ;; Return an error and leave the cursor at that spot, or restore
2213 ;; the cursor.
2217 nil)))
2219 ;;; Comment checking engine
2220 ;;
2229 "Return a message list if this file does not match the Emacs standard.
2230 This checks for style only, such as the first line, Commentary:,
2231 Code:, and others referenced in the style guide."
2233 nil
2235 ;; Old XEmacs don't have `lm-commentary-mark'
2244 ;; This file has been set up where ERR is a variable. Each check is
2245 ;; asked, and the function will make sure that if the user does not
2246 ;; auto-fix some error, that we still move on to the next auto-fix,
2247 ;; AND we remember the past errors.
2249 err
2250 ;; Lisp Maintenance checks first
2251 ;; Was: (lm-verify) -> not flexible enough for some people
2252 ;; * Summary at the beginning of the file:
2254 ;; This certifies as very complex so always ask unless
2255 ;; it's set to never
2264 nil))
2266 err
2268 ;; * Commentary Section
2275 nil t)
2288 nil nil t)))
2289 nil)
2290 err))
2292 err
2294 ;; * History section. Say nothing if there is a file ChangeLog
2299 nil
2305 nil t)
2317 err))
2319 err
2321 ;; * Code section
2324 pos)
2326 ;; match ";;;###autoload" cookie to keep it with the form
2333 nil t))
2341 nil)
2345 nil)
2346 err))
2348 err
2350 ;; * A footer. Not compartmentalized from lm-verify: too bad.
2351 ;; The following is partially clipped from lm-verify
2359 nil t))
2366 fn fn fe)
2368 err))
2369 ;; The below checks will not return errors if the user says NO
2371 ;; Let's spellcheck the commentary section. This is the only
2372 ;; section that is easy to pick out, and it is also the most
2373 ;; visible section (with the finder).
2379 ;; Since the comments talk about Lisp, use the
2380 ;; specialized spell-checker we also used for doc
2381 ;; strings.
2386 err
2388 ;; Generic Full-file checks (should be comment related)
2390 err))
2391 ;; Done with full file comment checks
2392 err)))
2395 "Return t if point is outside the bounds of a valid sexp."
2402 ;;; `error' and `message' text verifier.
2403 ;;
2405 "Search between BEG and END for a style error with message text.
2406 Optional arguments BEG and END represent the boundary of the check.
2407 The default boundary is the entire buffer."
2414 e))
2417 "Move cursor to the next checkable message string after point.
2418 Return the message classification.
2419 Argument END is the maximum bounds to search in."
2438 nil
2440 return))
2443 "Return or fix errors found in strings passed to a message display function.
2444 According to the documentation for the function `error', the error list
2445 should not end with a period, and should start with a capital letter.
2446 The function `y-or-n-p' has similar constraints.
2447 Argument TYPE specifies the type of question, such as `error' or `y-or-n-p'."
2448 ;; If type is nil, then attempt to derive it.
2460 ;; From the documentation of the symbol `error':
2461 ;; In Emacs, the convention is that error messages start with a capital
2462 ;; letter but *do not* end with a period. Please follow this convention
2463 ;; for the sake of consistency.
2468 "Capitalize your message text? "
2470 t)))
2472 "Messages should start with a capital letter"
2474 nil)
2475 ;; In general, sentences should have two spaces after the period.
2479 ;; Look for proper nouns in this region too.
2483 ;; Here are message type specific questions.
2490 "Remove period from error? "
2491 ""
2492 t)))
2494 "Error messages should *not* end with a period"
2496 nil)
2497 ;; `y-or-n-p' documentation explicitly says:
2498 ;; It should end in a space; `y-or-n-p' adds `(y or n) ' to it.
2499 ;; I added the ? requirement. Without it, it is unclear that we
2500 ;; ask a question and it appears to be an undocumented style.
2505 nil
2509 ;; If we see a ?, then replace with "? ".
2515 nil
2527 nil
2540 nil
2544 ;; Now, let's just run the spell checker on this guy.
2547 )))
2549 ;;; Auto-fix helper functions
2550 ;;
2552 "Like `y-or-n-p', but pays attention to `checkdoc-autofix-flag'.
2553 Argument QUESTION is the prompt passed to `y-or-n-p'."
2557 nil
2564 "Highlight between START and END and queries the user with QUESTION.
2565 If the user says yes, or if `checkdoc-autofix-flag' permits, replace
2566 the region marked by START and END with REPLACEWITH. If optional flag
2567 COMPLEX is non-nil, then we may ask the user a question. See the
2568 documentation for `checkdoc-autofix-flag' for details.
2570 If a section is auto-replaced without asking the user, this function
2571 will pause near the fixed code so the user will briefly see what
2572 happened.
2574 This function returns non-nil if the text was replaced.
2576 This function will not modify `match-data'."
2593 ;; On the off chance this is automatic, display
2594 ;; the question anyway so the user knows what's
2595 ;; going on.
2607 ret)))
2609 ;;; Warning management
2610 ;;
2624 "Set up the major mode for the buffer containing the list of errors."
2626 checkdoc-output-error-regex-alist)
2628 checkdoc-output-font-lock-keywords))
2631 "The name to use for a checkdoc buffer in the error list."
2637 "Initialize the checkdoc diagnostic buffer for a pass.
2638 Create the header so that the string CHECK-TYPE is displayed as the
2639 function called to create the messages."
2651 "Store POINT and MSG as errors in the checkdoc diagnostic buffer."
2666 "Display the checkdoc diagnostic buffer in a temporary window."
2678 nil)))
2681 "Return a list of package keywords for the current file."
2689 ;;;###autoload
2691 "Find package keywords that aren't in `finder-known-keywords'."
2717 ;;; checkdoc.el ends here