| blob | 4e8ecba4a15612a5d703c621a45bd4254d485d02 |
1 ;;; checkdoc.el --- check documentation strings for style requirements -*- lexical-binding:t -*-
3 ;; Copyright (C) 1997-1998, 2001-2018 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 <https://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."
269 ;;;###autoload(put 'checkdoc-arguments-in-order-flag 'safe-local-variable #'booleanp)
272 "Non-nil means warn if this file's package keywords are not recognized.
273 Currently, all recognized keywords must be on `finder-known-keywords'."
280 "Hook run after the standard style check is completed.
281 All functions must return nil or a string representing the error found.
282 Useful for adding new user implemented commands.
284 Each hook is called with two parameters, (DEFUNINFO ENDPOINT).
285 DEFUNINFO is the return value of `checkdoc-defun-info'. ENDPOINT is the
291 "Hook run after the standard comment style check is completed.
292 Must return nil if no errors are found, or a string describing the
299 "Non-nil means to attempt to check the voice of the doc string.
300 This check keys off some words which are commonly misused. See the
301 variable `checkdoc-common-verbs-wrong-voice' if you wish to add your own."
303 ;;;###autoload(put 'checkdoc-verb-check-experimental-flag 'safe-local-variable #'booleanp)
306 "Non-nil means generate warnings in a buffer for browsing.
307 Do not set this by hand, use a function like `checkdoc-current-buffer'
311 "A list of symbol names (strings) which also happen to make good words.
312 These words are ignored when unquoted symbols are searched for.
313 This should be set in an Emacs Lisp file's local variables."
315 ;;;###autoload(put 'checkdoc-symbol-words 'safe-local-variable #'checkdoc-list-of-strings-p)
317 ;;;###autoload
319 "Return t when OBJ is a list of strings."
320 ;; this is a function so it might be shared by checkdoc-proper-noun-list
321 ;; and/or checkdoc-ispell-lisp-words in the future
330 ;; "[.!?]" is for noun at end of a sentence, since those chars
331 ;; are symbol syntax in emacs-lisp-mode and so don't match \\_>.
332 ;; The \" allows it to be the last sentence in a docstring too.
337 ;;;###autoload(put 'checkdoc-proper-noun-regexp 'safe-local-variable 'stringp)
341 ;;;###autoload(put 'checkdoc-common-verbs-regexp 'safe-local-variable 'stringp)
423 )
424 "Alist of common words in the wrong voice and what should be used instead.
425 Set `checkdoc-verb-check-experimental-flag' to nil to avoid this costly
426 and experimental check. Do not modify this list without setting
427 the value of `checkdoc-common-verbs-regexp' to nil which cause it to
432 ;; When dealing with syntax in doc strings, make sure that - are
433 ;; encompassed in words so we can use cheap \\> to get the end of a symbol,
434 ;; not the end of a word in a conglomerate.
436 st)
439 ;;; Compatibility
440 ;;
456 ;;; User level commands
457 ;;
458 ;;;###autoload
460 "Interactively check the entire buffer for style errors.
461 The current status of the check will be displayed in a buffer which
462 the users will view as each check is completed."
468 ;; if the user set autofix to never, then that breaks the
469 ;; obviously requested asking implied by using this function.
470 ;; Set it to paranoia level.
473 'query
474 checkdoc-autofix-flag))
475 tmp)
477 ;; check the comments
485 ;; Check the documentation
492 ;; Check the message text
498 ;; Rogue spacing
507 "Display and update the status buffer for the current checkdoc mode.
508 CHECK is a list of four strings stating the current status of each
509 test; the nth string describes the status of the nth test."
522 ;;;###autoload
524 "Interactively check the current buffer for doc string errors.
525 Prefix argument START-HERE will start the checking from the current
526 point, otherwise the check starts at the beginning of the current
527 buffer. Allows navigation forward and backwards through document
528 errors. Does not check for comment or space warnings.
529 Optional argument SHOWSTATUS indicates that we should update the
530 checkdoc status window instead of the usual behavior."
536 ;; Due to a design flaw, this will never spell check
537 ;; docstrings.
540 ;; This is a workaround to perform spell checking.
543 ;;;###autoload
545 "Interactively check the current buffer for message string errors.
546 Prefix argument START-HERE will start the checking from the current
547 point, otherwise the check starts at the beginning of the current
548 buffer. Allows navigation forward and backwards through document
549 errors. Does not check for comment or space warnings.
550 Optional argument SHOWSTATUS indicates that we should update the
551 checkdoc status window instead of the usual behavior."
557 ;; Due to a design flaw, this will never spell check messages.
560 ;; This is a workaround to perform spell checking.
564 "Interactively loop over all errors that can be found by a given method.
566 If START-HERE is nil, searching starts at the beginning of the current
567 buffer, otherwise searching starts at START-HERE. SHOWSTATUS
568 expresses the verbosity of the search, and whether ending the search
569 will auto-exit this function.
571 FINDFUNC is a symbol representing a function that will position the
572 cursor, and return error message text to present to the user. It is
573 assumed that the cursor will stop just before a major sexp, which will
574 be highlighted to present the user with feedback as to the offending
575 style."
576 ;; Determine where to start the test
579 ;; Assign a flag to spellcheck flag
583 ;; Fetch the error list
587 c)
590 ;; Include whatever function point is in for good measure.
594 ;; The cursor should be just in front of the offending doc string
605 ;; Make sure the whole doc string is visible if possible.
629 ;; Exit condition
631 ;; Request an auto-fix
636 ;; `automatic-then-never' tells the autofix function
637 ;; to only allow one fix to be automatic. The autofix
638 ;; function will then set the flag to `never', allowing
639 ;; the checker to return a different error.
661 ;; Move to the next error (if available)
667 err-list nil)
673 ;; Go backwards in the list of errors
682 ;; Edit the buffer recursively.
693 err-list nil)
697 ;; Quit checkdoc
700 err-list nil
702 ;; Goofy stuff
713 ""
715 "f, y - auto Fix this warning without asking (if\
718 )
730 returnme))
733 "Interactively spell check doc strings in the current buffer.
734 If START-HERE is nil, searching starts at the beginning of the current
735 buffer, otherwise searching starts at START-HERE."
738 ;; Move point to where we need to start.
740 ;; Include whatever function point is in for good measure.
743 ;; Loop over docstrings.
753 "Interactively spell check messages in the current buffer.
754 If START-HERE is nil, searching starts at the beginning of the current
755 buffer, otherwise searching starts at START-HERE."
758 ;; Move point to where we need to start.
760 ;; Include whatever function point is in for good measure.
763 ;; Loop over message strings.
774 "Find and return the next checkdoc error list, or nil.
775 Only documentation strings are checked.
776 An error list is of the form (WARNING . POSITION) where WARNING is the
777 warning text, and POSITION is the point in the buffer where the error
778 was found. We can use points and not markers because we promise not
779 to edit the buffer before point without re-executing this check.
780 Argument ENABLE-FIX will enable auto-fixing while looking for the next
781 error. This argument assumes that the cursor is already positioned to
782 perform the fix."
793 ;; Quit.. restore position, Other errors, leave alone
795 msg)))
798 "Find and return the next checkdoc message related error list, or nil.
799 Only text for error and `y-or-n-p' strings are checked. See
800 `checkdoc-next-error' for details on the return value.
801 Argument ENABLE-FIX turns on the auto-fix feature. This argument
802 assumes that the cursor is already positioned to perform the fix."
815 ;; Quit.. restore position, Other errors, leave alone
817 msg)))
820 "Enter recursive edit to permit a user to fix some error checkdoc has found.
821 MSG is the error that was found, which is displayed in a help buffer."
836 ;;;###autoload
838 "Evaluate and check documentation for the current buffer.
839 Evaluation is done first because good documentation for something that
840 doesn't work is just not useful. Comments, doc strings, and rogue
841 spacing are all verified."
846 ;;;###autoload
848 "Check current buffer for document, comment, error style, and rogue spaces.
849 With a prefix argument (in Lisp, the argument TAKE-NOTES),
850 store all errors found in a warnings buffer,
851 otherwise stop after the first error."
855 ;; Assign a flag to spellcheck flag
860 checkdoc-autofix-flag))
865 ;; every test is responsible for returning the cursor.
877 ;;;###autoload
879 "Check FILE for document, comment, error style, and rogue spaces."
884 ;;;###autoload
886 "Start scanning the current buffer for documentation string style errors.
887 Only documentation strings are checked.
888 Use `checkdoc-continue' to continue checking if an error cannot be fixed.
889 Prefix argument TAKE-NOTES means to collect all the warning messages into
890 a separate buffer."
897 ;; Go back since we can't be here without success above.
899 nil))
901 ;;;###autoload
903 "Find the next doc string in the current buffer which has a style error.
904 Prefix argument TAKE-NOTES means to continue through the whole buffer and
905 save warnings in a separate buffer. Second optional argument START-POINT
906 is the starting location. If this is nil, `point-min' is used instead."
909 ;; Assign a flag to spellcheck flag
914 checkdoc-autofix-flag))
918 ;; If we are taking notes, encompass the whole buffer, otherwise
919 ;; the user is navigating down through the buffer.
921 ;; OK, let's look at the doc string.
934 "Move to the next doc string after point, and return t.
935 Return nil if there are no more doc strings."
939 found))
942 "When looking at a definition with a doc string, find it.
943 Move to the next doc string after point, and return t. When not
944 looking at a definition containing a doc string, return nil and
945 don't move point."
948 ;; Conservatively skip syntax errors.
952 ;; Require an initializer, i.e. ignore single-argument `defvar'
953 ;; forms, which never have a doc string.
956 ;; Skip over function or macro name, symbol to be defined, and
957 ;; initializer or argument list.
960 t)))
962 ;;;###autoload
964 "Find missing comment sections in the current Emacs Lisp file.
965 Prefix argument TAKE-NOTES non-nil means to save warnings in a
966 separate buffer. Otherwise print a message. This returns the error
967 if there is one."
981 e))
983 ;;;###autoload
985 "Find extra spaces at the end of lines in the current file.
986 Prefix argument TAKE-NOTES non-nil means to save warnings in a
987 separate buffer. Otherwise print a message. This returns the error
988 if there is one.
989 Optional argument INTERACT permits more interactive fixing."
997 e
1003 ;;;###autoload
1005 "Scan the buffer for occurrences of the error function, and verify text.
1006 Optional argument TAKE-NOTES causes all errors to be logged."
1015 e
1023 ;;;###autoload
1025 "Evaluate the current form with `eval-defun' and check its documentation.
1026 Evaluation is done first so the form will be read before the
1027 documentation is checked. If there is a documentation error, then the display
1028 of what was evaluated will be overwritten by the diagnostic message."
1033 ;;;###autoload
1035 "Examine the doc string of the function or variable under point.
1036 Call `error' if the doc string has problems. If NO-ERROR is
1037 non-nil, then do not call error, but call `message' instead.
1038 If the doc string passes the test, then check the function for rogue white
1039 space at the end of each line."
1059 ;;; Ispell interface for forcing a spell check
1060 ;;
1062 ;;;###autoload
1064 "Check the style and spelling of everything interactively.
1065 Calls `checkdoc' with spell-checking turned on.
1066 Prefix argument is the same as for `checkdoc'"
1071 ;;;###autoload
1073 "Check the style and spelling of the current buffer.
1074 Calls `checkdoc-current-buffer' with spell-checking turned on.
1075 Prefix argument is the same as for `checkdoc-current-buffer'"
1080 ;;;###autoload
1082 "Check the style and spelling of the current buffer interactively.
1083 Calls `checkdoc-interactive' with spell-checking turned on.
1084 Prefix argument is the same as for `checkdoc-interactive'"
1089 ;;;###autoload
1091 "Check the style and spelling of message text interactively.
1092 Calls `checkdoc-message-interactive' with spell-checking turned on.
1093 Prefix argument is the same as for `checkdoc-message-interactive'"
1097 nil current-prefix-arg)))
1099 ;;;###autoload
1101 "Check the style and spelling of message text interactively.
1102 Calls `checkdoc-message-text' with spell-checking turned on.
1103 Prefix argument is the same as for `checkdoc-message-text'"
1108 ;;;###autoload
1110 "Check the style and spelling of the current buffer.
1111 Calls `checkdoc-start' with spell-checking turned on.
1112 Prefix argument is the same as for `checkdoc-start'"
1117 ;;;###autoload
1119 "Check the style and spelling of the current buffer after point.
1120 Calls `checkdoc-continue' with spell-checking turned on.
1121 Prefix argument is the same as for `checkdoc-continue'"
1126 ;;;###autoload
1128 "Check the style and spelling of the current buffer's comments.
1129 Calls `checkdoc-comments' with spell-checking turned on.
1130 Prefix argument is the same as for `checkdoc-comments'"
1135 ;;;###autoload
1137 "Check the style and spelling of the current defun with Ispell.
1138 Calls `checkdoc-defun' with spell-checking turned on.
1139 Prefix argument is the same as for `checkdoc-defun'"
1144 ;;; Error Management
1145 ;;
1146 ;; Errors returned from checkdoc functions can have various
1147 ;; features and behaviors, so we need some ways of specifying
1148 ;; them, and making them easier to use in the wacked-out interfaces
1149 ;; people are requesting
1151 "Function called when Checkdoc encounters an error.
1152 Should accept as arguments (TEXT START END &optional UNFIXABLE).
1154 TEXT is the descriptive text of the error. START and END define the region
1155 it is sensible to highlight when describing the problem.
1156 Optional argument UNFIXABLE means that the error has no auto-fix available.
1158 A list of the form (TEXT START END UNFIXABLE) is returned if we are not
1162 "Used to create the return error text returned from all engines.
1163 TEXT, START, END and UNFIXABLE conform to
1164 `checkdoc-create-error-function', which see."
1168 "Create an error for Checkdoc.
1169 TEXT, START, END and UNFIXABLE conform to
1170 `checkdoc-create-error-function', which see."
1173 nil)
1177 "Return the text specified in the checkdoc ERR."
1178 ;; string-p part is for backwards compatibility
1182 "Return the start point specified in the checkdoc ERR."
1183 ;; string-p part is for backwards compatibility
1187 "Return the end point specified in the checkdoc ERR."
1188 ;; string-p part is for backwards compatibility
1192 "Return the t if we cannot autofix the error specified in the checkdoc ERR."
1193 ;; string-p part is for backwards compatibility
1196 ;;; Minor Mode specification
1197 ;;
1202 ;; Override some bindings
1208 ;; Add some new bindings under C-c ?
1226 ;; bind our submap into map
1228 map)
1231 ;; Add in a menubar with easy-menu
1234 nil checkdoc-minor-mode-map "Checkdoc Minor Mode Menu"
1240 "---"
1249 checkdoc-ispell-message-interactive t]
1254 buffer-file-name]
1256 "---"
1261 ))
1262 ;; XEmacs requires some weird stuff to add this menu in a minor mode.
1263 ;; What is it?
1265 ;;;###autoload
1267 "Toggle automatic docstring checking (Checkdoc minor mode).
1268 With a prefix argument ARG, enable Checkdoc minor mode if ARG is
1269 positive, and disable it otherwise. If called from Lisp, enable
1270 the mode if ARG is omitted or nil.
1272 In Checkdoc minor mode, the usual bindings for `eval-defun' which is
1273 bound to \\<checkdoc-minor-mode-map>\\[checkdoc-eval-defun] and `checkdoc-eval-current-buffer' are overridden to include
1274 checking of documentation strings.
1277 nil checkdoc-minor-mode-string nil
1280 ;;; Subst utils
1281 ;;
1283 "Run hooks in HOOKVAR with ARGS."
1286 ;; This method was similar to above. We ignore the warning
1287 ;; since we will use the above for future Emacs versions
1291 "Rebuild the contents of `checkdoc-common-verbs-regexp'."
1299 ;; Profiler says this is not yet faster than just calling assoc
1300 ;;(defun checkdoc-word-in-alist-vector (word vector)
1301 ;; "Check to see if WORD is in the car of an element of VECTOR.
1302 ;;VECTOR must be sorted. The CDR should be a replacement. Since the
1303 ;;word list is getting bigger, it is time for a quick bisecting search."
1304 ;; (let ((max (length vector)) (min 0) i
1305 ;; (found nil) (fw nil))
1306 ;; (setq i (/ max 2))
1307 ;; (while (and (not found) (/= min max))
1308 ;; (setq fw (car (aref vector i)))
1309 ;; (cond ((string= word fw) (setq found (cdr (aref vector i))))
1310 ;; ((string< word fw) (setq max i))
1311 ;; (t (setq min i)))
1312 ;; (setq i (/ (+ max min) 2))
1313 ;; )
1314 ;; found))
1316 ;;; Checking engines
1317 ;;
1319 "Return a message string if the current doc string is invalid.
1320 Check for style only, such as the first line always being a complete
1321 sentence, whitespace restrictions, and making sure there are no
1322 hard-coded key-codes such as C-[char] or mouse-[number] in the comment.
1323 See the style guide in the Emacs Lisp manual for more details."
1325 ;; Jump over comments between the last object and the doc string
1334 err
1335 ;; * Every command, function, or variable intended for users to know
1336 ;; about should have a documentation string.
1337 ;;
1338 ;; * An internal variable or subroutine of a Lisp program might as well
1339 ;; have a documentation string. In earlier Emacs versions, you could
1340 ;; save space by using a comment instead of a documentation string,
1341 ;; but that is no longer the case.
1346 ;; Sometimes old code has comments where the documentation should
1347 ;; be. Let's see if we can find the comment, and offer to turn it
1348 ;; into documentation for them.
1364 ;; Our point is at the beginning of the comment!
1365 ;; Insert a quote, then remove the comment chars.
1384 ;; quote any double-quote characters in the comment.
1390 "You should convert this comment to documentation"
1394 "All interactive functions should have documentation"
1395 "All variables and subroutines might as well have a \
1401 err)))
1404 "Return an error list or string if the current doc string is invalid.
1405 Depends on `checkdoc-this-string-valid' to reset the syntax table so that
1406 regexp short cuts work. FP is the function defun information."
1408 ;; Use a marker so if an early check modifies the text,
1409 ;; we won't accidentally lose our place. This could cause
1410 ;; end-of doc string whitespace to also delete the " char.
1416 ;; * *Do not* indent subsequent lines of a documentation string so that
1417 ;; the text is lined up in the source code with the text of the first
1418 ;; line. This looks nice in the source code, but looks bizarre when
1419 ;; users view the documentation. Remember that the indentation
1420 ;; before the starting double-quote is not part of the string!
1428 "Remove this whitespace? "
1430 nil
1432 "Second line should not have indentation"
1435 ;; * Check for '(' in column 0.
1442 nil
1444 "Open parenthesis in column 0 should be escaped"
1446 ;; * Do not start or end a documentation string with whitespace.
1459 nil
1461 "Documentation strings should not start or end with whitespace"
1462 start end))))
1463 ;; * The first line of the documentation string should consist of one
1464 ;; or two complete sentences that stand on their own as a summary.
1465 ;; `M-x apropos' displays just the first line, and if it doesn't
1466 ;; stand on its own, the result looks bad. In particular, start the
1467 ;; first line with a capital letter and end with a period.
1475 ;; A backslashed double quote at the end of a sentence
1477 ;; We might have to add a period in this case
1480 nil
1485 nil
1487 "First sentence should end with punctuation"
1490 ;; These are ok
1491 nil)
1493 nil)
1495 ;; If it is not a complete sentence, let's see if we can
1496 ;; predict a clever way to make it one.
1501 ;; Here we have found a complete sentence, but no break.
1504 "First line not a complete sentence. Add RET here? "
1515 ;; We can merge these lines! Replace this CR
1516 ;; with a space.
1519 ;; Let's see if there is enough room to draw the next
1520 ;; line's sentence up here. I often get hit w/
1521 ;; auto-fill moving my words around.
1531 "1st line not a complete sentence. Join these lines? "
1534 ;; They said yes. We have more fill work to do...
1543 ;; Continuation of above. Make sure our sentence is capitalized.
1550 t)
1551 nil
1553 "First line should be capitalized"
1555 nil))
1556 ;; * Don't write key sequences directly in documentation strings.
1557 ;; Instead, use the `\\[...]' construct to stand for them.
1562 ;; Find the first key sequence not in a sample
1572 ;; It is not practical to use `\\[...]' very many times, because
1573 ;; display of the documentation string will become slow. So use this
1574 ;; to describe the most important commands in your major mode, and
1575 ;; then use `\\{...}' to display the rest of the mode's keymap.
1583 ;; Ambiguous quoted symbol. When a symbol is both bound and fbound,
1584 ;; and is referred to in documentation, it should be prefixed with
1585 ;; something to disambiguate it. This check must be before the
1586 ;; 80 column check because it will probably break that.
1605 ;; We didn't actually replace anything. Here we find
1606 ;; out what special word form they wish to use as
1607 ;; a prefix.
1610 "Disambiguating Keyword (default variable): "
1622 nil)))
1623 ;; * Format the documentation string so that it fits in an
1624 ;; Emacs window on an 80-column screen. It is a good idea
1625 ;; for most lines to be no wider than 60 characters. The
1626 ;; first line can be wider if necessary to fit the
1627 ;; information that ought to be there.
1636 eol t))
1642 "Some lines are over 80 columns wide"
1644 ;; Here we deviate to tests based on a variable or function.
1645 ;; We must do this before checking for symbols in quotes because there
1646 ;; is a chance that just such a symbol might really be an argument.
1648 ;; This is if we are in a variable
1650 ;; * The documentation string for a variable that is a
1651 ;; yes-or-no flag should start with words such as Non-nil
1652 ;; means..., to make it clear that all non-nil values are
1653 ;; equivalent and indicate explicitly what nil and non-nil
1654 ;; mean.
1655 ;; * If a user option variable records a true-or-false
1656 ;; condition, give it a name that ends in `-flag'.
1658 ;; "True ..." should be "Non-nil ..."
1664 nil
1669 ;; If the variable has -flag in the name, make sure
1673 "Flag variable doc strings should usually start: Non-nil means"
1675 ;; Don't rename variable to "foo-flag". This is unnecessary
1676 ;; and such names often end up inconvenient when the variable
1677 ;; is later expanded to non-boolean values. --Stef
1678 ;; If the doc string starts with "Non-nil means"
1679 ;; (if (and (looking-at "\"\\*?Non-nil\\s-+means\\s-+")
1680 ;; (not (string-match "-flag$" (car fp))))
1681 ;; (let ((newname
1682 ;; (if (string-match "-p$" (car fp))
1683 ;; (concat (substring (car fp) 0 -2) "-flag")
1684 ;; (concat (car fp) "-flag"))))
1685 ;; (if (checkdoc-y-or-n-p
1686 ;; (format
1687 ;; "Rename to %s and Query-Replace all occurrences? "
1688 ;; newname))
1689 ;; (progn
1690 ;; (beginning-of-defun)
1691 ;; (query-replace-regexp
1692 ;; (concat "\\<" (regexp-quote (car fp)) "\\>")
1693 ;; newname))
1694 ;; (checkdoc-create-error
1695 ;; "Flag variable names should normally end in `-flag'" s
1696 ;; (marker-position e)))))
1697 ;; Done with variables
1698 ))
1700 ;; This if we are in a function definition
1702 ;; * When a function's documentation string mentions the value
1703 ;; of an argument of the function, use the argument name in
1704 ;; capital letters as if it were a name for that value. Thus,
1705 ;; the documentation string of the function `/' refers to its
1706 ;; second argument as `DIVISOR', because the actual argument
1707 ;; name is `divisor'.
1709 ;; Addendum: Make sure they appear in the doc in the same
1710 ;; order that they are found in the arg list.
1721 inopts t)
1726 ;; Require whitespace OR
1727 ;; ITEMth<space> OR
1728 ;; ITEMs<space>
1730 e t)))
1733 ;; If the symbol was not found, let's see if we
1734 ;; can find it with a different capitalization
1735 ;; and see if the user wants to capitalize it.
1739 ;; Require whitespace OR
1740 ;; ITEMth<space> OR
1741 ;; ITEMs<space>
1743 e t))
1747 "If this is the argument `%s', it should appear as %s. Fix? "
1753 ;; It wasn't found at all! Offer to attach this new symbol
1754 ;; to the end of the documentation string.
1757 "Add %s documentation to end of doc string? "
1759 ;; Now do some magic and invent a doc string.
1770 nil)
1773 "Argument `%s' should appear (as %s) in the doc string"
1780 "Arguments occur in the doc string out of order"
1782 ;; * For consistency, phrase the verb in the first sentence of a
1783 ;; documentation string for functions as an imperative.
1784 ;; For instance, use `Return the cons of A and
1785 ;; B.' in preference to `Returns the cons of A and B.'
1786 ;; Usually it looks good to do likewise for the rest of the
1787 ;; first paragraph. Subsequent paragraphs usually look better
1788 ;; if they have proper subjects.
1789 ;;
1790 ;; This is the least important of the above tests. Make sure
1791 ;; it occurs last.
1794 ;; Maybe rebuild the monster-regexp
1798 ;; check string-continuation
1805 checkdoc-common-verbs-regexp
1806 lim t))
1810 checkdoc-common-verbs-wrong-voice))
1820 replace t)
1823 ;; there was a match, but no replace
1827 original replace)
1829 ;; "Return true ..." should be "Return non-nil ..."
1835 nil
1839 ;; Done with functions
1840 )))
1841 ;;* When a documentation string refers to a Lisp symbol, write it as
1842 ;; it would be printed (which usually means in lower case), with
1843 ;; single-quotes around it. For example: ‘lambda’. There are two
1844 ;; exceptions: write t and nil without single-quotes. (For
1845 ;; compatibility with an older Emacs style, quoting with ` and '
1846 ;; also works, e.g., `lambda' is treated like ‘lambda’.)
1851 ;; Ignore manual page references like
1852 ;; git-config(1).
1854 e t))
1856 ;; A . is a \s_ char, so we must remove periods from
1857 ;; sentences more carefully.
1880 nil)))
1881 ;; t and nil case
1889 nil
1891 "Symbols t and nil should not appear in single quotes"
1893 ;; Here is some basic sentence formatting
1895 ;; Here are common proper nouns that should always appear capitalized.
1897 ;; Make sure the doc string has correctly spelled English words
1898 ;; in it. This function is extracted due to its complexity,
1899 ;; and reliance on the Ispell program.
1901 ;; User supplied checks
1903 ;; Done!
1904 )))
1907 "Return a list of details about the current sexp.
1908 It is a list of the form:
1909 (NAME VARIABLE INTERACTIVE NODOCPARAMS PARAMETERS ...)
1910 where NAME is the name, VARIABLE is t if this is a `defvar',
1911 INTERACTIVE is nil if this is not an interactive function, otherwise
1912 it is the position of the `interactive' call, and PARAMETERS is a
1913 string which is the name of each variable in the function's argument
1914 list. The NODOCPARAMS is a sublist of parameters specified by a checkdoc
1915 comment for a given defun. If the first element is not a string, then
1916 the token checkdoc-order: <TOKEN> exists, and TOKEN is a symbol read
1917 from the comment."
1933 ;; The variable spot
1935 ;; Interactive
1940 t)
1941 ret)))
1945 ;; Overload th main obarray so read doesn't intern the
1946 ;; local symbols of the function we are checking.
1947 ;; Without this we end up cluttering the symbol space w/
1948 ;; useless symbols.
1950 ;; Ok, check for checkdoc parameter comment here
1958 t)
1964 t)
1978 sl1)
1979 ret)))
1980 ;; Read the list of parameters, but do not put the symbols in
1981 ;; the standard obarray.
1983 ;; This is because read will intern nil if it doesn't into the
1984 ;; new obarray.
1993 "Return non-nil if the current point is in a code fragment.
1994 A code fragment is identified by an open parenthesis followed by a
1995 symbol which is a valid function or a word in all CAPS, or a parenthesis
1997 is allowed while searching for the bounding parenthesis."
2008 ;; if this string is function bound, we are in
2009 ;; sample code. If it has a - or : character in
2010 ;; the name, then it is probably supposed to be bound
2011 ;; but isn't yet.
2020 The text checked is between START and LIMIT."
2031 "Check all text between BEGIN and END for lower case proper nouns.
2032 These are Emacs centric proper nouns which should be capitalized for
2033 consistency. Return an error list if any are not fixed, but
2034 internally skip over no answers.
2035 If the offending word is in a piece of quoted text, then it is skipped."
2049 ;; surrounded by /, as in a URL or filename: /emacs/
2053 ;; info or url links left alone
2055 help-xref-info-regexp))
2057 help-xref-url-regexp)))
2060 text)
2062 nil
2064 ;; If there is already an error, then generate
2065 ;; the warning output if applicable
2069 "Name %s should appear capitalized as %s"
2071 b e))
2074 "Name %s should appear capitalized as %s"
2076 bb b be e)))))))
2080 "Make sure all sentences have double spaces between BEGIN and END."
2097 ;; piece of an abbreviation
2098 ;; FIXME etc
2103 b e
2104 "There should be two spaces after a period. Fix? "
2106 nil
2108 ;; If there is already an error, then generate
2109 ;; the warning output if applicable
2112 "There should be two spaces after a period"
2113 b e))
2115 "There should be two spaces after a period"
2116 bb b be e)))))))
2119 ;;; Ispell engine
2120 ;;
2125 "Initialize Ispell process (default version) with Lisp words.
2126 The words used are from `checkdoc-ispell-lisp-words'. If `ispell'
2127 cannot be loaded, then set `checkdoc-spellcheck-documentation-flag' to
2128 nil."
2134 ;; This code copied in part from ispell.el Emacs 19.34
2140 "Run the Ispell tools on the doc string between point and END.
2141 Since Ispell isn't Lisp-smart, we must pre-process the doc string
2142 before using the Ispell engine on it."
2144 ;; If the user wants no questions or fixing, then we must
2145 ;; disable spell checking as not useful.
2148 nil
2155 ;; Skip lists describing meta-syntax, or bound variables
2163 ;; This is probably repetitive in most cases, but not always.
2164 nil
2165 ;; Find out how we spell-check this word.
2167 ;; All caps w/ option th, or s tacked on the end
2168 ;; for pluralization or number.
2171 )
2172 nil
2181 ;; Nothing here.
2182 )))))
2184 err))))
2186 ;;; Rogue space checking engine
2187 ;;
2189 "Return a message list if there is a line with white space at the end.
2190 If `checkdoc-autofix-flag' permits, delete that whitespace instead.
2191 If optional arguments START and END are non-nil, bound the check to
2192 this region.
2193 Optional argument INTERACT may permit the user to fix problems on the fly."
2197 ;; If end is nil, it means end of buffer to search anyway
2199 ;; Check for an error if `? ' or `?\ ' is used at the end of a line.
2200 ;; (It's dangerous)
2205 "Don't use `? ' at the end of a line. \
2206 News agents may remove it"
2208 ;; If interactive is passed down, give them a chance to fix things.
2215 ;; Check for, and potentially remove whitespace appearing at the
2216 ;; end of different lines.
2219 ;; There is no documentation in the Emacs Lisp manual about this check,
2220 ;; it is intended to help clean up messy code and reduce the file size.
2222 ;; This is not a complex activity
2226 nil
2229 ;; Return an error and leave the cursor at that spot, or restore
2230 ;; the cursor.
2234 nil)))
2236 ;;; Comment checking engine
2237 ;;
2246 "Return a message list if this file does not match the Emacs standard.
2247 This checks for style only, such as the first line, Commentary:,
2248 Code:, and others referenced in the style guide."
2250 nil
2252 ;; Old XEmacs don't have `lm-commentary-mark'
2261 ;; This file has been set up where ERR is a variable. Each check is
2262 ;; asked, and the function will make sure that if the user does not
2263 ;; auto-fix some error, that we still move on to the next auto-fix,
2264 ;; AND we remember the past errors.
2266 err
2267 ;; Lisp Maintenance checks first
2268 ;; Was: (lm-verify) -> not flexible enough for some people
2269 ;; * Summary at the beginning of the file:
2271 ;; This certifies as very complex so always ask unless
2272 ;; it's set to never
2281 nil))
2283 err
2285 ;; * Commentary Section
2292 nil t)
2305 nil nil t)))
2306 nil)
2307 err))
2309 err
2311 ;; * History section. Say nothing if there is a file ChangeLog
2316 nil
2322 nil t)
2334 err))
2336 err
2338 ;; * Code section
2341 pos)
2343 ;; match ";;;###autoload" cookie to keep it with the form
2350 nil t))
2358 nil)
2362 nil)
2363 err))
2365 err
2367 ;; * A footer. Not compartmentalized from lm-verify: too bad.
2368 ;; The following is partially clipped from lm-verify
2376 nil t))
2383 fn fn fe)
2385 err))
2386 ;; The below checks will not return errors if the user says NO
2388 ;; Let's spellcheck the commentary section. This is the only
2389 ;; section that is easy to pick out, and it is also the most
2390 ;; visible section (with the finder).
2396 ;; Since the comments talk about Lisp, use the
2397 ;; specialized spell-checker we also used for doc
2398 ;; strings.
2403 err
2405 ;; Generic Full-file checks (should be comment related)
2407 err))
2408 ;; Done with full file comment checks
2409 err)))
2412 "Return t if point is outside the bounds of a valid sexp."
2419 ;;; `error' and `message' text verifier.
2420 ;;
2422 "Search between BEG and END for a style error with message text.
2423 Optional arguments BEG and END represent the boundary of the check.
2424 The default boundary is the entire buffer."
2431 e))
2434 "Move cursor to the next checkable message string after point.
2435 Return the message classification.
2436 Argument END is the maximum bounds to search in."
2455 nil
2457 return))
2460 "Return or fix errors found in strings passed to a message display function.
2461 According to the documentation for the function `error', the error list
2462 should not end with a period, and should start with a capital letter.
2463 The function `y-or-n-p' has similar constraints.
2464 Argument TYPE specifies the type of question, such as `error' or `y-or-n-p'."
2465 ;; If type is nil, then attempt to derive it.
2477 ;; From the documentation of the symbol `error':
2478 ;; In Emacs, the convention is that error messages start with a capital
2479 ;; letter but *do not* end with a period. Please follow this convention
2480 ;; for the sake of consistency.
2485 "Capitalize your message text? "
2487 t)))
2489 "Messages should start with a capital letter"
2491 nil)
2492 ;; In general, sentences should have two spaces after the period.
2496 ;; Look for proper nouns in this region too.
2500 ;; Here are message type specific questions.
2507 "Remove period from error? "
2508 ""
2509 t)))
2511 "Error messages should *not* end with a period"
2513 nil)
2514 ;; `y-or-n-p' documentation explicitly says:
2515 ;; It should end in a space; `y-or-n-p' adds `(y or n) ' to it.
2516 ;; I added the ? requirement. Without it, it is unclear that we
2517 ;; ask a question and it appears to be an undocumented style.
2522 nil
2526 ;; If we see a ?, then replace with "? ".
2532 nil
2544 nil
2557 nil
2561 ;; Now, let's just run the spell checker on this guy.
2564 )))
2566 ;;; Auto-fix helper functions
2567 ;;
2569 "Like `y-or-n-p', but pays attention to `checkdoc-autofix-flag'.
2570 Argument QUESTION is the prompt passed to `y-or-n-p'."
2574 nil
2581 "Highlight between START and END and queries the user with QUESTION.
2582 If the user says yes, or if `checkdoc-autofix-flag' permits, replace
2583 the region marked by START and END with REPLACEWITH. If optional flag
2584 COMPLEX is non-nil, then we may ask the user a question. See the
2585 documentation for `checkdoc-autofix-flag' for details.
2587 If a section is auto-replaced without asking the user, this function
2588 will pause near the fixed code so the user will briefly see what
2589 happened.
2591 This function returns non-nil if the text was replaced.
2593 This function will not modify `match-data'."
2610 ;; On the off chance this is automatic, display
2611 ;; the question anyway so the user knows what's
2612 ;; going on.
2624 ret)))
2626 ;;; Warning management
2627 ;;
2641 "Set up the major mode for the buffer containing the list of errors."
2643 checkdoc-output-error-regex-alist)
2645 checkdoc-output-font-lock-keywords))
2648 "The name to use for a checkdoc buffer in the error list."
2654 "Initialize the checkdoc diagnostic buffer for a pass.
2655 Create the header so that the string CHECK-TYPE is displayed as the
2656 function called to create the messages."
2668 "Store POINT and MSG as errors in the checkdoc diagnostic buffer."
2683 "Display the checkdoc diagnostic buffer in a temporary window."
2695 nil)))
2698 "Return a list of package keywords for the current file."
2706 ;;;###autoload
2708 "Find package keywords that aren't in `finder-known-keywords'."
2734 ;;; checkdoc.el ends here