802f015f26
If an org-capture template generates a new, blank file, Doom steps in to insert a yasnippet file-template into the buffer. If the file template has text fields, it leaves the new buffer in an "editing snippets" state (and insert mode) which causes errors downstream when org-capture tries to modify the buffer. The file-templates module employs some heuristics to prevent false positives like these, but packages (and org-capture) can get around this by simply generating and switching to the org buffer before modifying it. This commit no-ops file-template expansion in any org-capture session, which should resolve these issues. Fix: #6160 Fix: #6741 |
||
|---|---|---|
| .. | ||
| templates | ||
| autoload.el | ||
| config.el | ||
| packages.el | ||
| README.org | ||
:editor file-templates
Description unfold
This module adds file templates for blank files, powered by doom-package:yasnippet.
Maintainers
Module flags
This module has no flags.
Packages
This module doesn't install any packages.
Hacks
TODO Changelog
This module does not have a changelog yet.
Installation
Enable this module in your doom! block.
This module has no external requirements.
TODO Usage
🔨 This module's usage documentation is incomplete. Complete it?
File templates are automatically expanded when opening empty files who match one
of the rules in the +file-templates-alist variable.
These templates are simply yasnippet snippets, which can also be expanded by
typing their trigger and pressing TAB. By convention, the triggers for file
templates are prefixed with two underscores __ (the trigger for the default
file template of a major mode is almost always __).
Inserting OSS licenses
A special command is available for inserting software licenses: M-x
+file-templates/insert-license.
📌 Licenses with a
-bpsuffix are boilerplate templates; i.e. shorter versions intended for comment headers in code files.
TODO Configuration
🔨 This module's configuration documentation is incomplete. Complete it?
Adding new or changing existing file templates
New file templates can be added to
$DOOMDIR/snippets/{major-mode}/{snippet-name}. The yasnippet documentation
covers how to write a snippet. You can map a snippet to a file path, major mode,
or another arbitrary predicate using fn:set-file-template!.
Look into its documentation with <help> f set-file-template\!.
Adding new OSS licenses
Add snippet files to $DOOMDIR/snippets/text-mode/ with the __licenses-
prefix and fn:+file-templates/insert-license will recognize them. E.g.
$DOOMDIR/snippets/text-mode/__license-mit.
Troubleshooting
- If a file template isn't expanding where you expect it to, run
M-x +file-templates/debug. This will report to you what file template rule would apply for the correct file.
Frequently asked questions
This module has no FAQs yet. Ask one?
TODO Appendix
🔨 This module's appendix is incomplete. Write more?
API
set-file-template! PRED &rest PLISTset-file-templates! &rest TEMPLATES
Commands
+file-templates/insert-license+file-templates/debug
Variables
+file-templates-dir+file-templates-default-trigger+file-templates-alist