emacs/lisp/+setup.el

;;; +setup.el -- my `setup' commands -*- lexical-binding: t -*-

;; Author: Case Duckworth <acdw@acdw.net>

;; This file is NOT part of GNU Emacs.

;;; License:
;; Everyone is permitted to do whatever with this software, without
;; limitation.  This software comes without any warranty whatsoever,
;; but with two pieces of advice:
;; - Don't hurt yourself.
;; - Make good choices.

;;; Commentary:

;; `setup', by Philip Kaludercic, is a wonderful package that works
;; sort of like `use-package', but to my mind it's cleaner and easier
;; to extend.  These are my additions to the local macros provided by
;; the package.

;;; Code:

(require 'el-patch)
(require 'setup)
(require 'straight)

(defun +setup-warn (message &rest args)
  "Warn the user that something bad happened in `setup'."
  (display-warning 'setup (format message args)))

(setup-define :quit
  'setup-quit
  :documentation "Quit the current `setup' form.
Good for commenting.")

(setup-define :face
    (lambda (face spec)
      `(custom-set-faces '(,face ,spec 'now "Customized by `setup'.")))
  :documentation "Customize FACE with SPEC using `custom-set-faces'."
  :repeatable t)

(setup-define :load-after
    (lambda (&rest features)
      (let ((body `(require ',(setup-get 'feature))))
    (dolist (feature (nreverse features))
      (setq body `(with-eval-after-load ',feature ,body)))
    body))
  :documentation "Load the current feature after FEATURES.")

(setup-define :load-from
  (lambda (path)
    `(let ((path* (expand-file-name ,path)))
       (if (file-exists-p path*)
           (add-to-list 'load-path path*)
         ,(setup-quit))))
  :documentation "Add PATH to load path.
This macro can be used as NAME, and it will replace itself with
the nondirectory part of PATH.
If PATH does not exist, abort the evaluation."
  :shorthand (lambda (args)
               (intern
                (file-name-nondirectory
                 (directory-file-name (cadr args))))))


;;; Straight.el

(with-eval-after-load 'straight
  (setup-define :also-straight
    (lambda (recipe) `(setup (:straight ,recipe)))
    :documentation
    "Install RECIPE with `straight-use-package', after loading FEATURE."
    :repeatable t
    :after-loaded t)

  (defun +setup-straight-shorthand (sexp)
    "Shorthand for `:straight' and other local macros."
    (let ((recipe (cadr sexp)))
      (or (car-safe recipe) recipe)))

  (setup-define :straight
    (lambda (recipe)
      `(unless (ignore-errors (straight-use-package ',recipe) t)
         (+setup-warn ":straight error: %S" ',recipe)
         ,(setup-quit)))
    :documentation
    "Install RECIPE with `straight-use-package'.
This macro can be used as HEAD, and will replace itself with the
first RECIPE's package."
    :repeatable t
    :shorthand #'+setup-straight-shorthand)

  (setup-define :straight-after
    (lambda (recipe feature)
      `(with-eval-after-load ,feature
         (setup (:straight ,recipe))))
    :indent 1
    :documentation
    "Install RECIPE with `straight-use-package', after FEATURE.
This macro can be used as HEAD, and will replace itself with the
first RECIPE's package."
    :shorthand #'+setup-straight-shorthand)

  (setup-define :straight-when
    (lambda (recipe condition)
      `(if ,condition
           (unless (ignore-errors (straight-use-package ',recipe) t)
             (+setup-warn ":straight error: %S" ',recipe)
             ,(setup-quit))
         (message "Setup: :straight-when returned nil %S" ',recipe)
         ,(setup-quit)))
    :documentation
    "Install RECIPE with `straight-use-package' when CONDITION is met.
If CONDITION is false, or if `straight-use-package' fails, stop
evaluating the body.  This macro can be used as HEAD, and will
replace itself with the RECIPE's package."
    :repeatable 2
    :indent 1
    :shorthand #'+setup-straight-shorthand))


;;; Redefines of `setup' forms

(setup-define :bind-into
  (lambda (feature-or-map &rest rest)
    (cl-loop for f/m in (ensure-list feature-or-map)
             collect (if (string-match-p "-map\\'" (symbol-name f/m))
                         `(:with-map ,f/m (:bind ,@rest))
                       `(:with-feature ,f/m (:bind ,@rest)))
             into forms
             finally return `(progn ,@forms)))
  :documentation "Bind into keys into the map(s) of FEATURE-OR-MAP.
FEATURE-OR-MAP can be a feature or map name or a list of them.
The arguments REST are handled as by `:bind'."
  :debug '(sexp &rest form sexp)
  :indent 1)

(setup-define :require
  (lambda (&rest features)
    (require 'cl-lib)
    (if features
        `(progn ,@(cl-loop for feature in features collect
                           `(unless (require ',feature nil t)
                              ,(setup-quit))))
      `(unless (require ',(setup-get 'feature) nil t)
         ,(setup-quit))))
  :documentation "Try to require FEATURE, or stop evaluating body.
This macro can be used as NAME, and it will replace itself with
the first FEATURE."
  :repeatable nil
  :shorthand #'cadr)

(provide '+setup)
;;; +setup.el ends here