README: Add paragraph about debugging Corfu

1 files changed, 20 insertions, 0 deletions

diff --git a/README.org b/README.org
index 166f0e5..8f49bc6 100644
--- a/README.org
+++ b/README.org
@@ -529,6 +529,26 @@ enhance your setup.
   your completions in the minibuffer ~consult-completion-in-region~ is your best
   option.
 
+* Debugging Corfu
+
+When you observe an error in the =corfu--post-command= post command hook, you
+should install an advice to enforce debugging. This allows you to obtain a stack
+trace in order to narrow down the location of the error. The reason is that post
+command hooks are automatically disabled (and not debugged) by Emacs. Otherwise
+Emacs would become unusable, given that the hooks are executed after every
+command.
+
+#+begin_src emacs-lisp
+  (setq debug-on-error t)
+
+  (defun force-debug (func &rest args)
+    (condition-case e
+        (apply func args)
+      ((debug error) (signal (car e) (cdr e)))))
+
+  (advice-add #'corfu--post-command :around #'force-debug)
+#+end_src
+
 * Contributions
 
 Since this package is part of [[https://elpa.gnu.org/packages/corfu.html][GNU ELPA]] contributions require a copyright