diff options
| author | Craig Jennings <c@cjennings.net> | 2026-05-05 09:39:09 -0500 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2026-05-05 09:39:09 -0500 |
| commit | 1f57189ffbe4f039ea213918c97d0a9496b4db7b (patch) | |
| tree | 72593d38023a8e74cfd6874e68e82e947889a4dd /chime.el | |
| parent | c9f732e04d68d25fec734fb95dd567331dc1fd7d (diff) | |
| download | chime-1f57189ffbe4f039ea213918c97d0a9496b4db7b.tar.gz chime-1f57189ffbe4f039ea213918c97d0a9496b4db7b.zip | |
refactor: clear package-lint warnings for MELPA prep
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.
Diffstat (limited to 'chime.el')
| -rw-r--r-- | chime.el | 20 |
1 files changed, 7 insertions, 13 deletions
@@ -541,9 +541,9 @@ Set to 0 to disable failure warnings." (defcustom chime-debug nil "Enable debug functions for troubleshooting chime behavior. When non-nil, loads chime-debug.el which provides: -- `chime--debug-dump-events' - Show all stored upcoming events -- `chime--debug-dump-tooltip' - Show tooltip content -- `chime--debug-config' - Show complete configuration dump +- `chime-debug-dump-events' - Show all stored upcoming events +- `chime-debug-dump-tooltip' - Show tooltip content +- `chime-debug-config' - Show complete configuration dump - `chime-debug-monitor-event-loading' - Monitor event loading timing These functions write detailed information to the *Messages* buffer @@ -567,16 +567,10 @@ Set to t to enable debug functions: (file-name-directory (or load-file-name buffer-file-name))) t)) -;; Load org-contacts integration if configured -;; Note: The actual template setup happens in chime-org-contacts.el -;; when org-capture is loaded, so users can defer org loading -(with-eval-after-load 'org-capture - (when (and (boundp 'chime-org-contacts-file) - chime-org-contacts-file) - (require 'chime-org-contacts - (expand-file-name "chime-org-contacts.el" - (file-name-directory (or load-file-name buffer-file-name))) - t))) +;; The optional org-contacts integration in chime-org-contacts.el is loaded +;; by the user, not by chime itself. See the README for the recommended +;; `(with-eval-after-load 'org-capture (require 'chime-org-contacts))' or +;; `use-package chime-org-contacts :after org-capture' setup. ;;;; Internal State |
