binarin / .emacs.d

Emacs for the stubborn martian vimmer

This is an Emacs configuration for a stubborn, melodramatic and shell-dwelling vimmer disappointed with the text-editor status quo.

Doom tries to: look and act like modern editors (whatever that means to me on any given day), espouse vim's modal philosophy as best it can and strive to surpass vim in any way possible. It fits my needs as a software developer, indie game developer, scientist and doom enthusiast.

It was tailored for Emacs 25.1+ on MacOS 10.11+ and Arch Linux 4.7+. I use vim everywhere else.

Installation

git clone https://github.com/hlissner/.emacs.d ~/.emacs.d
cd ~/.emacs.d
cp init.example.el init.el  # maybe edit init.el
make install
make compile       # optional, may take a while
make compile-lite  # optional (lighter alternative to compile)

# If you have problems, run this to diagnose any common problems
make doctor

If you change init.el or add/remove functions to autoload files, run make. That is the equivalent of running:

make install       # or (doom/packages-install)
make autoloads     # or (doom/reload-autoloads)

You can run any Make command with DEBUG=1 for added logging verbosity, and YES=1 to auto-accept any confirmation prompts.

Deciphering my emacs.d

So you want to grok some of this madness. Here are a few suggestions:

• init.example.el: a birds eye view of available modules
• modules/README.md: a primer into module structure and how the module system works.
• modules/private/hlissner/+bindings.el: my custom keybinds.
• modules/private/hlissner/+commands.el: my custom ex commands.
• modules/ui: the modules that makes my Emacs look the way it does, including my theme, modeline, dashboard and more.
• Find screenshots in the screenshots branch.

Highlights

• A popup window management system using shackle to minimize mental context switching while dealing with temporary or disposable buffers.
• Per-project code-style settings with editorconfig. Let someone else argue about tabs versus spaces (spaces > tabs, btw).
• Workspaces & session persistence with persp-mode. This provides tab emulation that vaguely resembles vim tabs.
• Project & workspace-aware buffer navigation and functions.
• A vim-centric environment with evil-mode
  • 2-character motions (ala vim-seek/vim-sneak) with evil-snipe
  • Sublime Text-esque multiple cursors with evil-mc and evil-multiedit
  • Repeat (most) motions with SPC and shift+SPC (backwards)
  • C-x omnicompletion in insert mode
• Fast search utilities:
  • Project and buffer navigation with ivy
  • File browser sidebar with neotree
  • Project text search powered by the silver searcher and ripgrep (see :ag and :rg)
  • Project search & replace with wgrep
  • Interactive buffer search with swiper
• REPLs & inline/live code evaluation (using quickrun) with languages support for Ruby, Python, PHP, JS, Elisp, Haskell, Lua and more.
• Minimalistic diffs in the fringe with git-gutter-fringe.
• A do-what-I-mean jump-to-definition implementation that tries its darnest to find the definition of what you're looking at. It tries major-mode commands, xref (experimental Emacs library) dumb-jump, ctags (WIP), then counsel-ag.
• Snippets and file-templates with yasnippet.
• A smarter, perdier, Atom-inspired mode-line that includes:
  • evil-search/iedit/evil-substitute mode-line integration
  • Macro-recording indicator
  • Python/ruby version in mode-line (for rbenv/pyenv)
• Emacs as an:
  • Email client (using mu4e & offlineimap)
  • Presentation app (using org-tree-slides, ox-reveal, +present/big-mode & impatient-mode)
  • RSS feed reader (using elfeed)
  • Word Processor (using LaTeX, Org and Markdown)

Contributing or troubleshooting

My config wasn't intended for public use, but I'm happy to help you use or crib from my config. I welcome contributions of any kind; documentation, bug fixes/reports, even elisp tips.

Don't hesitate to tell me my Elisp-fu sucks!