(internal): add org-roam-message (#593)

This macro simplifies message printing, so we can respect
`org-roam-verbose` in more places. Also silences more messages when
`org-roam-verbose` set to false.
This commit is contained in:
Jethro Kuan
2020-05-10 16:44:28 +08:00
committed by GitHub
parent d68d1f8ebb
commit 3efe315ff1
4 changed files with 21 additions and 13 deletions

View File

@ -150,8 +150,8 @@ SQL can be either the emacsql vector representation, or a string."
'ignore
(if (< version org-roam-db--version)
(progn
(message (format "Upgrading the Org-roam database from version %d to version %d"
version org-roam-db--version))
(org-roam-message (format "Upgrading the Org-roam database from version %d to version %d"
version org-roam-db--version))
(org-roam-db-build-cache t))))
version)
@ -403,13 +403,12 @@ If FORCE, force a rebuild of the cache from scratch."
:titles (length all-titles)
:refs (length all-refs)
:deleted (length (hash-table-keys current-files)))))
(when org-roam-verbose
(message "files: %s, links: %s, titles: %s, refs: %s, deleted: %s"
(plist-get stats :files)
(plist-get stats :links)
(plist-get stats :titles)
(plist-get stats :refs)
(plist-get stats :deleted)))
(org-roam-message "files: %s, links: %s, titles: %s, refs: %s, deleted: %s"
(plist-get stats :files)
(plist-get stats :links)
(plist-get stats :titles)
(plist-get stats :refs)
(plist-get stats :deleted))
stats)))
(provide 'org-roam-db)

View File

@ -44,6 +44,7 @@
;; Library Requires
(require 'cl-lib)
(require 'org)
(require 'org-roam-macs)
(require 'org-element)
(declare-function org-roam-insert "org-roam")
@ -51,6 +52,8 @@
(declare-function org-roam--list-all-files "org-roam")
(declare-function org-roam--org-roam-file-p "org-roam")
(defvar org-roam-verbose)
(cl-defstruct (org-roam-doctor-checker (:copier nil))
(name 'missing-checker-name)
(description "")
@ -118,7 +121,7 @@ CHECKERS is the list of checkers used."
(defun org-roam-doctor--skip ()
"Skip the current error."
(message "Skipping..."))
(org-roam-message "Skipping..."))
(defun org-roam-doctor--replace-link ()
"Replace the current link with a new link."
@ -218,7 +221,7 @@ If CHECKALL, run the check only for all Org-roam files."
(unless (memq buf existing-buffers)
(save-buffer buf)
(kill-buffer buf))))))
(message "Linting completed."))
(org-roam-message "Linting completed."))
(provide 'org-roam-doctor)

View File

@ -33,6 +33,8 @@
;;; Code:
;;;; Library Requires
(defvar org-roam-verbose)
(defmacro org-roam--with-temp-buffer (&rest body)
"Execute BODY within a temp buffer.
Like `with-temp-buffer', but propagates `org-roam-directory'."
@ -56,7 +58,11 @@ to look.
(error-message-string err)
,templates))))
(defmacro org-roam-message (format-string &rest args)
"Message MSG with ARGS when `org-roam-verbose' is true."
(declare (indent 0) (debug t))
`(when org-roam-verbose
(message (concat "(org-roam) " ,format-string) ,@args)))
(provide 'org-roam-macs)

View File

@ -64,7 +64,7 @@ It opens or creates a note with the given ref.
(raise-frame)
(org-roam--with-template-error 'org-roam-capture-ref-templates
(org-roam-capture--capture nil template))
(message "Item captured.")))
(org-roam-message "Item captured.")))
nil)
(defun org-roam-protocol-open-file (info)