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-org-contacts.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-org-contacts.el')
| -rw-r--r-- | chime-org-contacts.el | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/chime-org-contacts.el b/chime-org-contacts.el index 73904c2..6c9e590 100644 --- a/chime-org-contacts.el +++ b/chime-org-contacts.el @@ -3,11 +3,12 @@ ;; Copyright (C) 2025-2026 Craig Jennings ;; Author: Craig Jennings <c@cjennings.net> -;; Version: 1.0.0 -;; Package-Requires: ((emacs "27.1") (org "9.0")) -;; Keywords: calendar, org-mode, contacts ;; URL: https://github.com/cjennings/chime +;; This file is part of the chime package. Version, Package-Requires, and +;; Keywords live on the main file (chime.el); auxiliary files do not repeat +;; them per package-lint convention. + ;; This program is free software: you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation, either version 3 of the License, or @@ -145,11 +146,12 @@ Added: %U" ;;; Activation -;; Set up the capture template when org-capture is loaded, -;; but only if chime-org-contacts-file is configured -(with-eval-after-load 'org-capture - (when chime-org-contacts-file - (chime-org-contacts--setup-capture-template))) +;; chime.el guards the require of this file behind its own +;; `with-eval-after-load' on `org-capture', so by the time we get here +;; org-capture is loaded. Set up the template directly when the user +;; has configured `chime-org-contacts-file'. +(when chime-org-contacts-file + (chime-org-contacts--setup-capture-template)) (provide 'chime-org-contacts) ;;; chime-org-contacts.el ends here |
