-
-
-
- 
-
-
- 
-
-
- 
-
-- Screenshots - | - Get started - | - Contribute - | - Documentation - | - FAQ -
+
+ 
-It is a story as old as time. A stubborn, shell-dwelling, and melodramatic
-vimmer -- envious of the features of modern text editors -- spirals into despair
-before succumbing to the [dark side][url:evil-mode]. This is his config.
+> It is a story as old as time. A stubborn, shell-dwelling, and melodramatic
+> vimmer—envious of the features of modern text editors—spirals into
+> despair before he succumbs to the [dark side][evil-mode]. This is his config.
-Doom is a configuration framework for [GNU
-Emacs](https://www.gnu.org/software/emacs/) tailored for Emacs bankruptcy
-veterans who want less framework in their frameworks and the performance of a
-hand rolled config (or better). It can be a foundation for your own config or a
-resource for Emacs enthusiasts to learn more about our favorite OS.
+Doom is a configuration framework for [GNU Emacs] tailored for Emacs bankruptcy
+veterans who want less framework in their frameworks, a modicum of stability
+(and reproducibility) from their package manager, and the performance of a hand
+rolled config (or better). It can be a foundation for your own config or a
+resource for Emacs enthusiasts to learn more about our favorite operating
+system.
-## Doom's mantras
+Its design is guided by these mantras:
-- **Gotta go fast.** Startup and run-time performance are priorities. Doom goes
- beyond lazy loading packages by modifying them to be snappier and load lazier!
-- **Close to metal.** There's less between you and vanilla Emacs by design.
- There's less to grok, on top of Emacs.
-- **Readability counts.** Internals ought to be written as if reading them were
- part of the user experience, and it is! Modules should be syntactically sweet.
- Backend logic should be functional (as much as elisp permits), abstraction
- light and (hopefully) documented.
-- **Opinionated, but not stubborn.** Doom is a bundle of reasonable defaults and
- curated opinions, but all of it should be optional. Use as little or as much
- of it as you like.
-- **Your system, your rules.** There are more ways to set up your development
- environment than there are dislikes on Youtube Rewind '18, so Doom leaves it
- to you. Doom will not *automatically* install system dependencies (and will
- coerce its plugins not to do so either). Use `doom doctor` to figure out
- what's missing.
++ **Gotta go fast.** Startup and run-time performance are priorities. Doom goes
+ beyond by modifying packages to be snappier and load lazier.
++ **Close to metal.** There's less between you and vanilla Emacs by design.
+ That's less to grok and less to work around when you tinker. Internals ought
+ to be written as if reading them were part of Doom's UX, and it is!
++ **Opinionated, but not stubborn.** Doom is about reasonable defaults and
+ curated opinions, but use as little or as much of it as you like.
++ **Your system, your rules.** You know better. At least, Doom hopes so! It
+ won't *automatically* install system dependencies (and will force plugins not
+ to either). Rely on `doom doctor` to tell you what's missing.
++ **Nix/Guix was a great idea!** The Emacs ecosystem is temperamental. Things
+ break and they break often. Disaster recovery should be a priority! Doom's
+ package management should be declarative and your private config reproducible,
+ and comes with a means to roll back releases and updates (still a WIP).
+
+Check out [the FAQ][FAQ] for answers to common questions about the project.
-## Features
+# Features
- Minimalistic good looks inspired by modern editors.
-- A modular architecture that can be extended to your own configs.
-- A standard library suited to simplifying your config.
-- A declarative [package management system][doom:packages] (powered by
- [straight.el][url:straight]) with a command line interface. Install packages
- from anywhere, not just (M)ELPA.
-- (Optional) Vim-emulation powered by [evil-mode][url:evil-mode], including
- ports of popular vim plugins and functionality.
- Curated and sane defaults for many packages, (major) OSes, and Emacs itself.
+- A modular organizational structure for separating concerns in your config.
+- A standard library designed to simplify your elisp bike shedding.
+- A declarative [package management system][package-management] (powered by
+ [straight.el]) with a command line interface. Install packages from anywhere,
+ not just (M)ELPA, and pin them to any commit.
+- Optional vim emulation powered by [evil-mode], including ports of popular vim
+ plugins like [vim-sneak], [vim-easymotion], [vim-unimpaired] and
+ [more][ported-vim-plugins]!
+- Opt-in LSP integration for many languages, using [lsp-mode].
- Support for *many* programming languages. Includes syntax highlighting,
linters/checker integration, inline code evaluation, code completion (where
possible), REPLs, documentation lookups, snippets, and more!
- Support for *many* tools, like docker, pass, ansible, terraform, and more.
-- A Spacemacs-esque [keybinding scheme][doom:bindings], centered around leader
- and localleader prefix keys (SPC and SPCm, by
- default).
-- A rule-based [popup management system][doom:popups] to control how temporary
- or disposable buffers are displayed (and disposed of).
-- Automatic indentation detection and [editorconfig][url:editorconfig]
- integration. Let someone else argue about tabs vs **\_\***spaces**\*\_**.
+- A Spacemacs-esque [keybinding scheme][bindings], centered around leader
+ and localleader prefix keys (SPC and SPCm for
+ evil users, C-c and C-c l for vanilla users).
+- A rule-based [popup manager][popup-system] to control how temporary buffers
+ are displayed (and disposed of).
+- Per-file indentation style detection and [editorconfig] integration. Let
+ someone else can argue about tabs vs **_spaces_**.
- Project-management tools and framework-specific minor modes with their own
snippets libraries.
-- Project search (and replace) utilities, powered by [ripgrep][url:ripgrep].
+- Project search (and replace) utilities, powered by [ripgrep] and [ivy] or
+ [helm].
- Isolated and persistent workspaces (also substitutes for vim tabs).
-- An envvar file generator that captures a snapshot of your shell environment
- for Doom to load at startup. No more struggling to get Emacs to inherit your
- `PATH`, among other things.
+- Support for Chinese and Japanese input systems.
+- Save a snapshot of your shell environment to a file for Emacs to load at
+ startup. No more struggling to get Emacs to inherit your `PATH`, among other
+ things.
-# Getting Help
-## Community
+# Prerequisites
++ Git 2.23+
++ Emacs 26.1+ (*27 is recommended*) with GNUTLS support
++ [ripgrep] 11.0+
++ GNU `find`
++ *OPTIONAL:* [fd] 7.3.0+ (improves file indexing performance for some commands)
+
+Doom is comprised of [~150 optional modules][Modules], some of which may have
+additional dependencies. [Visit their documentation][Modules] or run `bin/doom
+doctor` to check for any that you may have missed.
-We have [a Discord server][url:discord]! Hop on and say hi!
-## Troubleshooting
+# Install
+``` sh
+git clone --depth 1 https://github.com/hlissner/doom-emacs ~/.emacs.d
+~/.emacs.d/bin/doom install
+```
-Encountered a problem? Here are some things to try before shooting off that bug
-report:
+Then [read our Getting Started guide][getting-started] to be walked through
+installing, configuring and maintaining Doom Emacs.
-- Run `bin/doom sync`. This ensures Doom is properly set up and its autoloads
- files are up-to-date.
-- Folks who have byte-compiled their config (with `bin/doom compile`) should run
- `bin/doom clean` to rule out stale bytecode. Never debug with a byte-compiled
- config. It makes your job harder.
-- Run `bin/doom doctor` to detect common issues in your development environment
- and missing third party dependencies.
-- Search [Doom's issue tracker][github:issues] in case your issue was already
+It's a good idea to add `~/.emacs.d/bin` to your `PATH`! Other `bin/doom`
+commands you should know about:
+
++ `doom sync` to synchronize your private config with Doom. Installs new
+ packages, removes orphaned packages and regenerates caches. Run this whenever
+ you modify your private `init.el` or `packages.el`, or install/remove an Emacs
+ package through your OS package manager (e.g. mu4e or agda).
++ `doom upgrade` to update Doom to the latest release & all installed packages.
++ `doom doctor` to diagnose common issues with your system and config.
++ `doom env` to dump a snapshot of your shell environment to a file that Doom
+ will load at startup. This allows Emacs to inherit your `PATH`, among other
+ things.
++ `doom build` to recompile all installed packages (use this if you up/downgrade
+ Emacs).
+
+
+# Roadmap
+Doom is an active and ongoing project. To make that development more
+transparent, its roadmap (and other concerns) are published across three github
+project boards and a newsletter:
+
++ [Development Roadmap](https://github.com/hlissner/doom-emacs/projects/3):
+ roughly outlines our goals between release milestones and their progress.
++ [Plugins under review](https://github.com/hlissner/doom-emacs/projects/2):
+ lists plugins we are watching and considering for inclusion, and what their
+ status for inclusion is. Please consult this list before requesting new
+ packages/features.
++ [Upstream bugs](https://github.com/hlissner/doom-emacs/projects/5): lists
+ issues that originate from elsewhere, and whether or not we have local
+ workarounds or temporary fixes for them.
++ ~~Doom's newsletter~~ (not finished) will contain changelogs in between
+ releases.
+
+
+# Getting help
+Emacs is no journey of a mere thousand miles. You _will_ run into problems and
+mysterious errors. When you do, here are some places you can look for help:
+
++ [Our documentation][documentation] covers many use cases.
+ + [The Configuration section][configuration] covers how to configure Doom and
+ its packages.
+ + [The Package Management section][package-management] covers how to install
+ and disable packages.
+ + [This section][bin/doom] explains the `bin/doom` script's most important
+ commands.
+ + [This section][common-mistakes] lists some common configuration mistakes new
+ users make, when migrating a config from another distro or their own.
+ + [This answer][change-theme] shows you how to add your own themes to your
+ private config.
+ + [This answer][change-font] shows you how to change the default font.
+ + Your issue may be documented in the [FAQ].
++ With Emacs built-in help system documentation is a keystroke away:
+ + For functions: SPC h f or C-h f
+ + For variables: SPC h v or C-h v
+ + For a keybind: SPC h k or C-h k
+ + To search available keybinds: SPC h b b or C-h b b
++ Run `bin/doom doctor` to detect common issues with your development
+ environment and private config.
++ Check out the [FAQ], in case your question has already been answered.
++ Search [Doom's issue tracker](/issues) in case your issue was already
reported.
-- [Visit our FAQ][docs:faq] to see if your issue is listed.
-
-If all else fails, [file that bug report][github:new-issue]! **Please do not
-ignore the issue template!** It's a great help if you can [include a backtrace
-with errors][docs:backtrace].
-
-## Contributing
-
-Doom (and my Emacs work in general) is a labor of love and incurable madness,
-done on my spare time. If you'd like to support my work, there are many things
-you can do to help. I welcome contributions!
-
-- I love pull requests and bug reports. Check out the [Contributing
- Guidelines][docs:contributing] to find out how you can help out.
-- I welcome Elisp pointers! Don't hesitate to [tell me my Elisp-fu
- sucks][github:new-issue] (but please tell me why).
-- Hop on [our Discord server][url:discord] and say hi! Help others out, hang out
- or talk to me about Emacs, or gamedev, or programming, machine learning,
- physics, pixel art, anime, gaming -- anything you like. Nourish this lonely
- soul!
-- If you'd like to support my work financially, consider buying me a drink
- through [liberapay][url:liberapay] or [paypal][url:paypal]. Donations are a
- great help. My work here contends with studies, ventures in indie gamedev, and
- my freelance work.
++ Hop on [our Discord server][discord]; it's active and friendly! Keep an eye on
+ the #announcements channel, where I announce breaking updates and releases.
-[docs:wiki]: docs/index.org
-[docs:wiki-quickstart]: docs/getting_started.org
-[docs:wiki-modules]: docs/index.org#Module%20List
-[docs:wiki-customization]: docs/getting_started.org#Customize
-[docs:contributing]: docs/contributing.org
-[docs:faq]: docs/faq.org
-[docs:backtrace]: https://github.com/hlissner/doom-emacs/blob/develop/docs/getting_started.org#how-to-extract-a-backtrace-from-an-error
-[github:new-issue]: https://github.com/hlissner/doom-emacs/issues/new
-[github:issues]: https://github.com/hlissner/doom-emacs/issues
-[doom:bindings]: modules/config/default/+evil-bindings.el
-[doom:packages]: core/autoload/packages.el
-[doom:popups]: modules/ui/popup/README.org
-[url:discord]: https://discord.gg/qvGgnVx
-[url:liberapay]: https://liberapay.com/hlissner/donate
-[url:paypal]: https://paypal.me/henriklissner/10
-[url:editorconfig]: http://editorconfig.org/
-[url:evil-mode]: https://github.com/emacs-evil/evil
-[url:ripgrep]: https://github.com/BurntSushi/ripgrep
-[url:straight]: https://github.com/raxod502/straight.el
+# Contribute
+[](http://makeapullrequest.com)
+[](https://github.com/bbatsov/emacs-lisp-style-guide)
+[][liberapay]
+[][paypal]
+
+Doom is a labor of love and incurable madness, but I'm only one guy. Doom
+wouldn't be where it is today without your help. I welcome contributions of any
+kind!
+
++ I :heart: pull requests and bug reports (see the [Contributing
+ Guidelines][contribute])!
++ Don't hesitate to [tell me my Elisp-fu
+ sucks](https://github.com/hlissner/doom-emacs/issues/new), but please tell me
+ why.
++ Hop on [our Discord server][Discord] and say hi! Help others, hang out or talk
+ to me about Emacs, gamedev, programming, physics, pixel art, anime, gaming --
+ anything you like. Nourish this lonely soul.
++ If you'd like to support my work financially, buy me a drink through
+ [liberapay] or [paypal]. My work contends with studies, adventures in indie
+ gamedev and freelance work. Donations help me allocate more time to my Emacs
+ and OSS capers.
+
+[](https://sourcerer.io/fame/hlissner/hlissner/doom-emacs/links/0)
+[](https://sourcerer.io/fame/hlissner/hlissner/doom-emacs/links/1)
+[](https://sourcerer.io/fame/hlissner/hlissner/doom-emacs/links/2)
+[](https://sourcerer.io/fame/hlissner/hlissner/doom-emacs/links/3)
+[](https://sourcerer.io/fame/hlissner/hlissner/doom-emacs/links/4)
+[](https://sourcerer.io/fame/hlissner/hlissner/doom-emacs/links/5)
+[](https://sourcerer.io/fame/hlissner/hlissner/doom-emacs/links/6)
+[](https://sourcerer.io/fame/hlissner/hlissner/doom-emacs/links/7)
+
+
+[contribute]: docs/contributing.org
+[discord]: https://discord.gg/qvGgnVx
+[documentation]: docs/index.org
+[faq]: docs/faq.org
+[getting-started]: docs/getting_started.org
+[install]: docs/getting_started.org#install
+[backtrace]: docs/getting_started.org#how-to-extract-a-backtrace-from-an-error
+[configuration]: docs/getting_started.org#configuring-doom
+[package-management]: docs/getting_started.org#package-management
+[bin/doom]: docs/getting_started.org#the-bindoom-utility
+[common-mistakes]: docs/getting_started.org#common-mistakes-when-configuring-doom-emacs
+[change-theme]: docs/faq.org#how-do-i-change-the-theme
+[change-font]: docs/faq.org#how-do-i-change-the-fonts
+[modules]: docs/modules.org
+[popup-system]: modules/ui/popup/README.org
+[screenshots]: #screenshots
+
+[bindings]: modules/config/default/+evil-bindings.el
+[editorconfig]: http://editorconfig.org/
+[evil-mode]: https://github.com/emacs-evil/evil
+[fd]: https://github.com/sharkdp/fd
+[gnu emacs]: https://www.gnu.org/software/emacs/
+[helm]: https://github.com/emacs-helm/helm
+[ivy]: https://github.com/abo-abo/swiper
+[lsp-mode]: https://github.com/emacs-lsp/lsp-mode
+[nix]: https://nixos.org
+[ported-vim-plugins]: modules/editor/evil/README.org#ported-vim-plugins
+[ripgrep]: https://github.com/BurntSushi/ripgrep
+[straight.el]: https://github.com/raxod502/straight.el
+[vim-easymotion]: https://github.com/easymotion/vim-easymotion
+[vim-lion]: https://github.com/tommcdo/vim-lion
+[vim-sneak]: https://github.com/justinmk/vim-sneak
+[vim-unimpaired]: https://github.com/tpope/vim-unimpaired
+
+[liberapay]: https://liberapay.com/hlissner/donate
+[paypal]: https://paypal.me/henriklissner/10
diff --git a/core/autoload/cache.el b/core/autoload/cache.el
deleted file mode 100644
index 79db071dd..000000000
--- a/core/autoload/cache.el
+++ /dev/null
@@ -1,95 +0,0 @@
-;;; core/autoload/cache.el -*- lexical-binding: t; -*-
-
-;; This little library thinly wraps around persistent-soft (which is a pcache
-;; wrapper, how about that). It has three purposes:
-;;
-;; + To encapsulate the cache backend (persistent-soft/pcache in this case), in
-;; case it needs to change.
-;; + To provide `doom-cache-persist': a mechanism for easily persisting
-;; variables across Emacs sessions.
-;; + To lazy-load persistent-soft until it is really needed.
-;;
-;; Like persistent-soft, caches assume a 2-tier structure, where all caches are
-;; namespaced by location.
-
-(defvar doom-cache-alists '(t)
- "An alist of alists, containing lists of variables for the doom cache library
-to persist across Emacs sessions.")
-
-(defvar doom-cache-location 'doom
- "The default location for cache files. This symbol is translated into a file
-name under `pcache-directory' (by default a subdirectory under
-`doom-cache-dir'). One file may contain multiple cache entries.")
-
-(defun doom-save-persistent-cache-h ()
- "Hook to run when an Emacs session is killed. Saves all persisted variables
-listed in `doom-cache-alists' to files."
- (dolist (alist (butlast doom-cache-alists 1))
- (cl-loop with key = (car alist)
- for var in (cdr alist)
- if (symbol-value var)
- do (doom-cache-set var it nil key))))
-(add-hook 'kill-emacs-hook #'doom-save-persistent-cache-h)
-
-
-;;
-;; Library
-
-;;;###autoload
-(defmacro with-cache! (location &rest body)
- "Runs BODY with a different default `doom-cache-location'."
- (declare (indent defun))
- `(let ((doom-cache-location ',location))
- ,@body))
-
-;;;###autoload
-(defun doom-cache-persist (location variables)
- "Persist VARIABLES (list of symbols) in LOCATION (symbol).
-
-This populates these variables with cached values, if one exists, and saves them
-to file when Emacs quits.
-
-Warning: this is incompatible with buffer-local variables."
- (dolist (var variables)
- (when (doom-cache-exists var location)
- (set var (doom-cache-get var location))))
- (setf (alist-get location doom-cache-alists)
- (append variables (cdr (assq location doom-cache-alists)))))
-
-;;;###autoload
-(defun doom-cache-desist (location &optional variables)
- "Unregisters VARIABLES (list of symbols) in LOCATION (symbol) from
-`doom-cache-alists', thus preventing them from being saved between sessions.
-Does not affect the actual variables themselves or their values."
- (if variables
- (setf (alist-get location doom-cache-alists)
- (cl-set-difference (cdr (assq location doom-cache-alists))
- variables))
- (delq (assq location doom-cache-alists)
- doom-cache-alists)))
-
-;;;###autoload
-(defun doom-cache-get (key &optional location)
- "Retrieve KEY from LOCATION (defaults to `doom-cache-location'), if it exists
-and hasn't expired."
- (persistent-soft-fetch
- key (symbol-name (or location doom-cache-location))))
-
-;;;###autoload
-(defun doom-cache-set (key value &optional ttl location)
- "Set KEY to VALUE in the cache. TTL is the time (in seconds) until this cache
-entry expires. LOCATION is the super-key to store this cache item under; the
-default is `doom-cache-location'. "
- (persistent-soft-store
- key value
- (symbol-name (or location doom-cache-location)) ttl))
-
-;;;###autoload
-(defun doom-cache-exists (key &optional location)
- "Returns t if KEY exists at LOCATION (defaults to `doom-cache-location')."
- (persistent-soft-exists-p key (or location doom-cache-location)))
-
-;;;###autoload
-(defun doom-cache-clear (&optional location)
- "Clear a cache LOCATION (defaults to `doom-cache-location')."
- (persistent-soft-flush (or location doom-cache-location)))
diff --git a/core/autoload/config.el b/core/autoload/config.el
index eb3acac93..cacd0d32d 100644
--- a/core/autoload/config.el
+++ b/core/autoload/config.el
@@ -76,7 +76,7 @@ Runs `doom-reload-hook' afterwards."
(interactive)
(require 'core-cli)
(when (and IS-WINDOWS (file-exists-p doom-env-file))
- (warn "Can't regenerate envvar file from within Emacs. Run 'doom env' from the console"))
+ (message "Can't regenerate envvar file from within Emacs. Run 'doom env' from the console"))
;; In case doom/reload is run before incrementally loaded packages are loaded,
;; which could cause odd load order issues.
(mapc #'require (cdr doom-incremental-packages))
@@ -136,6 +136,6 @@ imported into Emacs."
(defun doom/upgrade ()
"Run 'doom upgrade' then prompt to restart Emacs."
(interactive)
- (doom--if-compile (format "%s upgrade" doom-bin)
+ (doom--if-compile (format "%s -y upgrade" doom-bin)
(when (y-or-n-p "You must restart Emacs for the upgrade to take effect.\n\nRestart Emacs?")
(doom/restart-and-restore))))
diff --git a/core/autoload/debug.el b/core/autoload/debug.el
index 7b3f5ddcd..c6d58e8f9 100644
--- a/core/autoload/debug.el
+++ b/core/autoload/debug.el
@@ -46,10 +46,7 @@ ready to be pasted in a bug report on github."
(require 'core-packages)
(let ((default-directory doom-emacs-dir)
(doom-modules (doom-modules)))
- (cl-letf
- (((symbol-function 'sh)
- (lambda (&rest args)
- (cdr (apply #'doom-call-process args)))))
+ (letf! (defun sh (&rest args) (cdr (apply #'doom-call-process args)))
`((emacs
(version . ,emacs-version)
(features ,@system-configuration-features)
diff --git a/core/autoload/files.el b/core/autoload/files.el
index 65d0a6639..b62925d43 100644
--- a/core/autoload/files.el
+++ b/core/autoload/files.el
@@ -203,52 +203,29 @@ single file or nested compound statement of `and' and `or' statements."
;;
;;; Helpers
-(defun doom--forget-file (path)
- "Ensure `recentf', `projectile' and `save-place' forget OLD-PATH."
- (when (bound-and-true-p recentf-mode)
- (recentf-remove-if-non-kept path))
- (when (and (bound-and-true-p projectile-mode)
- (doom-project-p)
- (projectile-file-cached-p path (doom-project-root)))
- (projectile-purge-file-from-cache path))
- (when (bound-and-true-p save-place-mode)
- (save-place-forget-unreadable-files)))
-
-(defun doom--update-file (path)
- (when (featurep 'vc)
- (vc-file-clearprops path)
- (vc-resynch-buffer path nil t))
- (when (featurep 'magit)
- (when-let (default-directory (magit-toplevel (file-name-directory path)))
- (magit-refresh))))
-
-(defun doom--copy-file (old-path new-path &optional force-p)
- (let* ((new-path (expand-file-name new-path))
- (old-path (file-truename old-path))
- (new-path (apply #'expand-file-name
- (if (or (directory-name-p new-path)
- (file-directory-p new-path))
- (list (file-name-nondirectory old-path) new-path)
- (list new-path))))
- (new-path-dir (file-name-directory new-path))
- (project-root (doom-project-root))
- (short-new-name (if (and project-root (file-in-directory-p new-path project-root))
- (file-relative-name new-path project-root)
- (abbreviate-file-name new-path))))
- (unless (file-directory-p new-path-dir)
- (make-directory new-path-dir t))
- (when (buffer-modified-p)
- (save-buffer))
- (cond ((file-equal-p old-path new-path)
- (throw 'status 'overwrite-self))
- ((and (file-exists-p new-path)
- (not force-p)
- (not (y-or-n-p (format "File already exists at %s, overwrite?" short-new-name))))
- (throw 'status 'aborted))
- ((file-exists-p old-path)
- (copy-file old-path new-path t)
- short-new-name)
- (short-new-name))))
+(defun doom--update-files (&rest files)
+ "Ensure FILES are updated in `recentf', `magit' and `save-place'."
+ (let (toplevels)
+ (dolist (file files)
+ (when (featurep 'vc)
+ (vc-file-clearprops file)
+ (when-let (buffer (get-file-buffer file))
+ (with-current-buffer buffer
+ (vc-refresh-state))))
+ (when (featurep 'magit)
+ (when-let (default-directory (magit-toplevel (file-name-directory file)))
+ (cl-pushnew default-directory toplevels)))
+ (unless (file-readable-p file)
+ (when (bound-and-true-p recentf-mode)
+ (recentf-remove-if-non-kept file))
+ (when (and (bound-and-true-p projectile-mode)
+ (doom-project-p)
+ (projectile-file-cached-p file (doom-project-root)))
+ (projectile-purge-file-from-cache file))))
+ (dolist (default-directory toplevels)
+ (magit-refresh))
+ (when (bound-and-true-p save-place-mode)
+ (save-place-forget-unreadable-files))))
;;
@@ -256,73 +233,67 @@ single file or nested compound statement of `and' and `or' statements."
;;;###autoload
(defun doom/delete-this-file (&optional path force-p)
- "Delete FILENAME (defaults to the file associated with current buffer) and
-kills the buffer. If FORCE-P, force the deletion (don't ask for confirmation)."
+ "Delete PATH, kill its buffers and expunge it from vc/magit cache.
+
+If PATH is not specified, default to the current buffer's file.
+
+If FORCE-P, delete without confirmation."
(interactive
- (list (file-truename (buffer-file-name))
+ (list (buffer-file-name (buffer-base-buffer))
current-prefix-arg))
- (let* ((fbase (file-name-sans-extension (file-name-nondirectory path)))
- (buf (current-buffer)))
- (cond ((not (file-exists-p path))
- (error "File doesn't exist: %s" path))
- ((not (or force-p (y-or-n-p (format "Really delete %s?" fbase))))
- (message "Aborted")
- nil)
- ((unwind-protect
- (progn (delete-file path) t)
- (let ((short-path (file-relative-name path (doom-project-root))))
- (if (file-exists-p path)
- (error "Failed to delete %s" short-path)
- ;; Ensures that windows displaying this buffer will be switched
- ;; to real buffers (`doom-real-buffer-p')
- (doom/kill-this-buffer-in-all-windows buf t)
- (doom--forget-file path)
- (doom--update-file path)
- (message "Successfully deleted %s" short-path))))))))
+ (let* ((path (or path (buffer-file-name (buffer-base-buffer))))
+ (short-path (abbreviate-file-name path)))
+ (unless (and path (file-exists-p path))
+ (user-error "Buffer is not visiting any file"))
+ (unless (file-exists-p path)
+ (error "File doesn't exist: %s" path))
+ (unless (or force-p (y-or-n-p (format "Really delete %S?" short-path)))
+ (user-error "Aborted"))
+ (let ((buf (current-buffer)))
+ (unwind-protect
+ (progn (delete-file path) t)
+ (if (file-exists-p path)
+ (error "Failed to delete %S" short-path)
+ ;; Ensures that windows displaying this buffer will be switched to
+ ;; real buffers (`doom-real-buffer-p')
+ (doom/kill-this-buffer-in-all-windows buf t)
+ (doom--update-files path)
+ (message "Deleted %S" short-path))))))
;;;###autoload
(defun doom/copy-this-file (new-path &optional force-p)
- "Copy current buffer's file to NEW-PATH. If FORCE-P, overwrite the destination
-file if it exists, without confirmation."
+ "Copy current buffer's file to NEW-PATH.
+
+If FORCE-P, overwrite the destination file if it exists, without confirmation."
(interactive
(list (read-file-name "Copy file to: ")
current-prefix-arg))
- (pcase (catch 'status
- (when-let (dest (doom--copy-file (buffer-file-name) new-path force-p))
- (doom--update-file new-path)
- (message "File successfully copied to %s" dest)))
- (`overwrite-self (error "Cannot overwrite self"))
- (`aborted (message "Aborted"))
- (_ t)))
+ (unless (and buffer-file-name (file-exists-p buffer-file-name))
+ (user-error "Buffer is not visiting any file"))
+ (let ((old-path (buffer-file-name (buffer-base-buffer)))
+ (new-path (expand-file-name new-path)))
+ (make-directory (file-name-directory new-path) 't)
+ (copy-file old-path new-path (or force-p 1))
+ (doom--update-files old-path new-path)
+ (message "File copied to %S" (abbreviate-file-name new-path))))
;;;###autoload
(defun doom/move-this-file (new-path &optional force-p)
- "Move current buffer's file to NEW-PATH. If FORCE-P, overwrite the destination
-file if it exists, without confirmation."
+ "Move current buffer's file to NEW-PATH.
+
+If FORCE-P, overwrite the destination file if it exists, without confirmation."
(interactive
(list (read-file-name "Move file to: ")
current-prefix-arg))
- (pcase (catch 'status
- (let ((old-path (buffer-file-name))
- (new-path (expand-file-name new-path)))
- (when-let (dest (doom--copy-file old-path new-path force-p))
- (doom--forget-file old-path)
- (when (file-exists-p old-path)
- (delete-file old-path))
- (mapc #'doom--update-file
- (delq
- nil (list (if (ignore-errors
- (file-equal-p (doom-project-root old-path)
- (doom-project-root new-path)))
- nil
- old-path)
- new-path)))
- (kill-current-buffer)
- (find-file new-path)
- (message "File successfully moved to %s" dest))))
- (`overwrite-self (error "Cannot overwrite self"))
- (`aborted (message "Aborted"))
- (_ t)))
+ (unless (and buffer-file-name (file-exists-p buffer-file-name))
+ (user-error "Buffer is not visiting any file"))
+ (let ((old-path (buffer-file-name (buffer-base-buffer)))
+ (new-path (expand-file-name new-path)))
+ (make-directory (file-name-directory new-path) 't)
+ (rename-file old-path new-path (or force-p 1))
+ (set-visited-file-name new-path t t)
+ (doom--update-files old-path new-path)
+ (message "File moved to %S" (abbreviate-file-name new-path))))
(defun doom--sudo-file-path (file)
(let ((host (or (file-remote-p file 'host) "localhost")))
diff --git a/core/autoload/help.el b/core/autoload/help.el
index 3c5954d7d..060731b18 100644
--- a/core/autoload/help.el
+++ b/core/autoload/help.el
@@ -3,9 +3,6 @@
(defvar doom--help-major-mode-module-alist
'((dockerfile-mode :tools docker)
(agda2-mode :lang agda)
- (haxor-mode :lang assembly)
- (mips-mode :lang assembly)
- (nasm-mode :lang assembly)
(c-mode :lang cc)
(c++-mode :lang cc)
(objc++-mode :lang cc)
@@ -41,6 +38,7 @@
(LaTeX-mode :lang latex)
(ledger-mode :lang ledger)
(lua-mode :lang lua)
+ (moonscript-mode :lang lua)
(markdown-mode :lang markdown)
(gfm-mode :lang markdown)
(nim-mode :lang nim)
@@ -48,6 +46,7 @@
(taureg-mode :lang ocaml)
(org-mode :lang org)
(perl-mode :lang perl)
+ (raku-mode :lang perl)
(php-mode :lang php)
(hack-mode :lang php)
(plantuml-mode :lang plantuml)
@@ -56,7 +55,9 @@
(restclient-mode :lang rest)
(ruby-mode :lang ruby)
(rust-mode :lang rust)
+ (rustic-mode :lang rust)
(scala-mode :lang scala)
+ (scheme-mode :lang scheme)
(sh-mode :lang sh)
(swift-mode :lang swift)
(web-mode :lang web)
@@ -134,7 +135,8 @@ selection of all minor-modes, active or not."
(list (or (+org-get-global-property "TITLE")
(file-relative-name (buffer-file-name)))))
path
- (list (replace-regexp-in-string org-link-any-re "\\4" text)))
+ (when text
+ (list (replace-regexp-in-string org-link-any-re "\\4" text))))
" > ")
tags)
" ")
diff --git a/core/autoload/projects.el b/core/autoload/projects.el
index edce48b76..b71623bf6 100644
--- a/core/autoload/projects.el
+++ b/core/autoload/projects.el
@@ -101,11 +101,10 @@ If DIR is not a project, it will be indexed (but not cached)."
(unless (file-readable-p dir)
(error "Directory %S isn't readable" dir))
(let* ((default-directory (file-truename (expand-file-name dir)))
- (project-root (doom-project-root default-directory))
- (projectile-project-root default-directory)
+ (projectile-project-root (doom-project-root default-directory))
(projectile-enable-caching projectile-enable-caching))
- (cond ((and project-root (file-equal-p project-root projectile-project-root))
- (unless (doom-project-p projectile-project-root)
+ (cond ((and projectile-project-root (file-equal-p projectile-project-root default-directory))
+ (unless (doom-project-p default-directory)
;; Disable caching if this is not a real project; caching
;; non-projects easily has the potential to inflate the projectile
;; cache beyond reason.
diff --git a/core/autoload/sessions.el b/core/autoload/sessions.el
index 0d2833802..de08be93d 100644
--- a/core/autoload/sessions.el
+++ b/core/autoload/sessions.el
@@ -130,8 +130,11 @@
(interactive "P")
(setq doom-autosave-session nil)
(doom/quicksave-session)
- (restart-emacs
- (append (if debug (list "--debug-init"))
- (when (boundp 'chemacs-current-emacs-profile)
- (list "--with-profile" chemacs-current-emacs-profile))
- (list "--restore"))))
+ (save-some-buffers nil t)
+ (letf! ((#'save-buffers-kill-emacs #'kill-emacs)
+ (confirm-kill-emacs))
+ (restart-emacs
+ (append (if debug (list "--debug-init"))
+ (when (boundp 'chemacs-current-emacs-profile)
+ (list "--with-profile" chemacs-current-emacs-profile))
+ (list "--restore")))))
diff --git a/core/autoload/store.el b/core/autoload/store.el
new file mode 100644
index 000000000..92ac05832
--- /dev/null
+++ b/core/autoload/store.el
@@ -0,0 +1,142 @@
+;;; core/autoload/cache.el -*- lexical-binding: t; -*-
+
+;; This little library abstracts the process of writing arbitrary elisp values
+;; to a 2-tiered file store (in `doom-store-dir'/`doom-store-location').
+
+(defvar doom-store-dir (concat doom-etc-dir "store/")
+ "Directory to look for and store data accessed through this API.")
+
+(defvar doom-store-persist-alist '(t)
+ "An alist of alists, containing lists of variables for the doom cache library
+to persist across Emacs sessions.")
+
+(defvar doom-store-location "default"
+ "The default location for cache files. This symbol is translated into a file
+name under `pcache-directory' (by default a subdirectory under
+`doom-store-dir'). One file may contain multiple cache entries.")
+
+(defvar doom--store-table (make-hash-table :test 'equal))
+(defvar doom--inhibit-flush nil)
+
+(defun doom-save-persistent-store-h ()
+ "Hook to run when an Emacs session is killed. Saves all persisted variables
+listed in `doom-store-persist-alist' to files."
+ (let (locations)
+ (let ((doom--inhibit-flush t))
+ (dolist (alist (butlast doom-store-persist-alist 1))
+ (cl-loop with location = (car alist)
+ for var in (cdr alist)
+ do (doom-store-put var (symbol-value var) nil location)
+ and do (cl-pushnew location locations))))
+ (mapc #'doom--store-flush locations)))
+(add-hook 'kill-emacs-hook #'doom-save-persistent-store-h)
+
+
+;;
+;; Library
+
+;;;###autoload
+(defun doom-store-persist (location variables)
+ "Persist VARIABLES (list of symbols) in LOCATION (symbol).
+This populates these variables with cached values, if one exists, and saves them
+to file when Emacs quits. This cannot persist buffer-local variables."
+ (dolist (var variables)
+ (when (doom-store-member-p var location)
+ (set var (doom-store-get var location))))
+ (setf (alist-get location doom-store-persist-alist)
+ (append variables (alist-get location doom-store-persist-alist))))
+
+;;;###autoload
+(defun doom-store-desist (location &optional variables)
+ "Unregisters VARIABLES (list of symbols) in LOCATION (symbol).
+Variables to persist are recorded in `doom-store-persist-alist'. Does not affect
+the actual variables themselves or their values."
+ (if variables
+ (setf (alist-get location doom-store-persist-alist)
+ (cl-set-difference (cdr (assq location doom-store-persist-alist))
+ variables))
+ (delq! location doom-store-persist-alist 'assoc)))
+
+(defun doom--store-init (location)
+ (or (gethash location doom--store-table)
+ (let* ((file-name-handler-alist nil)
+ (location-path (expand-file-name location doom-store-dir)))
+ (if (file-exists-p location-path)
+ (puthash location
+ (with-temp-buffer
+ (set-buffer-multibyte nil)
+ (setq buffer-file-coding-system 'binary)
+ (insert-file-contents-literally location-path)
+ (read (current-buffer)))
+ doom--store-table)
+ (puthash location (make-hash-table :test 'equal)
+ doom--store-table)))))
+
+(defun doom--store-get (key location &optional default-value)
+ (let* ((location-data (doom--store-init location))
+ (data (gethash key location-data default-value)))
+ (if (and (not (eq data default-value))
+ (or (null (car data))
+ (not (time-less-p (car data) (current-time)))))
+ (cdr data)
+ default-value)))
+
+(defun doom--store-put (key value location &optional ttl)
+ (puthash key (cons (if ttl (time-add (current-time) ttl)) value)
+ (doom--store-init location))
+ (doom--store-flush location))
+
+(defun doom--store-flush (location)
+ (unless doom--inhibit-flush
+ (let ((file-name-handler-alist nil)
+ (coding-system-for-write 'binary)
+ (write-region-annotate-functions nil)
+ (write-region-post-annotation-function nil)
+ (data (doom--store-init location)))
+ (make-directory doom-store-dir 'parents)
+ (with-temp-file (expand-file-name location doom-store-dir)
+ (prin1 data (current-buffer)))
+ data)))
+
+
+;;;###autoload
+(defun doom-store-get (key &optional location default-value)
+ "Retrieve KEY from LOCATION (defaults to `doom-store-location').
+If it doesn't exist or has expired, DEFAULT_VALUE is returned."
+ (doom--store-get key (or location doom-store-location) default-value))
+
+;;;###autoload
+(defun doom-store-put (key value &optional ttl location)
+ "Set KEY to VALUE in the store at LOCATION.
+KEY can be any lisp object that is comparable with `equal'. TTL is the time (in
+seconds) until this cache entry expires. LOCATION is the super-key to store this
+cache item under. It defaults to `doom-store-location'."
+ (doom--store-put key value (or location doom-store-location) ttl))
+
+;;;###autoload
+(defun doom-store-rem (key &optional location)
+ "Clear a cache LOCATION (defaults to `doom-store-location')."
+ (let ((location (or location doom-store-location)))
+ (remhash key (doom--store-init location))
+ (let ((table (doom--store-init "default")))
+ (remhash 'test table)
+ table)
+ (doom--store-flush location)))
+
+;;;###autoload
+(defun doom-store-member-p (key &optional location)
+ "Return t if KEY in LOCATION exists.
+LOCATION defaults to `doom-store-location'."
+ (let ((nil-value (format "--nilvalue%s--" (current-time))))
+ (not (equal (doom-store-get key location nil-value)
+ nil-value))))
+
+;;;###autoload
+(defun doom-store-clear (&optional location)
+ "Clear the store at LOCATION (defaults to `doom-store-location')."
+ (let* ((location (or location doom-store-location))
+ (path (expand-file-name location doom-store-dir)))
+ (remhash location doom--store-table)
+ (when (file-exists-p path)
+ (delete-file path)
+ t)))
diff --git a/core/cli/autoloads.el b/core/cli/autoloads.el
index cfc03ba57..8150513c3 100644
--- a/core/cli/autoloads.el
+++ b/core/cli/autoloads.el
@@ -32,14 +32,16 @@ one wants that.")
(cl-check-type file string)
(and (print! (start "Generating core autoloads..."))
(doom-cli--write-autoloads
- file (doom-cli--generate-autoloads
- (cl-loop for dir
- in (append (list doom-core-dir)
- (cdr (doom-module-load-path 'all-p))
- (list doom-private-dir))
- if (doom-glob dir "autoload.el") collect it
- if (doom-glob dir "autoload/*.el") append it)
- 'scan))
+ file
+ (doom-cli--generate-emacs-version-check)
+ (doom-cli--generate-autoloads
+ (cl-loop for dir
+ in (append (list doom-core-dir)
+ (cdr (doom-module-load-path 'all-p))
+ (list doom-private-dir))
+ if (doom-glob dir "autoload.el") collect it
+ if (doom-glob dir "autoload/*.el") append it)
+ 'scan))
(print! (start "Byte-compiling core autoloads file..."))
(doom-cli--byte-compile-file file)
(print! (success "Generated %s")
@@ -105,6 +107,12 @@ one wants that.")
(print! "M-x doom/restart")
(print! "M-x doom/reload")))
+(defun doom-cli--generate-emacs-version-check ()
+ `((unless (equal emacs-major-version (eval-when-compile emacs-major-version))
+ (signal 'doom-error
+ (list "Your installed (major) version of Emacs has changed"
+ "Run 'doom sync && doom build' to bring Doom up to speed")))))
+
(defun doom-cli--generate-var-cache (vars)
`((setq ,@(cl-loop for var in vars
append `(,var ',(symbol-value var))))))
diff --git a/core/cli/doctor.el b/core/cli/doctor.el
index 5f790ccfa..22e690e2e 100644
--- a/core/cli/doctor.el
+++ b/core/cli/doctor.el
@@ -123,11 +123,8 @@ in."
"both is rarely intentional; you should one or the other."))
;; Check for fonts
- (if (not (fboundp 'find-font))
- (progn
- (warn! "Warning: unable to detect font")
- (explain! "The `find-font' function is missing. This could indicate the incorrect "
- "version of Emacs is being used!"))
+ (if (not (executable-find "fc-list"))
+ (warn! "Warning: unable to detect fonts because fontconfig isn't installed")
;; all-the-icons fonts
(when (and (pcase system-type
(`gnu/linux (concat (or (getenv "XDG_DATA_HOME")
diff --git a/core/cli/env.el b/core/cli/env.el
index bb546ede1..f13a838d3 100644
--- a/core/cli/env.el
+++ b/core/cli/env.el
@@ -113,10 +113,11 @@ default, on Linux, this is '$SHELL -ic /usr/bin/env'. Variables in
"# run 'doom sync'. To create a safe-to-edit envvar file use:\n#\n"
"# doom env -o ~/.doom.d/myenv\n#\n"
"# And load it with (doom-load-envvars-file \"~/.doom.d/myenv\").\n")
- (concat "# This file is safe to edit by hand, but needs to be loaded manually with:\n#\n"
+ (concat "# This file is safe to edit by hand, but remember to preserve the null bytes at\n"
+ "# the end of each line! needs to be loaded manually with:\n#\n"
"# (doom-load-envvars-file \"path/to/this/file\")\n#\n"
"# Use 'doom env -o path/to/this/file' to regenerate it."))
- "# ---------------------------------------------------------------------------\n\n"))
+ "# ---------------------------------------------------------------------------\n\0\n"))
;; We assume that this noninteractive session was spawned from the
;; user's interactive shell, therefore we just dump
;; `process-environment' to a file.
@@ -124,7 +125,7 @@ default, on Linux, this is '$SHELL -ic /usr/bin/env'. Variables in
(if (cl-find-if (doom-rpartial #'string-match-p (car (split-string env "=")))
doom-env-ignored-vars)
(print! (info "Ignoring %s") env)
- (insert env "\n")))
+ (insert env "\0\n")))
(print! (success "Successfully generated %S")
(path env-file))
t))))))
diff --git a/core/core-cli.el b/core/core-cli.el
index cc1511b37..852f6fd43 100644
--- a/core/core-cli.el
+++ b/core/core-cli.el
@@ -258,7 +258,7 @@ BODY will be run when this dispatcher is called."
(print! "%2s) %s" (1+ (length options))
(if (cl-find-if (doom-rpartial #'string-match-p desc)
doom--cli-straight-discard-options)
- (concat desc " (Recommended)")
+ (green (concat desc " (Recommended)"))
desc))))
(terpri)
(let* ((options
diff --git a/core/core-editor.el b/core/core-editor.el
index b08f53670..d4638d5c6 100644
--- a/core/core-editor.el
+++ b/core/core-editor.el
@@ -174,6 +174,8 @@ possible."
(push '("/LICENSE\\'" . text-mode) auto-mode-alist)
(push '("\\.log\\'" . text-mode) auto-mode-alist)
+(push '("rc\\'" . conf-mode) auto-mode-alist)
+(push '("\\.\\(?:hex\\|nes\\)\\'" . hexl-mode) auto-mode-alist)
;;
@@ -291,10 +293,7 @@ possible."
`pp' can be expensive for longer lists, and there's no reason to prettify cache
files, so we replace calls to `pp' with the much faster `prin1'."
:around #'save-place-alist-to-file
- (cl-letf (((symbol-function #'pp) #'prin1))
- (funcall orig-fn)))
-
- (save-place-mode +1))
+ (letf! ((#'pp #'prin1)) (funcall orig-fn))))
(use-package! server
@@ -392,18 +391,14 @@ files, so we replace calls to `pp' with the much faster `prin1'."
`nim-mode'. This prevents them from leaving Emacs in a broken state."
:around #'dtrt-indent-mode
(let ((dtrt-indent-run-after-smie dtrt-indent-run-after-smie))
- (cl-letf* ((old-smie-config-guess (symbol-function 'smie-config-guess))
- (old-smie-config--guess (symbol-function 'symbol-config--guess))
- ((symbol-function 'symbol-config--guess)
- (lambda (beg end)
- (funcall old-smie-config--guess beg (min end 10000))))
- ((symbol-function 'smie-config-guess)
- (lambda ()
- (condition-case e (funcall old-smie-config-guess)
- (error (setq dtrt-indent-run-after-smie t)
- (message "[WARNING] Indent detection: %s"
- (error-message-string e))
- (message "")))))) ; warn silently
+ (letf! ((defun symbol-config--guess (beg end)
+ (funcall symbol-config--guess beg (min end 10000)))
+ (defun smie-config-guess ()
+ (condition-case e (funcall smie-config-guess)
+ (error (setq dtrt-indent-run-after-smie t)
+ (message "[WARNING] Indent detection: %s"
+ (error-message-string e))
+ (message ""))))) ; warn silently
(funcall orig-fn arg)))))
@@ -419,8 +414,8 @@ files, so we replace calls to `pp' with the much faster `prin1'."
(defun doom-use-helpful-a (orig-fn &rest args)
"Force ORIG-FN to use helpful instead of the old describe-* commands."
- (cl-letf (((symbol-function #'describe-function) #'helpful-function)
- ((symbol-function #'describe-variable) #'helpful-variable))
+ (letf! ((#'describe-function #'helpful-function)
+ (#'describe-variable #'helpful-variable))
(apply orig-fn args)))
(after! apropos
@@ -484,8 +479,9 @@ files, so we replace calls to `pp' with the much faster `prin1'."
(defun doom-init-smartparens-in-minibuffer-maybe-h ()
"Enable `smartparens-mode' in the minibuffer, during `eval-expression',
`pp-eval-expression' or `evil-ex'."
- (when (memq this-command '(eval-expression pp-eval-expression evil-ex))
- (smartparens-mode))))
+ (and (memq this-command '(eval-expression pp-eval-expression evil-ex))
+ smartparens-global-mode
+ (smartparens-mode))))
;; You're likely writing lisp in the minibuffer, therefore, disable these
;; quote pairs, which lisps doesn't use for strings:
diff --git a/core/core-keybinds.el b/core/core-keybinds.el
index a79258aee..0e89a270c 100644
--- a/core/core-keybinds.el
+++ b/core/core-keybinds.el
@@ -77,7 +77,8 @@ all hooks after it are ignored.")
:init
;; Convenience aliases
(defalias 'define-key! #'general-def)
- (defalias 'unmap! #'general-unbind))
+ (defalias 'undefine-key! #'general-unbind))
+
;; HACK `map!' uses this instead of `define-leader-key!' because it consumes
;; 20-30% more startup time, so we reimplement it ourselves.
@@ -108,8 +109,8 @@ all hooks after it are ignored.")
(general--concat t doom-leader-key ,key)
,desc))))))))
(macroexp-progn
- (cons `(after! which-key ,@(nreverse wkforms))
- (nreverse forms)))))
+ (append (and wkforms `((after! which-key ,@(nreverse wkforms))))
+ (nreverse forms)))))
(defmacro define-leader-key! (&rest args)
"Define