Re: [PATCH] Add next-error support to org-lint report buffer

[Malcolm Purvis <malcolm@purvis.id.au>]

[-- Attachment #1: Type: text/plain, Size: 705 bytes --]

Thanks for the review and happy new year..
 
>> -| {{{kbd(S)}}} | Sort reports by the column at point | 
> Looks like you deleted this line by accident. 

I've restored this in the patch below.
 
> I just tried your patch on an Org file with 2 warnings and tried 
> to press C-x ` repeatedly. Upon moving to the last line in *Org 
> lint* buffer, I got 
 
This is a bug in the original org-lint code, where this error was 
raised it you pressed <RET> on the line after the list in the 
report.  The next error code just did the same thing.

I've included a fix for that to ignore requests to just to the 
source when not in the list of errors.

Malcolm
-- 
          Malcolm Purvis <malcolm@purvis.id.au>

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Add-next-error-support-to-org-lint-report-buffer.patch --]
[-- Type: text/x-patch, Size: 4502 bytes --]

From 72a4e81238a78af1a58c49c1418cffb4032f3bfd Mon Sep 17 00:00:00 2001
From: Malcolm Purvis <malcolm@purvis.id.au>
Date: Sat, 14 Dec 2024 17:18:09 +1100
Subject: [PATCH 1/3] Add next-error support to org-lint report buffer

* doc/org-manual.org (Org Syntax): Add next-error keybinding

* etc/ORG-NEWS:

* lisp/org-lint.el: Register org-lint report buffer with next-error
infra.  Add callback function to display error.
---
 doc/org-manual.org | 12 ++++++------
 etc/ORG-NEWS       |  5 +++++
 lisp/org-lint.el   | 35 +++++++++++++++++++++++++++++++++++
 3 files changed, 46 insertions(+), 6 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index d95a9350e..7f6683428 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -20874,12 +20874,12 @@ a "trust level", since false-positive are possible.  From there, you
 can operate on the reports with the following keys:
 
 #+attr_texinfo: :columns 0.22 0.78
-| {{{kbd(C-j)}}}, {{{kbd(TAB)}}} | Display the offending line                  |
-| {{{kbd(RET)}}}                 | Move point to the offending line            |
-| {{{kbd(g)}}}                   | Check the document again                    |
-| {{{kbd(h)}}}                   | Hide all reports from the same checker      |
-| {{{kbd(i)}}}                   | Also remove them from all subsequent checks |
-| {{{kbd(S)}}}                   | Sort reports by the column at point         |
+| {{{kbd(C-j)}}}, {{{kbd(TAB)}}} | Display the offending line                             |
+| {{{kbd(RET)}}}                 | Move point to the offending line                       |
+| {{{kbd(C-x `)}}}               | Move to the next report and display the offending line |
+| {{{kbd(g)}}}                   | Check the document again                               |
+| {{{kbd(h)}}}                   | Hide all reports from the same checker                 |
+| {{{kbd(i)}}}                   | Also remove them from all subsequent checks            |
 
 ** Context Dependent Documentation
 :PROPERTIES:
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 08857962b..a38b761ad 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -355,6 +355,11 @@ The Texinfo exporter no longer removes links from headings.  This
 applies to all headings, below and above the =H= and =toc= export
 =#+OPTIONS:=.
 
+*** next-error supports =org-lint= reports
+
+The command =next-error= can now be used to jump to the next
+=org-lint= error.
+
 * Version 9.7
 
 ** Important announcements and breaking changes
diff --git a/lisp/org-lint.el b/lisp/org-lint.el
index c85d839bc..040934235 100644
--- a/lisp/org-lint.el
+++ b/lisp/org-lint.el
@@ -172,6 +172,35 @@ are additional check identifiers to be removed."
 \f
 ;;; Reports UI
 
