History

Henrik Lissner 0e851ace9b Backport bits of CLI rewrite The rewrite for Doom's CLI is taking a while, so I've backported a few important changes in order to ease the transition and fix a couple bugs sooner. Fixes #2802, #2737, #2386 The big highlights are: - Fix #2802: We now update recipe repos before updating/installing any new packages. No more "Could not find package X in recipe repositories". - Fix #2737: An edge case where straight couldn't reach a pinned commit (particularly with agda). - Doom is now smarter about what option it recommends when straight prompts you to make a choice. - Introduces a new init path for Doom. The old way: - Launch in "minimal" CLI mode in non-interactive sessions - Launch a "full" interactive mode otherwise. The new way - Launch in "minimal" CLI mode only for bin/doom - Launch is a simple mode for non-interactive sessions that still need access to your interactive config (like async org export/babel). - Launch a "full" interactive mode otherwise. This should fix compatibility issues with plugins that use the async.el library or spawn child Emacs processes to fake parallelization (like org's async export and babel functionality). - Your private init.el is now loaded more reliably when running any bin/doom command. This gives you an opportunity to configure its settings. - Added doom-first-{input,buffer,file}-hook hooks, which we use to queue deferred activation of a number of packages. Users can remove these modes from these hooks; altogether preventing them from loading, rather than waiting for them to load to then disable them, e.g. (after! smartparens (smartparens-global-mode -1)) -> (remove-hook 'doom-first-buffer #'smartparens-global-mode) Hooks added to doom-first--hook variables will be removed once they run. This should also indirectly fix #2386, by preventing interactive modes from running in non-interactive session. - Added `doom/bump-` commands to make bumping modules and packages easier, and `doom/bumpify-*` commands for converting package! statements into user/repo@sha1hash format for bump commits. - straight.el is now commit-pinned, like all other packages. We also more reliably install straight.el by cloning it ourselves, rather than relying on its bootstrap.el. This should prevent infinite "straight has diverged from master" prompts whenever we change branches (though, you might have to put up with it one more after this update -- see #2937 for workaround). All the other minor changes: - Moved core/autoload/cli.el to core/autoload/process.el - The package manager will log attempts to check out pinned commits - If package state is incomplete while rebuilding packages, emit a simpler error message instead of an obscure one! - Added -u switch to 'doom sync' to make it run 'doom update' afterwards - Added -p switch to 'doom sync' to make it run 'doom purge' afterwards - Replace doom-modules function with doom-modules-list - The `with-plist!` macro was removed, since `cl-destructuring-bind` already serves that purpose well enough. - core/autoload/packages.el was moved into core-packages.el - bin/doom will no longer die if DOOMDIR or DOOMLOCALDIR don't have a trailing slash - Introduces doom-debug-variables; a list of variables to toggle on doom/toggle-debug-mode. - The sandbox has been updated to reflect the above changes, also: 1. Child instances will no longer inherit the process environment of the host instance, 2. It will no longer produce an auto-save-list directory in ~/.emacs.d		2020-05-15 01:33:52 -04:00
..
autoload	Fix #2778 : +ivy/projectile-find-file hangs in /	2020-03-27 02:30:49 -04:00
config.el	Backport bits of CLI rewrite	2020-05-15 01:33:52 -04:00
doctor.el	💥 Drop Emacs 25.x support	2019-11-08 16:02:06 -05:00
packages.el	Bump :completion ivy	2020-05-09 07:54:20 +08:00
README.org	Fix incorrect M-RET keybind in ivy readme	2020-04-20 22:53:05 -04:00

README.org

completion/ivy

Description
Prerequisites
- Install
Features
Configuration
- Enable fuzzy/non-fuzzy search for specific commands
- Change the position of the ivy childframe
Troubleshooting

Description

This module provides Ivy integration for a variety of Emacs commands, as well as a unified interface for project search and replace, powered by ripgrep.

I prefer ivy over ido for its flexibility. I prefer ivy over helm because it's lighter, simpler and faster in many cases.

Module Flags

