No description
Find a file
Henrik Lissner a01aeb6daf
Make helm the default completion module for Doom
It's been a change a long time coming. Ivy's snappiness and simple API
was Ivy's selling point (as far as Doom is concerned). It helps that
much of helm's vast featureset has been ported over and its API is so
much simpler to grok, but its greatest weakness lies in its choice of
display mechanism: the minibuffer.

Ivy's performance suffers dramatically with large datasets because
mutating results in the minibuffer blocks the minibuffer, which also
happens to be where we type in our queries. This can make input feel
dreadfully sluggish in the best cases, locking up Emacs entirely in the
worst.

Helm updates a buffer asynchronously, so it suffers none of this (though
the overhead of maintaining this buffer is certainly overkill for tiny
datasets).

And Ivy's simple API, while easier to understand, is significantly less
powerful. That it takes so much effort to grok Helm is a huge turn
off (and of course, no fault of the dev). Still, there simply is no
excuse for power users like myself to not do so anyway. The more I learn
about it, the more I wonder why I stuck to ivy for so long (but also
reminds me exactly why I did)!
2018-08-06 00:31:23 +02:00
.github Update issue/pr templates 2018-01-02 14:41:10 -05:00
bin Add ability to pass additional args to 'doom run' 2018-07-16 16:35:05 -07:00
core Add python & enh-ruby support to hes-mode 2018-08-06 00:31:23 +02:00
modules Fix workspace-restricted helm-buffers-list 2018-08-06 00:31:23 +02:00
.gitignore Remove redundant .cask/ entry in gitignore 2018-07-14 23:16:39 +02:00
.travis.yml travis: disable debug output while installing 2018-06-15 04:33:41 +02:00
early-init.el Move startup optimization to early-init 2018-06-16 11:38:19 +02:00
init.el Load early-init.el if early-init-file is not bound *and* true 2018-07-12 16:38:58 -07:00
init.example.el Make helm the default completion module for Doom 2018-08-06 00:31:23 +02:00
init.test.el Add :ui popup to init.test.el 2018-06-23 23:23:23 +02:00
LICENSE Update license year 2018-02-01 01:49:13 -05:00
Makefile Double quote doom binary location 2018-07-14 19:21:16 +01:00
README.md Update README with new make quickstart workflow 2018-04-04 06:17:56 -04:00

Current release build status (master) build status (develop) Chat on discord Main screenshot


Wiki | Screenshots | Troubleshooting | FAQ | Changelog


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 finally succumbing to the dark side. This is his config.

Doom strives to be fast, fabulous and hacker friendly. It is tailored for neckbeards with blue belts or better in command-line-fu, Elisp and git.

Doom only supports Emacs >= 25.1, and is tested on Arch Linux 4.7+ and MacOS 10.11. YMMV on other platforms.


Quick start

git clone https://github.com/hlissner/doom-emacs ~/.emacs.d
cd ~/.emacs.d
make quickstart

Don't forget to run make each time you modify init.el or update Doom!

Visit the wiki for a more detailed guide on installing, customizing and grokking Doom.

Feature highlights

  • A fast, organized and opinionated Emacs configuration with a command line interface.
  • A custom, declarative package management system that combines package.el, use-package and quelpa, allowing you to manage packages from the command line and install packages from sources other than ELPA.
  • A popup management system (powered by shackle) that minimizes the presence and footprint of temporary and/or disposable buffers.
  • A vim-like experience with evil-mode, including ports for several vim plugins, C-x omnicompletion and a slew of custom ex commands.
  • Integration with editorconfig. Let someone else argue about tabs and spaces. (spaces, duh).
  • Code completion for many languages, powered by company-mode (some languages may have external dependencies).
  • Project-awareness powered by projectile, with tools and an API to navigate and manage projects and their files.
  • Fast project search (and replace) utilities, powered by the_silver_searcher, ripgrep and wgrep, with integration for ivy (the default), helm and ido.
  • Isolated and persistent workspaces powered by persp-mode. Also substitutes for vim tabs.
  • Inline/live code evaluation (using quickrun), including REPLs for a variety of languages.

Troubleshooting

Found a problem? Here are some things to try:

  • Run make install to ensure all plugins are installed.
  • void-function or void-variable errors could signal an out-of-date autoloads file. Run make autoloads or M-x doom//reload-autoloads to update it.
  • Scan for common OS/environment issues with make doctor.
  • Never debug byte-compiled code. It will interfere in subtle ways. Clean up *.elc files with make clean or M-x doom//clean-byte-compiled-files.
  • Check the FAQ to see if your issue is mentioned.
  • Check the relevant module's README.org, if one exists. There may be extra steps to getting certain features to work.

If all else has failed, file a bug report.

Contribute

Doom (and my Emacs work in general) is a labor of love and incurable madness, done on my spare time. It wasn't intended for public use, but I enjoy making Doom a resource for others.

If you'd like to support my efforts, I welcome contributions of any kind:

  • I love pull requests and bug reports. Elisp pointers are especially welcome. Seriously, don't hesitate to tell me my Elisp-fu sucks!
  • Talk to me about Emacs workflow, ideas or tooling. Or talk to me about gamedev, or pixel art, or anime, or programming, or the weather, or band camp. Whatever. I don't mind. Holler at henrik@lissner.net.