From 1f57189ffbe4f039ea213918c97d0a9496b4db7b Mon Sep 17 00:00:00 2001 From: Craig Jennings Date: Tue, 5 May 2026 09:39:09 -0500 Subject: refactor: clear package-lint warnings for MELPA prep MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit I worked through the package-lint backlog and got it to zero. Five changes: 1. Renamed six interactive debug commands from the private `chime--debug-*' prefix to the public `chime-debug-*' form. They were always M-x targets, so the private prefix was just wrong. The autoload cookies stay because public commands SHOULD be autoloaded. README, docstring references in chime.el, and the matching tests follow the rename. 2. Dropped `Version', `Package-Requires', and `Keywords' headers from chime-org-contacts.el. Auxiliary files in a multi-file package shouldn't carry their own metadata — package-lint flags it as an error because the headers have no effect outside the main file. The main file (chime.el) already declares the chime package's metadata. 3. Dropped `Keywords' from chime-debug.el for the same reason. 4. Dropped the auto-loader for the optional chime-org-contacts integration from chime.el. The old code used `with-eval-after-load 'org-capture' to pull the file in, which package-lint flags as a configuration pattern that doesn't belong in a package. Users who want the integration now require it themselves; the README shows both the plain `with-eval-after-load' pattern and the `use-package :after' form. chime-org-contacts.el's internal `with-eval-after-load' went away too — by the time the user has required the file, they've already gated it on org-capture being loaded, so the inner check is redundant. 5. Dropped the redundant `with-eval-after-load' from chime-org-contacts.el's activation block. The setup function still guards on `(boundp 'org-capture-templates)' so it's safe to require either order. Behavioral note: this is a small breaking change for anyone whose config relied on the auto-load. The README change spells out the migration path. --- README.org | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) (limited to 'README.org') diff --git a/README.org b/README.org index 0162cc7..6191078 100644 --- a/README.org +++ b/README.org @@ -966,15 +966,30 @@ After conversion, comment out the diary sexp in your schedule file: *Step 2: Set up capture template for new contacts* +The =chime-org-contacts= integration is optional and lives in its own file. Require it after =org-capture= loads so the template registers cleanly: + #+BEGIN_SRC elisp ;; Enable org-contacts integration (setq chime-org-contacts-file "~/org/contacts.org") ;; Optional: customize capture key (default: "C") (setq chime-org-contacts-capture-key "C") + +;; Load the integration once org-capture is available +(with-eval-after-load 'org-capture + (require 'chime-org-contacts)) +#+END_SRC + +Or, with =use-package=: + +#+BEGIN_SRC elisp +(use-package chime-org-contacts + :after org-capture + :init + (setq chime-org-contacts-file "~/org/contacts.org")) #+END_SRC -This adds an org-capture template (=C-c c C=) that prompts for contact details and automatically inserts a yearly repeating timestamp if a birthday is provided. +Either form adds an org-capture template (=C-c c C=) that prompts for contact details and automatically inserts a yearly repeating timestamp if a birthday is provided. Set =chime-org-contacts-file= to =nil= to disable (the default). @@ -995,10 +1010,10 @@ If something isn't working right, enable debug mode for detailed diagnostics in This loads =chime-debug.el= and gives you these commands: -- =M-x chime--debug-dump-events= -- show all stored upcoming events -- =M-x chime--debug-dump-tooltip= -- show tooltip content -- =M-x chime--debug-config= -- dump complete configuration -- =M-x chime--debug-show-async-stats= -- show async process success/failure stats +- =M-x chime-debug-dump-events= -- show all stored upcoming events +- =M-x chime-debug-dump-tooltip= -- show tooltip content +- =M-x chime-debug-config= -- dump complete configuration +- =M-x chime-debug-show-async-stats= -- show async process success/failure stats - =M-x chime-debug-force-check= -- force an immediate check with diagnostics It also monitors event loading timing and async process performance in the background, logging to =*Messages*=. -- cgit v1.2.3