doomemacs/README.md

NARF Emacs

What we do every night, Pinky...

This is an Emacs configuration for stubborn vimmers and megalomaniacal mice alike. It strives to emulate vim as best it can, and surpass it in any way possible.

It is tailored to my needs as an software developer (app, game, and web), data scientist, and writer running OSX and Emacs 24.5+.

Installation

brew install cask
brew tap railwaycat/emacsmacport
brew install emacs-mac --with-imagemagick --with-modern-icon
git clone --depth 1 https://github.com/hlissner/emacs.d ~/.emacs.d
cd ~/.emacs.d
make          # installs plugins via cask and generates autoloads

And to optionally:

make compile  # optionally byte-compiles everything
make snippets # install hlissner/emacs-snippets into private/snippets

Features

To get a picture of what's in here, check out:

• The Caskfile: lists installed plugins and where they're configured.
• init.el: lists all loaded modules
• private/my-bindings.el: most of the custom keybinds
• private/my-commands.el: available custom ex commands

Basic

• Modal editing with evil-mode
• Pretty line numbers with nlinum and neckbearded hackery
• Syntax checking with Flycheck
• Completion with company-mode
• Pretty mode-line with spaceline
• Project navigation with helm and neotree
• Session persistence (and tab emulation) with workgroups2
• Run code inline with quickrun
• On-demand REPLs for many major modes with repl-toggle, including Ruby, Python, PHP, JS, Elisp, and Lua.
• 2-char searching with evil-snipe
• Display diffs in the margin with git-gutter
• Repeat (most) motions with SPC
• Snippet expansion with yasnippet
• File template support with auto-insert and yasnippet
• Code folding with hideshow; doesn't allow arbitrary folds though
• Multiple cursors with evil-multiedit
• O/S interaction functions, like os-reveal and os-open-in-browser
• Custom TODO, FIXME and NOTE highlighting
• big-mode for presentations and demonstrations
• Tmux integration with :t and :tcd ex commands

Advanced

• Popup control with Shackle: I've (mostly) tamed window popups in Emacs with Shackle (popwin was unstable and slow), that includes those made by: Helm, vc-annotate, quickrun, neotree, *messages*, org-mode--and others.

• Ex compatibility: I've given quite a few plugins an Ex interface. For instance, :t [ARGS] and :tcd for tmux, :ag [KEYWORDS] for helm-ag, and :align [REGEXP] for align-regexp. See private/my-commands.el for more.

• Incremental highlighting for :g[lobal]: evil's stock global command does not do this (:align will also highlight matches).

• A multiple cursor implementation using iedit: I could never get evil-mc working, and multiple-cursors doesn't play nice with evil-mode, so I wrote evil-multiedit. To use it, hop into visual mode, select a region and press S-r (shift-R). Your edits will apply to all highlighted regions. To limit iedit's scope: while in iedit mode go into visual, select a range and press SPC.

• Rudimentary support for extra =expand(...) symbols in evil-ex: this includes %:[pdert], which can be used with ex commands like :e, :w, or in the expression register. This could be truer to vim, but I haven't gotten around to it.

• Vim-esque Omni-completion commands: I've implemented most of the common omni-completion shortcuts:

  C-x C-l   'narf/company-whole-lines
  C-x C-k   'narf/company-dict-or-keywords
  C-x C-f   'company-files
  C-x C-]   'company-tags
  C-x s     'company-ispell
  C-x C-s   'company-yasnippet
  C-x C-o   'company-semantic
  C-x C-n   'company-dabbrev-code
  C-x C-p   (lambda (interactive)
              (let ((company-selection-wrap-around t))
                (call-interactively 'company-dabbrev-code)
                (company-select-previous-or-abort))))
  

• Popup REPLs: currently supports python (ipython), ruby (pry), php (boris), elisp (ielm), lua, js (nodejs), and the shell. More support later, hopefully for go and rust.

• Yasnippet + auto-insert = file-templates with editable fields: and it works with evil-mode! See core/core-file-templates.el for configuration details.

• Tab emulation with Workgroups2: Workgroups2 will display the tabs in the minibuffer when you press ⌘-S-T, use :tabs or move between "tabs". gt and gT work as well.

  

  ⌘-1 - ⌘-9 keybindings work as well.

• Minimalistic mapping macro: I liked how concise mapping keys in viml was. I brought a little of that to Emacs by defining map!, a macro for defining keybindings in as little space as possible. See my bindings for an example.

• Modeline improvements

  • evil-search/iedit/evil-substitute mode-line integration: I better integrated Anzu, evil-search, evil-substitute (e.g. %s/foo/bar) and evil-multiedit into the mode-line.

    

  • Macro-recording indicator:

    

  • Show (py|rb)env version in mode-line: see define-env-command! on how to set it up for other modes. It only displays in their respective major-modes.

    

What about Windo-