+fuzzy Enables fuzzy completion for Ivy searches.
+prescient Enables prescient filtering and sorting for Ivy searches.
+childframe Causes Ivy to display in a floating child frame, above Emacs.
+icons Enables file icons for switch-{buffer,project}/find-file counsel commands.

Plugins

ivy
counsel
counsel-projectile
swiper
ivy-hydra
ivy-rich
wgrep
amx
flx* (+fuzzy)
prescient* (+prescient)
ivy-posframe* (+childframe)
all-the-icons-ivy* (+icons)

Hacks

Functions with ivy/counsel equivalents have been globally remapped (like find-file => counsel-find-file). So a keybinding to find-file will invoke counsel-find-file instead.
counsel-[arp]g's 3-character limit was reduced to 1 (mainly for the ex command)

Prerequisites

This module depends on:

ripgrep (rg)

Install

MacOS

brew install ripgrep

Arch Linux

sudo pacman --needed --noconfirm -S ripgrep

openSUSE

sudo zypper install ripgrep

Features

Ivy and its ilk are large plugins. Covering everything about them is outside of this documentation's scope, so only Doom-specific Ivy features are listed here:

Jump-to navigation

Inspired by Sublime Text's jump-to-anywhere, CtrlP/Unite in Vim, and Textmate's Command-T, this module provides similar functionality by bringing projectile and ivy together.

https://assets.doomemacs.org/completion/ivy/projectile.png

Keybind	Description
`SPC p f`, `SPC SPC`	Jump to file in project
`SPC f f`, `SPC .`	Jump to file from current directory
`SPC s i`	Jump to symbol in file

Project search & replace

This module provides interactive text search and replace using ripgrep.

Keybind	Description
`SPC s p`	Search project
`SPC s P`	Search another project
`SPC s d`	Search this directory
`SPC s D`	Search another directory

https://assets.doomemacs.org/completion/ivy/search.png

Prefixing these keys with the universal argument (SPC u for evil users; C-u otherwise) changes the behavior of these commands, instructing the underlying search engine to include ignored files.

This module also provides Ex Commands for evil users:

Ex command	Description
`:pg[rep][!] [QUERY]`	Search project (if `!`, include hidden files)
`:pg[rep]d[!] [QUERY]`	Search from current directory (if `!`, don't search recursively)

The optional `!` is equivalent to the universal argument for the previous commands.

These keybindings are available while a search is active:

Keybind	Description
`C-c C-o`	Open a buffer with your search results
`C-c C-e`	Open a writable buffer of your search results
`C-SPC`	Preview the current candidate
`C-RET`	Open the selected candidate in other-window

Changes to the resulting wgrep buffer (opened by C-c C-e) can be committed with C-c C-c and aborted with C-c C-k (alternatively ZZ and ZQ, for evil users).

https://assets.doomemacs.org/completion/ivy/search-replace.png

In-buffer searching

The swiper package provides an interactive buffer search powered by ivy. It can be invoked with:

SPC s s (swiper-isearch)
SPC s S (swiper-isearch-thing-at-point)
SPC s b (swiper)
:sw[iper] [QUERY]

A wgrep buffer can be opened from swiper with C-c C-e.

Ivy integration for various completing commands

General

Keybind	Description
`M-x`, `SPC :`	Smarter, smex-powered M-x
`SPC '`	Resume last ivy session

Jump to files, buffers or projects)

Keybind	Description
`SPC RET`	Find bookmark
`SPC f f`, `SPC .`	Browse from current directory
`SPC p f`, `SPC SPC`	Find file in project
`SPC f r`	Find recently opened file
`SPC p p`	Open another project
`SPC b b`, `SPC ,`	Switch to buffer in current workspace
`SPC b B`, `SPC <`	Switch to buffer

Search

Keybind	Description
`SPC p t`	List all TODO/FIXMEs in project
`SPC s b`	Search the current buffer
`SPC s d`	Search this directory
`SPC s D`	Search another directory
`SPC s i`	Search for symbol in current buffer
`SPC s p`	Search project
`SPC s P`	Search another project
`SPC s s`	Search the current buffer (incrementally)