2496e0348d
This lets you delay a body of code until an arbitrary condition is met (which is checked whenever a file is loaded). Also refactors set-file-template! to wait until +file-templates-alist is defined.
127 lines
4.8 KiB
EmacsLisp
127 lines
4.8 KiB
EmacsLisp
;;; feature/file-templates/autoload.el -*- lexical-binding: t; -*-
|
|
|
|
;;;###autodef
|
|
(defun set-file-template! (pred &rest plist)
|
|
"Register a file template.
|
|
|
|
PRED can either be a regexp string or a major mode symbol. PLIST may contain
|
|
these properties:
|
|
|
|
:when FUNCTION
|
|
Provides a secondary predicate. This function takes no arguments and is
|
|
executed from within the target buffer. If it returns nil, this rule will be
|
|
skipped over.
|
|
:trigger
|
|
The yasnippet trigger keyword used to trigger the target snippet. If
|
|
omitted, `+file-templates-default-trigger' is used.
|
|
:mode SYMBOL
|
|
What mode to get the yasnippet snippet from. If omitted, either PRED (if
|
|
it's a major-mode symbol) or the mode of the buffer is used.
|
|
:project BOOL
|
|
If non-nil, ignore this template if this buffer isn't in a project.
|
|
:ignore BOOL
|
|
If non-nil, don't expand any template for this file and don't test any other
|
|
file template rule against this buffer."
|
|
(after! (:when (boundp '+file-templates-alist))
|
|
(push `(,pred ,@plist) +file-templates-alist)))
|
|
|
|
;;;###autodef
|
|
(defun set-file-templates! (&rest templates)
|
|
"Like `doom--set:file-template', but register many file templates at once."
|
|
(after! (:when (boundp '+file-templates-alist))
|
|
(setq +file-templates-alist (append (list templates) +file-templates-alist))))
|
|
|
|
;; FIXME obsolete :file-template
|
|
;;;###autoload
|
|
(def-setting! :file-template (pred &rest plist)
|
|
:obsolete set-file-template!
|
|
`(set-file-template! ,pred ,@plist))
|
|
|
|
;; FIXME obsolete :file-templates
|
|
;;;###autoload
|
|
(def-setting! :file-templates (&rest templates)
|
|
:obsolete set-file-templates!
|
|
`(set-file-templates! ,@templates))
|
|
|
|
|
|
;;
|
|
;; Library
|
|
;;
|
|
|
|
;;;###autoload
|
|
(defun +file-templates--expand (pred &rest plist)
|
|
"Auto insert a yasnippet snippet into current file and enter insert mode (if
|
|
evil is loaded and enabled)."
|
|
(when (and pred (not (plist-get plist :ignore)))
|
|
(let ((project (plist-get plist :project))
|
|
(mode (plist-get plist :mode))
|
|
(trigger (plist-get plist :trigger)))
|
|
(when (if project (doom-project-p) t)
|
|
(unless mode
|
|
(setq mode (if (symbolp pred) pred major-mode)))
|
|
(unless mode
|
|
(user-error "Couldn't determine mode for %s file template" pred))
|
|
(unless trigger
|
|
(setq trigger +file-templates-default-trigger))
|
|
(require 'yasnippet)
|
|
(unless yas-minor-mode
|
|
(yas-minor-mode-on))
|
|
(when (and yas-minor-mode
|
|
(yas-expand-snippet
|
|
(yas--template-content
|
|
(cl-find trigger (yas--all-templates (yas--get-snippet-tables mode))
|
|
:key #'yas--template-key :test #'equal)))
|
|
(and (featurep 'evil) evil-mode)
|
|
(and yas--active-field-overlay
|
|
(overlay-buffer yas--active-field-overlay)
|
|
(overlay-get yas--active-field-overlay 'yas--field)))
|
|
(evil-initialize-state 'insert))))))
|
|
|
|
;;;###autoload
|
|
(defun +file-templates-get-short-path ()
|
|
"Fetches a short file path for the header in Doom module templates."
|
|
(let ((path (file-truename (or buffer-file-name default-directory))))
|
|
(cond ((string-match "/modules/\\(.+\\)$" path)
|
|
(match-string 1 path))
|
|
((file-in-directory-p path doom-emacs-dir)
|
|
(file-relative-name path doom-emacs-dir))
|
|
((abbreviate-file-name path)))))
|
|
|
|
;;;###autoload
|
|
(defun +file-template-p (rule)
|
|
"Return t if RULE applies to the current buffer."
|
|
(let ((pred (car rule))
|
|
(plist (cdr rule)))
|
|
(and (cond ((and (stringp pred) buffer-file-name) (string-match-p pred buffer-file-name))
|
|
((symbolp pred) (eq major-mode pred)))
|
|
(or (not (plist-member plist :when))
|
|
(funcall (plist-get plist :when) buffer-file-name))
|
|
rule)))
|
|
|
|
|
|
;;
|
|
;; Commands
|
|
;;
|
|
|
|
;;;###autoload
|
|
(defun +file-templates/insert-license ()
|
|
"Insert a license file template into the current file."
|
|
(interactive)
|
|
(require 'yasnippet)
|
|
(let* ((templates
|
|
(let ((yas-choose-tables-first nil) ; avoid prompts
|
|
(yas-choose-keys-first nil))
|
|
(cl-loop for tpl in (yas--all-templates (yas--get-snippet-tables 'text-mode))
|
|
for uuid = (yas--template-uuid tpl)
|
|
if (string-prefix-p "__license-" uuid)
|
|
collect (cons (string-remove-prefix "__license-" uuid) tpl))))
|
|
(uuid (yas-choose-value (mapcar #'car templates))))
|
|
(when uuid
|
|
(yas-expand-snippet (cdr (assoc uuid templates))))))
|
|
|
|
;;;###autoload
|
|
(defun +file-templates/debug ()
|
|
"Tests the current buffer and outputs the file template rule most appropriate
|
|
for it. This is used for testing."
|
|
(interactive)
|
|
(message "Found %s" (cl-find-if #'+file-template-p +file-templates-alist)))
|