+;; next-error support
+(defvar org-lint--next-error-top-of-buffer t
+  "Is the next error the one at the first line of the buffer?
+
+Unlike compilation and grep buffers the first line of the org lint
+report refers to an error.  This needs special handling.")
+
+(defun org-lint--next-error-function (n &optional reset)
+  "Find and display the next line error in the report.
+N is an integer specifying by how many errors to move.
+RESET is a boolean which, if non-nil, says to go back to the beginning
+of the errors before moving.
+
+This function is the local support for the next-error machinery."
+  (when reset
+    (setq org-lint--next-error-top-of-buffer t)
+    (goto-char (point-min)))
+  (when org-lint--next-error-top-of-buffer
+    (setq
+     org-lint--next-error-top-of-buffer nil
+     n (1- n))) ; In compilation buffers, point starts before the
+                ; first error, so stepping forward one brings you to
+                ; the first error.  Here the first error is on the
+                ; first line so adjust the count accordingly.
+  (forward-line n)
+  (org-lint--show-source))
+
+;; Report mode
+
 (defvar org-lint--report-mode-map
   (let ((map (make-sparse-keymap)))
     (set-keymap-parent map tabulated-list-mode-map)
@@ -186,6 +215,12 @@ are additional check identifiers to be removed."
 (define-derived-mode org-lint--report-mode tabulated-list-mode "OrgLint"
   "Major mode used to display reports emitted during linting.
 \\{org-lint--report-mode-map}"
+  ;; next-error support.
+  (make-local-variable 'org-lint--next-error-top-of-buffer)
+  (setq
+   next-error-function 'org-lint--next-error-function
+   next-error-last-buffer (current-buffer))
+
   (setf tabulated-list-format
 	`[("Line" 6
 	   (lambda (a b)
-- 
2.47.1


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: 0002-Restore-missing-keybinding-documentation.patch --]
[-- Type: text/x-patch, Size: 927 bytes --]

From 863afe940e5778ef813f34629caf3d5a4449959f Mon Sep 17 00:00:00 2001
From: Malcolm Purvis <malcolm@purvis.id.au>
Date: Thu, 2 Jan 2025 21:35:36 +1100
Subject: [PATCH 2/3] Restore missing keybinding documentation

---
 doc/org-manual.org | 1 +
 1 file changed, 1 insertion(+)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index 7f6683428..89ce86a46 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -20880,6 +20880,7 @@ can operate on the reports with the following keys:
 | {{{kbd(g)}}}                   | Check the document again                               |
 | {{{kbd(h)}}}                   | Hide all reports from the same checker                 |
 | {{{kbd(i)}}}                   | Also remove them from all subsequent checks            |
+| {{{kbd(S)}}}                   | Sort reports by the column at point                    |
 
 ** Context Dependent Documentation
 :PROPERTIES:
-- 
2.47.1


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #4: 0003-Ignore-attempts-to-jump-to-an-error-off-the-end-of-t.patch --]
[-- Type: text/x-patch, Size: 1273 bytes --]

From 5e8a0df5de4bcfa1fd07f21960b7771a2389c5e4 Mon Sep 17 00:00:00 2001
From: Malcolm Purvis <malcolm@purvis.id.au>
Date: Thu, 2 Jan 2025 21:36:18 +1100
Subject: [PATCH 3/3] Ignore attempts to jump to an error off the end of the
 org-lint report.

---
 lisp/org-lint.el | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/lisp/org-lint.el b/lisp/org-lint.el
index 040934235..8d5dce401 100644
--- a/lisp/org-lint.el
+++ b/lisp/org-lint.el
@@ -295,7 +295,8 @@ for `tabulated-list-printer'."
 
 (defun org-lint--current-marker ()
   "Return current report marker."
-  (get-text-property 0 'org-lint-marker (aref (tabulated-list-get-entry) 0)))
+  (when-let* ((entry (tabulated-list-get-entry)))
+    (get-text-property 0 'org-lint-marker (aref entry 0))))
 
 (defun org-lint--current-checker (&optional entry)
   "Return current report checker.
@@ -318,7 +319,7 @@ CHECKERS is the list of checkers used."
 (defun org-lint--jump-to-source ()
   "Move to source line that generated the report at point."
   (interactive)
-  (let ((mk (org-lint--current-marker)))
+  (when-let* ((mk (org-lint--current-marker)))
     (switch-to-buffer-other-window org-lint--source-buffer)
     (unless (<= (point-min) mk (point-max)) (widen))
     (goto-char mk)
-- 
2.47.1