1 ;;; org-lint.el --- Linting for Org documents -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2015-2018 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <mail@nicolasgoaziou.fr>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
25 ;; This library implements linting for Org syntax. The sole public
26 ;; function is `org-lint', which see.
28 ;; Internally, the library defines a new structure:
29 ;; `org-lint-checker', with the following slots:
31 ;; - NAME: Unique check identifier, as a non-nil symbol that doesn't
32 ;; start with an hyphen.
34 ;; The check is done calling the function `org-lint-NAME' with one
35 ;; mandatory argument, the parse tree describing the current Org
36 ;; buffer. Such function calls are wrapped within
37 ;; a `save-excursion' and point is always at `point-min'. Its
38 ;; return value has to be an alist (POSITION MESSAGE) when
39 ;; POSITION refer to the buffer position of the error, as an
40 ;; integer, and MESSAGE is a string describing the error.
42 ;; - DESCRIPTION: Summary about the check, as a string.
44 ;; - CATEGORIES: Categories relative to the check, as a list of
45 ;; symbol. They are used for filtering when calling `org-lint'.
46 ;; Checkers not explicitly associated to a category are collected
47 ;; in the `default' one.
49 ;; - TRUST: The trust level one can have in the check. It is either
50 ;; `low' or `high', depending on the heuristics implemented and
51 ;; the nature of the check. This has an indicative value only and
52 ;; is displayed along reports.
54 ;; All checks have to be listed in `org-lint--checkers'.
56 ;; Results are displayed in a special "*Org Lint*" buffer with
57 ;; a dedicated major mode, derived from `tabulated-list-mode'.
59 ;; In addition to the usual key-bindings inherited from it, "C-j" and
60 ;; "TAB" display problematic line reported under point whereas "RET"
61 ;; jumps to it. Also, "h" hides all reports similar to the current
62 ;; one. Additionally, "i" removes them from subsequent reports.
64 ;; Checks currently implemented are:
66 ;; - duplicate CUSTOM_ID properties
67 ;; - duplicate NAME values
68 ;; - duplicate targets
69 ;; - duplicate footnote definitions
70 ;; - orphaned affiliated keywords
71 ;; - obsolete affiliated keywords
72 ;; - missing language in source blocks
73 ;; - missing back-end in export blocks
74 ;; - invalid Babel call blocks
75 ;; - NAME values with a colon
76 ;; - deprecated export block syntax
77 ;; - deprecated Babel header properties
78 ;; - wrong header arguments in source blocks
79 ;; - misuse of CATEGORY keyword
80 ;; - "coderef" links with unknown destination
81 ;; - "custom-id" links with unknown destination
82 ;; - "fuzzy" links with unknown destination
83 ;; - "id" links with unknown destination
84 ;; - links to non-existent local files
85 ;; - SETUPFILE keywords with non-existent file parameter
86 ;; - INCLUDE keywords with wrong link parameter
87 ;; - obsolete markup in INCLUDE keyword
88 ;; - unknown items in OPTIONS keyword
89 ;; - spurious macro arguments or invalid macro templates
90 ;; - special properties in properties drawer
91 ;; - obsolete syntax for PROPERTIES drawers
92 ;; - Invalid EFFORT property value
93 ;; - missing definition for footnote references
94 ;; - missing reference for footnote definitions
95 ;; - non-footnote definitions in footnote section
96 ;; - probable invalid keywords
98 ;; - misplaced planning info line
99 ;; - incomplete drawers
100 ;; - indented diary-sexps
101 ;; - obsolete QUOTE section
102 ;; - obsolete "file+application" link
103 ;; - spurious colons in tags
109 (require 'org-element
)
117 (cl-defstruct (org-lint-checker (:copier nil
))
118 (name 'missing-checker-name
)
120 (categories '(default))
121 (trust 'high
)) ; `low' or `high'
123 (defun org-lint-missing-checker-name (_)
125 "`A checker has no `:name' property. Please verify `org-lint--checkers'"))
127 (defconst org-lint--checkers
129 (make-org-lint-checker
130 :name
'duplicate-custom-id
131 :description
"Report duplicates CUSTOM_ID properties"
133 (make-org-lint-checker
134 :name
'duplicate-name
135 :description
"Report duplicate NAME values"
136 :categories
'(babel link
))
137 (make-org-lint-checker
138 :name
'duplicate-target
139 :description
"Report duplicate targets"
141 (make-org-lint-checker
142 :name
'duplicate-footnote-definition
143 :description
"Report duplicate footnote definitions"
144 :categories
'(footnote))
145 (make-org-lint-checker
146 :name
'orphaned-affiliated-keywords
147 :description
"Report orphaned affiliated keywords"
149 (make-org-lint-checker
150 :name
'obsolete-affiliated-keywords
151 :description
"Report obsolete affiliated keywords"
152 :categories
'(obsolete))
153 (make-org-lint-checker
154 :name
'deprecated-export-blocks
155 :description
"Report deprecated export block syntax"
156 :categories
'(obsolete export
)
158 (make-org-lint-checker
159 :name
'deprecated-header-syntax
160 :description
"Report deprecated Babel header syntax"
161 :categories
'(obsolete babel
)
163 (make-org-lint-checker
164 :name
'missing-language-in-src-block
165 :description
"Report missing language in source blocks"
166 :categories
'(babel))
167 (make-org-lint-checker
168 :name
'missing-backend-in-export-block
169 :description
"Report missing back-end in export blocks"
170 :categories
'(export))
171 (make-org-lint-checker
172 :name
'invalid-babel-call-block
173 :description
"Report invalid Babel call blocks"
174 :categories
'(babel))
175 (make-org-lint-checker
177 :description
"Report NAME values with a colon"
178 :categories
'(babel))
179 (make-org-lint-checker
180 :name
'wrong-header-argument
181 :description
"Report wrong babel headers"
182 :categories
'(babel))
183 (make-org-lint-checker
184 :name
'wrong-header-value
185 :description
"Report invalid value in babel headers"
188 (make-org-lint-checker
189 :name
'deprecated-category-setup
190 :description
"Report misuse of CATEGORY keyword"
191 :categories
'(obsolete))
192 (make-org-lint-checker
193 :name
'invalid-coderef-link
194 :description
"Report \"coderef\" links with unknown destination"
196 (make-org-lint-checker
197 :name
'invalid-custom-id-link
198 :description
"Report \"custom-id\" links with unknown destination"
200 (make-org-lint-checker
201 :name
'invalid-fuzzy-link
202 :description
"Report \"fuzzy\" links with unknown destination"
204 (make-org-lint-checker
205 :name
'invalid-id-link
206 :description
"Report \"id\" links with unknown destination"
208 (make-org-lint-checker
209 :name
'link-to-local-file
210 :description
"Report links to non-existent local files"
213 (make-org-lint-checker
214 :name
'non-existent-setupfile-parameter
215 :description
"Report SETUPFILE keywords with non-existent file parameter"
217 (make-org-lint-checker
218 :name
'wrong-include-link-parameter
219 :description
"Report INCLUDE keywords with misleading link parameter"
220 :categories
'(export)
222 (make-org-lint-checker
223 :name
'obsolete-include-markup
224 :description
"Report obsolete markup in INCLUDE keyword"
225 :categories
'(obsolete export
)
227 (make-org-lint-checker
228 :name
'unknown-options-item
229 :description
"Report unknown items in OPTIONS keyword"
230 :categories
'(export)
232 (make-org-lint-checker
233 :name
'invalid-macro-argument-and-template
234 :description
"Report spurious macro arguments or invalid macro templates"
235 :categories
'(export)
237 (make-org-lint-checker
238 :name
'special-property-in-properties-drawer
239 :description
"Report special properties in properties drawers"
240 :categories
'(properties))
241 (make-org-lint-checker
242 :name
'obsolete-properties-drawer
243 :description
"Report obsolete syntax for properties drawers"
244 :categories
'(obsolete properties
))
245 (make-org-lint-checker
246 :name
'invalid-effort-property
247 :description
"Report invalid duration in EFFORT property"
248 :categories
'(properties))
249 (make-org-lint-checker
250 :name
'undefined-footnote-reference
251 :description
"Report missing definition for footnote references"
252 :categories
'(footnote))
253 (make-org-lint-checker
254 :name
'unreferenced-footnote-definition
255 :description
"Report missing reference for footnote definitions"
256 :categories
'(footnote))
257 (make-org-lint-checker
258 :name
'extraneous-element-in-footnote-section
259 :description
"Report non-footnote definitions in footnote section"
260 :categories
'(footnote))
261 (make-org-lint-checker
262 :name
'invalid-keyword-syntax
263 :description
"Report probable invalid keywords"
265 (make-org-lint-checker
267 :description
"Report invalid blocks"
269 (make-org-lint-checker
270 :name
'misplaced-planning-info
271 :description
"Report misplaced planning info line"
273 (make-org-lint-checker
274 :name
'incomplete-drawer
275 :description
"Report probable incomplete drawers"
277 (make-org-lint-checker
278 :name
'indented-diary-sexp
279 :description
"Report probable indented diary-sexps"
281 (make-org-lint-checker
283 :description
"Report obsolete QUOTE section"
284 :categories
'(obsolete)
286 (make-org-lint-checker
287 :name
'file-application
288 :description
"Report obsolete \"file+application\" link"
289 :categories
'(link obsolete
))
290 (make-org-lint-checker
291 :name
'spurious-colons
292 :description
"Report spurious colons in tags"))
293 "List of all available checkers.")
295 (defun org-lint--collect-duplicates
296 (ast type extract-key extract-position build-message
)
297 "Helper function to collect duplicates in parse tree AST.
299 EXTRACT-KEY is a function extracting key. It is called with
300 a single argument: the element or object. Comparison is done
303 EXTRACT-POSITION is a function returning position for the report.
304 It is called with two arguments, the object or element, and the
307 BUILD-MESSAGE is a function creating the report message. It is
308 called with one argument, the key used for comparison."
313 (lambda (position value
)
314 (push (list position
(funcall build-message value
)) reports
))))
315 (org-element-map ast type
317 (let ((key (funcall extract-key datum
)))
320 ((assoc key keys
) (cl-pushnew (assoc key keys
) originals
)
321 (funcall make-report
(funcall extract-position datum key
) key
))
322 (t (push (cons key
(funcall extract-position datum key
)) keys
))))))
323 (dolist (e originals reports
) (funcall make-report
(cdr e
) (car e
)))))
325 (defun org-lint-duplicate-custom-id (ast)
326 (org-lint--collect-duplicates
330 (and (eq (compare-strings "CUSTOM_ID" nil nil
331 (org-element-property :key property
) nil nil
334 (org-element-property :value property
)))
335 (lambda (property _
) (org-element-property :begin property
))
336 (lambda (key) (format "Duplicate CUSTOM_ID property \"%s\"" key
))))
338 (defun org-lint-duplicate-name (ast)
339 (org-lint--collect-duplicates
341 org-element-all-elements
342 (lambda (datum) (org-element-property :name datum
))
344 (goto-char (org-element-property :begin datum
))
346 (format "^[ \t]*#\\+[A-Za-z]+: +%s *$" (regexp-quote name
)))
348 (lambda (key) (format "Duplicate NAME \"%s\"" key
))))
350 (defun org-lint-duplicate-target (ast)
351 (org-lint--collect-duplicates
354 (lambda (target) (split-string (org-element-property :value target
)))
355 (lambda (target _
) (org-element-property :begin target
))
357 (format "Duplicate target <<%s>>" (mapconcat #'identity key
" ")))))
359 (defun org-lint-duplicate-footnote-definition (ast)
360 (org-lint--collect-duplicates
363 (lambda (definition) (org-element-property :label definition
))
364 (lambda (definition _
) (org-element-property :post-affiliated definition
))
365 (lambda (key) (format "Duplicate footnote definition \"%s\"" key
))))
367 (defun org-lint-orphaned-affiliated-keywords (ast)
368 ;; Ignore orphan RESULTS keywords, which could be generated from
369 ;; a source block returning no value.
370 (let ((keywords (cl-set-difference org-element-affiliated-keywords
371 '("RESULT" "RESULTS")
373 (org-element-map ast
'keyword
375 (let ((key (org-element-property :key k
)))
376 (and (or (let ((case-fold-search t
))
377 (string-match-p "\\`ATTR_[-_A-Za-z0-9]+\\'" key
))
378 (member key keywords
))
379 (list (org-element-property :post-affiliated k
)
380 (format "Orphaned affiliated keyword: \"%s\"" key
))))))))
382 (defun org-lint-obsolete-affiliated-keywords (_)
383 (let ((regexp (format "^[ \t]*#\\+%s:"
384 (regexp-opt '("DATA" "LABEL" "RESNAME" "SOURCE"
385 "SRCNAME" "TBLNAME" "RESULT" "HEADERS")
388 (while (re-search-forward regexp nil t
)
389 (let ((key (upcase (match-string-no-properties 1))))
391 (org-element-property :post-affiliated
(org-element-at-point)))
393 (list (line-beginning-position)
395 "Obsolete affiliated keyword: \"%s\". Use \"%s\" instead"
404 (defun org-lint-deprecated-export-blocks (ast)
405 (let ((deprecated '("ASCII" "BEAMER" "HTML" "LATEX" "MAN" "MARKDOWN" "MD"
406 "ODT" "ORG" "TEXINFO")))
407 (org-element-map ast
'special-block
409 (let ((type (org-element-property :type b
)))
410 (when (member-ignore-case type deprecated
)
412 (org-element-property :post-affiliated b
)
414 "Deprecated syntax for export block. Use \"BEGIN_EXPORT %s\" \
418 (defun org-lint-deprecated-header-syntax (ast)
419 (let* ((deprecated-babel-properties
420 (mapcar (lambda (arg) (symbol-name (car arg
)))
421 org-babel-common-header-args-w-values
))
423 (format "\\`%s[ \t]" (regexp-opt deprecated-babel-properties t
))))
424 (org-element-map ast
'(keyword node-property
)
426 (let ((key (org-element-property :key datum
)))
427 (pcase (org-element-type datum
)
429 (let ((value (org-element-property :value datum
)))
430 (and (string= key
"PROPERTY")
431 (string-match deprecated-re value
)
432 (list (org-element-property :begin datum
)
433 (format "Deprecated syntax for \"%s\". \
434 Use header-args instead"
435 (match-string-no-properties 1 value
))))))
437 (and (member-ignore-case key deprecated-babel-properties
)
439 (org-element-property :begin datum
)
440 (format "Deprecated syntax for \"%s\". \
441 Use :header-args: instead"
444 (defun org-lint-missing-language-in-src-block (ast)
445 (org-element-map ast
'src-block
447 (unless (org-element-property :language b
)
448 (list (org-element-property :post-affiliated b
)
449 "Missing language in source block")))))
451 (defun org-lint-missing-backend-in-export-block (ast)
452 (org-element-map ast
'export-block
454 (unless (org-element-property :type b
)
455 (list (org-element-property :post-affiliated b
)
456 "Missing back-end in export block")))))
458 (defun org-lint-invalid-babel-call-block (ast)
459 (org-element-map ast
'babel-call
462 ((not (org-element-property :call b
))
463 (list (org-element-property :post-affiliated b
)
464 "Invalid syntax in babel call block"))
465 ((let ((h (org-element-property :end-header b
)))
466 (and h
(string-match-p "\\`\\[.*\\]\\'" h
)))
468 (org-element-property :post-affiliated b
)
469 "Babel call's end header must not be wrapped within brackets"))))))
471 (defun org-lint-deprecated-category-setup (ast)
472 (org-element-map ast
'keyword
476 ((not (string= (org-element-property :key k
) "CATEGORY")) nil
)
478 (list (org-element-property :post-affiliated k
)
479 "Spurious CATEGORY keyword. Set :CATEGORY: property instead"))
480 (t (setf category-flag t
) nil
))))))
482 (defun org-lint-invalid-coderef-link (ast)
483 (let ((info (list :parse-tree ast
)))
484 (org-element-map ast
'link
486 (let ((ref (org-element-property :path link
)))
487 (and (equal (org-element-property :type link
) "coderef")
488 (not (ignore-errors (org-export-resolve-coderef ref info
)))
489 (list (org-element-property :begin link
)
490 (format "Unknown coderef \"%s\"" ref
))))))))
492 (defun org-lint-invalid-custom-id-link (ast)
493 (let ((info (list :parse-tree ast
)))
494 (org-element-map ast
'link
496 (and (equal (org-element-property :type link
) "custom-id")
497 (not (ignore-errors (org-export-resolve-id-link link info
)))
498 (list (org-element-property :begin link
)
499 (format "Unknown custom ID \"%s\""
500 (org-element-property :path link
))))))))
502 (defun org-lint-invalid-fuzzy-link (ast)
503 (let ((info (list :parse-tree ast
)))
504 (org-element-map ast
'link
506 (and (equal (org-element-property :type link
) "fuzzy")
507 (not (ignore-errors (org-export-resolve-fuzzy-link link info
)))
508 (list (org-element-property :begin link
)
509 (format "Unknown fuzzy location \"%s\""
510 (let ((path (org-element-property :path link
)))
511 (if (string-prefix-p "*" path
)
515 (defun org-lint-invalid-id-link (ast)
516 (org-element-map ast
'link
518 (let ((id (org-element-property :path link
)))
519 (and (equal (org-element-property :type link
) "id")
520 (not (org-id-find id
))
521 (list (org-element-property :begin link
)
522 (format "Unknown ID \"%s\"" id
)))))))
524 (defun org-lint-special-property-in-properties-drawer (ast)
525 (org-element-map ast
'node-property
527 (let ((key (org-element-property :key p
)))
528 (and (member-ignore-case key org-special-properties
)
529 (list (org-element-property :begin p
)
531 "Special property \"%s\" found in a properties drawer"
534 (defun org-lint-obsolete-properties-drawer (ast)
535 (org-element-map ast
'drawer
537 (when (equal (org-element-property :drawer-name d
) "PROPERTIES")
538 (let ((section (org-element-lineage d
'(section))))
539 (unless (org-element-map section
'property-drawer
#'identity nil t
)
540 (list (org-element-property :post-affiliated d
)
542 (goto-char (org-element-property :post-affiliated d
))
544 (or (org-at-heading-p) (org-at-planning-p)))
545 "Incorrect contents for PROPERTIES drawer"
546 "Incorrect location for PROPERTIES drawer"))))))))
548 (defun org-lint-invalid-effort-property (ast)
549 (org-element-map ast
'node-property
551 (when (equal "EFFORT" (org-element-property :key p
))
552 (let ((value (org-element-property :value p
)))
553 (and (org-string-nw-p value
)
554 (not (org-duration-p value
))
555 (list (org-element-property :begin p
)
556 (format "Invalid effort duration format: %S" value
))))))))
558 (defun org-lint-link-to-local-file (ast)
559 (org-element-map ast
'link
561 (when (equal (org-element-property :type l
) "file")
562 (let ((file (org-link-unescape (org-element-property :path l
))))
563 (and (not (file-remote-p file
))
564 (not (file-exists-p file
))
565 (list (org-element-property :begin l
)
566 (format (if (org-element-lineage l
'(link))
567 "Link to non-existent image file \"%s\"\
569 "Link to non-existent local file \"%s\"")
572 (defun org-lint-non-existent-setupfile-parameter (ast)
573 (org-element-map ast
'keyword
575 (when (equal (org-element-property :key k
) "SETUPFILE")
576 (let ((file (org-unbracket-string
578 (org-element-property :value k
))))
579 (and (not (file-remote-p file
))
580 (not (file-exists-p file
))
581 (list (org-element-property :begin k
)
582 (format "Non-existent setup file \"%s\"" file
))))))))
584 (defun org-lint-wrong-include-link-parameter (ast)
585 (org-element-map ast
'keyword
587 (when (equal (org-element-property :key k
) "INCLUDE")
588 (let* ((value (org-element-property :value k
))
590 (and (string-match "^\\(\".+\"\\|\\S-+\\)[ \t]*" value
)
592 (org-strip-quotes (match-string 1 value
))))))
594 (list (org-element-property :post-affiliated k
)
595 "Missing location argument in INCLUDE keyword")
596 (let* ((file (org-string-nw-p
597 (if (string-match "::\\(.*\\)\\'" path
)
598 (substring path
0 (match-beginning 0))
600 (search (and (not (equal file path
))
601 (org-string-nw-p (match-string 1 path
)))))
603 (not (file-remote-p file
))
604 (not (file-exists-p file
)))
605 (list (org-element-property :post-affiliated k
)
606 "Non-existent file argument in INCLUDE keyword")
607 (let* ((visiting (if file
(find-buffer-visiting file
)
609 (buffer (or visiting
(find-file-noselect file
))))
611 (with-current-buffer buffer
615 (let ((org-link-search-inhibit-query t
))
616 (org-link-search search nil t
)))))
617 (list (org-element-property :post-affiliated k
)
619 "Invalid search part \"%s\" in INCLUDE keyword"
621 (unless visiting
(kill-buffer buffer
))))))))))))
623 (defun org-lint-obsolete-include-markup (ast)
624 (let ((regexp (format "\\`\\(?:\".+\"\\|\\S-+\\)[ \t]+%s"
626 '("ASCII" "BEAMER" "HTML" "LATEX" "MAN" "MARKDOWN" "MD"
627 "ODT" "ORG" "TEXINFO")
629 (org-element-map ast
'keyword
631 (when (equal (org-element-property :key k
) "INCLUDE")
632 (let ((case-fold-search t
)
633 (value (org-element-property :value k
)))
634 (when (string-match regexp value
)
635 (let ((markup (match-string-no-properties 1 value
)))
636 (list (org-element-property :post-affiliated k
)
637 (format "Obsolete markup \"%s\" in INCLUDE keyword. \
638 Use \"export %s\" instead"
642 (defun org-lint-unknown-options-item (ast)
643 (let ((allowed (delq nil
645 (mapcar (lambda (o) (nth 2 o
)) org-export-options-alist
)
648 (mapcar (lambda (o) (nth 2 o
))
649 (org-export-backend-options b
)))
650 org-export-registered-backends
))))
652 (org-element-map ast
'keyword
654 (when (string= (org-element-property :key k
) "OPTIONS")
655 (let ((value (org-element-property :value k
))
657 (while (string-match "\\(.+?\\):\\((.*?)\\|\\S-*\\)[ \t]*"
660 (setf start
(match-end 0))
661 (let ((item (match-string 1 value
)))
662 (unless (member item allowed
)
663 (push (list (org-element-property :post-affiliated k
)
664 (format "Unknown OPTIONS item \"%s\"" item
))
668 (defun org-lint-invalid-macro-argument-and-template (ast)
669 (let ((extract-placeholders
673 (while (string-match "\\$\\([1-9][0-9]*\\)" template start
)
674 (setf start
(match-end 0))
675 (push (string-to-number (match-string 1 template
)) args
))
676 (sort (org-uniquify args
) #'<))))
678 ;; Check arguments for macro templates.
679 (org-element-map ast
'keyword
681 (when (string= (org-element-property :key k
) "MACRO")
682 (let* ((value (org-element-property :value k
))
683 (name (and (string-match "^\\S-+" value
)
684 (match-string 0 value
)))
686 (org-trim (substring value
(match-end 0))))))
689 (push (list (org-element-property :post-affiliated k
)
690 "Missing name in MACRO keyword")
692 ((not (org-string-nw-p template
))
693 (push (list (org-element-property :post-affiliated k
)
694 "Missing template in macro \"%s\"" name
)
697 (unless (let ((args (funcall extract-placeholders template
)))
698 (equal (number-sequence 1 (or (org-last args
) 0)) args
))
699 (push (list (org-element-property :post-affiliated k
)
700 (format "Unused placeholders in macro \"%s\""
703 ;; Check arguments for macros.
704 (org-macro-initialize-templates)
705 (let ((templates (append
706 (mapcar (lambda (m) (cons m
"$1"))
707 '("author" "date" "email" "title" "results"))
708 org-macro-templates
)))
709 (org-element-map ast
'macro
711 (let* ((name (org-element-property :key macro
))
712 (template (cdr (assoc-string name templates t
))))
714 (push (list (org-element-property :begin macro
)
715 (format "Undefined macro \"%s\"" name
))
717 (let ((arg-numbers (funcall extract-placeholders template
)))
720 (nthcdr (apply #'max arg-numbers
)
721 (org-element-property :args macro
))))
724 (list (org-element-property :begin macro
)
725 (format "Unused argument%s in macro \"%s\": %s"
726 (if (> (length spurious-args
) 1) "s" "")
728 (mapconcat (lambda (a) (format "\"%s\"" a
))
734 (defun org-lint-undefined-footnote-reference (ast)
735 (let ((definitions (org-element-map ast
'footnote-definition
736 (lambda (f) (org-element-property :label f
)))))
737 (org-element-map ast
'footnote-reference
739 (let ((label (org-element-property :label f
)))
740 (and (eq 'standard
(org-element-property :type f
))
741 (not (member label definitions
))
742 (list (org-element-property :begin f
)
743 (format "Missing definition for footnote [%s]"
746 (defun org-lint-unreferenced-footnote-definition (ast)
747 (let ((references (org-element-map ast
'footnote-reference
748 (lambda (f) (org-element-property :label f
)))))
749 (org-element-map ast
'footnote-definition
751 (let ((label (org-element-property :label f
)))
753 (not (member label references
))
754 (list (org-element-property :post-affiliated f
)
755 (format "No reference for footnote definition [%s]"
758 (defun org-lint-colon-in-name (ast)
759 (org-element-map ast org-element-all-elements
761 (let ((name (org-element-property :name e
)))
763 (string-match-p ":" name
)
765 (goto-char (org-element-property :begin e
))
767 (format "^[ \t]*#\\+\\w+: +%s *$" (regexp-quote name
)))
770 "Name \"%s\" contains a colon; Babel cannot use it as input"
773 (defun org-lint-misplaced-planning-info (_)
774 (let ((case-fold-search t
)
776 (while (re-search-forward org-planning-line-re nil t
)
777 (unless (memq (org-element-type (org-element-at-point))
778 '(comment-block example-block export-block planning
779 src-block verse-block
))
780 (push (list (line-beginning-position) "Misplaced planning info line")
784 (defun org-lint-incomplete-drawer (_)
786 (while (re-search-forward org-drawer-regexp nil t
)
787 (let ((name (org-trim (match-string-no-properties 0)))
788 (element (org-element-at-point)))
789 (pcase (org-element-type element
)
790 ((or `drawer
`property-drawer
)
791 (goto-char (org-element-property :end element
))
793 ((or `comment-block
`example-block
`export-block
`src-block
797 (push (list (line-beginning-position)
798 (format "Possible incomplete drawer \"%s\"" name
))
802 (defun org-lint-indented-diary-sexp (_)
804 (while (re-search-forward "^[ \t]+%%(" nil t
)
805 (unless (memq (org-element-type (org-element-at-point))
806 '(comment-block diary-sexp example-block export-block
807 src-block verse-block
))
808 (push (list (line-beginning-position) "Possible indented diary-sexp")
812 (defun org-lint-invalid-block (_)
813 (let ((case-fold-search t
)
814 (regexp "^[ \t]*#\\+\\(BEGIN\\|END\\)\\(?::\\|_[^[:space:]]*\\)?[ \t]*")
816 (while (re-search-forward regexp nil t
)
817 (let ((name (org-trim (buffer-substring-no-properties
818 (line-beginning-position) (line-end-position)))))
820 ((and (string-prefix-p "END" (match-string 1) t
)
822 (push (list (line-beginning-position)
823 (format "Invalid block closing line \"%s\"" name
))
825 ((not (memq (org-element-type (org-element-at-point))
826 '(center-block comment-block dynamic-block example-block
827 export-block quote-block special-block
828 src-block verse-block
)))
829 (push (list (line-beginning-position)
830 (format "Possible incomplete block \"%s\""
835 (defun org-lint-invalid-keyword-syntax (_)
836 (let ((regexp "^[ \t]*#\\+\\([^[:space:]:]*\\)\\(?: \\|$\\)")
838 (format "[ \t]*#\\+%s\\(\\[.*\\]\\)?:\\(?: \\|$\\)"
839 (regexp-opt org-element-dual-keywords
)))
841 (while (re-search-forward regexp nil t
)
842 (let ((name (match-string-no-properties 1)))
843 (unless (or (string-prefix-p "BEGIN" name t
)
844 (string-prefix-p "END" name t
)
847 (let ((case-fold-search t
)) (looking-at exception-re
))))
848 (push (list (match-beginning 0)
849 (format "Possible missing colon in keyword \"%s\"" name
))
853 (defun org-lint-extraneous-element-in-footnote-section (ast)
854 (org-element-map ast
'headline
856 (and (org-element-property :footnote-section-p h
)
857 (org-element-map (org-element-contents h
)
860 (memq e
'(comment comment-block footnote-definition
861 property-drawer section
)))
862 org-element-all-elements
)
864 (not (and (eq (org-element-type e
) 'headline
)
865 (org-element-property :commentedp e
))))
866 nil t
'(footnote-definition property-drawer
))
867 (list (org-element-property :begin h
)
868 "Extraneous elements in footnote section are not exported")))))
870 (defun org-lint-quote-section (ast)
871 (org-element-map ast
'(headline inlinetask
)
873 (let ((title (org-element-property :raw-value h
)))
874 (and (or (string-prefix-p "QUOTE " title
)
875 (string-prefix-p (concat org-comment-string
" QUOTE ") title
))
876 (list (org-element-property :begin h
)
877 "Deprecated QUOTE section"))))))
879 (defun org-lint-file-application (ast)
880 (org-element-map ast
'link
882 (let ((app (org-element-property :application l
)))
884 (list (org-element-property :begin l
)
885 (format "Deprecated \"file+%s\" link type" app
)))))))
887 (defun org-lint-wrong-header-argument (ast)
890 (lambda (datum language headers
)
892 ;; If LANGUAGE is specified, restrict allowed
893 ;; headers to both LANGUAGE-specific and default
894 ;; ones. Otherwise, accept headers from any loaded
897 org-babel-header-arg-names
900 (let ((v (intern (format "org-babel-header-args:%s" l
))))
901 (and (boundp v
) (mapcar #'car
(symbol-value v
)))))
902 (if language
(list language
)
903 (mapcar #'car org-babel-load-languages
))))))
904 (dolist (header headers
)
905 (let ((h (symbol-name (car header
)))
906 (p (or (org-element-property :post-affiliated datum
)
907 (org-element-property :begin datum
))))
909 ((not (string-prefix-p ":" h
))
912 (format "Missing colon in header argument \"%s\"" h
))
914 ((assoc-string (substring h
1) allowed
))
915 (t (push (list p
(format "Unknown header argument \"%s\"" h
))
917 (org-element-map ast
'(babel-call inline-babel-call inline-src-block keyword
918 node-property src-block
)
920 (pcase (org-element-type datum
)
921 ((or `babel-call
`inline-babel-call
)
925 (cl-mapcan #'org-babel-parse-header-arguments
927 (org-element-property :inside-header datum
)
928 (org-element-property :end-header datum
)))))
932 (org-element-property :language datum
)
933 (org-babel-parse-header-arguments
934 (org-element-property :parameters datum
))))
936 (when (string= (org-element-property :key datum
) "PROPERTY")
937 (let ((value (org-element-property :value datum
)))
938 (when (string-match "\\`header-args\\(?::\\(\\S-+\\)\\)?\\+? *"
942 (match-string 1 value
)
943 (org-babel-parse-header-arguments
944 (substring value
(match-end 0))))))))
946 (let ((key (org-element-property :key datum
)))
947 (when (let ((case-fold-search t
))
948 (string-match "\\`HEADER-ARGS\\(?::\\(\\S-+\\)\\)?\\+?"
953 (org-babel-parse-header-arguments
954 (org-element-property :value datum
))))))
958 (org-element-property :language datum
)
959 (cl-mapcan #'org-babel-parse-header-arguments
960 (cons (org-element-property :parameters datum
)
961 (org-element-property :header datum
))))))))
964 (defun org-lint-wrong-header-value (ast)
967 '(babel-call inline-babel-call inline-src-block src-block
)
969 (let* ((type (org-element-type datum
))
970 (language (org-element-property :language datum
))
971 (allowed-header-values
972 (append (and language
973 (let ((v (intern (concat "org-babel-header-args:"
975 (and (boundp v
) (symbol-value v
))))
976 org-babel-common-header-args-w-values
))
978 (org-babel-parse-header-arguments
984 (cons (org-element-property :parameters datum
)
985 (org-element-property :header datum
))
988 (or (org-element-property :parameters datum
) ""))
991 (org-element-property :inside-header datum
)
993 (org-element-property :end-header datum
))))))))
994 (dolist (header datum-header-values
)
995 (let ((allowed-values
996 (cdr (assoc-string (substring (symbol-name (car header
)) 1)
997 allowed-header-values
))))
998 (unless (memq allowed-values
'(:any nil
))
999 (let ((values (cdr header
))
1001 (dolist (v (if (stringp values
) (split-string values
)
1003 (let ((valid-value nil
))
1005 (dolist (group allowed-values
)
1008 (if (stringp v
) #'assoc-string
#'assoc
)
1010 (when (memq :any group
)
1011 (setf valid-value t
)
1012 (push (cons group v
) groups-alist
)))
1013 ((assq group groups-alist
)
1016 (or (org-element-property :post-affiliated datum
)
1017 (org-element-property :begin datum
))
1019 "Forbidden combination in header \"%s\": %s, %s"
1021 (cdr (assq group groups-alist
))
1025 (t (push (cons group v
) groups-alist
)
1026 (setf valid-value t
))))
1030 (or (org-element-property :post-affiliated datum
)
1031 (org-element-property :begin datum
))
1032 (format "Unknown value \"%s\" for header \"%s\""
1038 (defun org-lint-spurious-colons (ast)
1039 (org-element-map ast
'(headline inlinetask
)
1041 (when (member "" (org-element-property :tags h
))
1042 (list (org-element-property :begin h
)
1043 "Tags contain a spurious colon")))))
1049 (defvar org-lint--report-mode-map
1050 (let ((map (make-sparse-keymap)))
1051 (set-keymap-parent map tabulated-list-mode-map
)
1052 (define-key map
(kbd "RET") 'org-lint--jump-to-source
)
1053 (define-key map
(kbd "TAB") 'org-lint--show-source
)
1054 (define-key map
(kbd "C-j") 'org-lint--show-source
)
1055 (define-key map
(kbd "h") 'org-lint--hide-checker
)
1056 (define-key map
(kbd "i") 'org-lint--ignore-checker
)
1058 "Local keymap for `org-lint--report-mode' buffers.")
1060 (define-derived-mode org-lint--report-mode tabulated-list-mode
"OrgLint"
1061 "Major mode used to display reports emitted during linting.
1062 \\{org-lint--report-mode-map}"
1063 (setf tabulated-list-format
1066 (< (string-to-number (aref (cadr a
) 0))
1067 (string-to-number (aref (cadr b
) 0))))
1071 (tabulated-list-init-header))
1073 (defun org-lint--generate-reports (buffer checkers
)
1074 "Generate linting report for BUFFER.
1076 CHECKERS is the list of checkers used.
1078 Return an alist (ID [LINE TRUST DESCRIPTION CHECKER]), suitable
1079 for `tabulated-list-printer'."
1080 (with-current-buffer buffer
1082 (goto-char (point-min))
1083 (let ((ast (org-element-parse-buffer))
1087 ;; Insert unique ID for each report. Replace buffer positions
1088 ;; with line numbers.
1096 (goto-char (car report
))
1098 (prog1 (number-to-string
1100 (count-lines last-pos
(point))))
1101 (setf last-pos
(point))))
1103 ;; Insert trust level in generated reports. Also sort them
1104 ;; by buffer position in order to optimize lines computation.
1107 (let ((trust (symbol-name (org-lint-checker-trust c
))))
1110 (list (car report
) trust
(nth 1 report
) c
))
1113 (intern (format "org-lint-%s"
1114 (org-lint-checker-name c
)))
1117 #'car-less-than-car
))))))
1119 (defvar-local org-lint--source-buffer nil
1120 "Source buffer associated to current report buffer.")
1122 (defvar-local org-lint--local-checkers nil
1123 "List of checkers used to build current report.")
1125 (defun org-lint--refresh-reports ()
1126 (setq tabulated-list-entries
1127 (org-lint--generate-reports org-lint--source-buffer
1128 org-lint--local-checkers
))
1129 (tabulated-list-print))
1131 (defun org-lint--current-line ()
1132 "Return current report line, as a number."
1133 (string-to-number (aref (tabulated-list-get-entry) 0)))
1135 (defun org-lint--current-checker (&optional entry
)
1136 "Return current report checker.
1137 When optional argument ENTRY is non-nil, use this entry instead
1139 (aref (if entry
(nth 1 entry
) (tabulated-list-get-entry)) 3))
1141 (defun org-lint--display-reports (source checkers
)
1142 "Display linting reports for buffer SOURCE.
1143 CHECKERS is the list of checkers used."
1144 (let ((buffer (get-buffer-create "*Org Lint*")))
1145 (with-current-buffer buffer
1146 (org-lint--report-mode)
1147 (setf org-lint--source-buffer source
)
1148 (setf org-lint--local-checkers checkers
)
1149 (org-lint--refresh-reports)
1150 (tabulated-list-print)
1151 (add-hook 'tabulated-list-revert-hook
#'org-lint--refresh-reports nil t
))
1152 (pop-to-buffer buffer
)))
1154 (defun org-lint--jump-to-source ()
1155 "Move to source line that generated the report at point."
1157 (let ((l (org-lint--current-line)))
1158 (switch-to-buffer-other-window org-lint--source-buffer
)
1160 (org-show-set-visibility 'local
)
1163 (defun org-lint--show-source ()
1164 "Show source line that generated the report at point."
1166 (let ((buffer (current-buffer)))
1167 (org-lint--jump-to-source)
1168 (switch-to-buffer-other-window buffer
)))
1170 (defun org-lint--hide-checker ()
1171 "Hide all reports from checker that generated the report at point."
1173 (let ((c (org-lint--current-checker)))
1174 (setf tabulated-list-entries
1175 (cl-remove-if (lambda (e) (equal c
(org-lint--current-checker e
)))
1176 tabulated-list-entries
))
1177 (tabulated-list-print)))
1179 (defun org-lint--ignore-checker ()
1180 "Ignore all reports from checker that generated the report at point.
1181 Checker will also be ignored in all subsequent reports."
1183 (setf org-lint--local-checkers
1184 (remove (org-lint--current-checker) org-lint--local-checkers
))
1185 (org-lint--hide-checker))
1191 (defun org-lint (&optional arg
)
1192 "Check current Org buffer for syntax mistakes.
1194 By default, run all checkers. With a `\\[universal-argument]' prefix ARG, \
1196 category of checkers only. With a `\\[universal-argument] \
1197 \\[universal-argument]' prefix, run one precise
1198 checker by its name.
1200 ARG can also be a list of checker names, as symbols, to run."
1202 (unless (derived-mode-p 'org-mode
) (user-error "Not in an Org buffer"))
1203 (when (called-interactively-p 'any
)
1204 (message "Org linting process starting..."))
1207 (`nil org-lint--checkers
)
1211 "Checker category: "
1212 (mapcar #'org-lint-checker-categories org-lint--checkers
)
1216 (assoc-string (org-lint-checker-categories c
) category
))
1217 org-lint--checkers
)))
1220 (let ((name (completing-read
1222 (mapcar #'org-lint-checker-name org-lint--checkers
)
1225 (dolist (c org-lint--checkers
)
1226 (when (string= (org-lint-checker-name c
) name
)
1227 (throw 'exit c
)))))))
1229 (cl-remove-if-not (lambda (c) (memq (org-lint-checker-name c
) arg
))
1230 org-lint--checkers
))
1231 (_ (user-error "Invalid argument `%S' for `org-lint'" arg
)))))
1232 (if (not (called-interactively-p 'any
))
1233 (org-lint--generate-reports (current-buffer) checkers
)
1234 (org-lint--display-reports (current-buffer) checkers
)
1235 (message "Org linting process completed"))))
1239 ;;; org-lint.el ends here