README.adoc

conf-emacs

This is my GNU Emacs configuration.

Table of Contents

• Installation
• External dependencies
• Customization
• Cheat sheet
• Custom functions
• TODO
• License

Installation

Note	Only tested on Emacs version 25+.

The configuration is maintained using straight.el for package management and use-package for package initialization and configuration.

Everything is self-contained in init.el and other elisp files. The package manager is bootstraped if needed. Simply clone and launch emacs:

mv -v ~/.emacs.d{,.old}
git clone https://github.com/kode9/conf-emacs.git ~/.emacs.d
emacs --debug-init &

Caution

The first start might take some time as dependencies are cloned and built.

External dependencies

The configuration provides integration of external tools:

• Git with Magit

• AG the silver searcher with ag.el

• A spell checker such as Aspell or Hunspell for the built-in spell checker and Flycheck

Customization

Type M-x customize-group RET abz RET to see available custom variables.

Cheat sheet

TL;DR M-x describe-personal-keybindings RET

Table 1. Exploration

Keybinding	Function
C·h P	describe-package
C·h f	helpful-callable
C·h i	info
C·h k	helpful-key
C·h m	describe-mode
C·h p	helpful-at-point
C·h t	help-with-tutorial
C·h v	helpful-variable
C·h w	where-is

Table 2. Project management C·c p

Keybinding	Description	Function
C·c p p	Switch to a known project	projectile-switch-project
C·c p q	Switch to a project currently opened	projectile-switch-open-project
C·c p v	Show VCS status (magit) of a project	projectile-vc
C·c p f	Jump to a project’s file	projectile-find-file
C·c p o f	Jump to a project’s file in other window	projectile-find-file-other-window
C·c p e	Jump to a project’s recent file	projectile-recentf
C·c p l	Jump to a file in a directory	projectile-find-file-in-directory
C·c p d	Jump to a project’s directory	projectile-find-dir
C·c p b	Switch to a project buffer	projectile-switch-to-buffer
C·c p o b	Switch to a project buffer in other window	projectile-switch-to-buffer-other-window
C·c p o s	Show a project buffer in other window	projectile-display-buffer
C·c p o k	Kills all project buffers	projectile-kill-buffers
C·c p a	Switch between files with same name	projectile-find-other-file
C·c p o a	Switch between files with same name other window	projectile-find-other-file-other-window
C·c p &	Runs async-shell-command in the root directory	projectile-run-async-shell-command-in-root
C·c p C	Run project configure command	projectile-configure-project
C·c p c	Run project compilation command	projectile-compile-project
C·c p u	Run project run command	projectile-run-project

Table 3. Text manipulation

Keybinding	Description	Function
C·c p r	Runs interactive query-replace on all files in the projects	projectile-replace
C·=	Increase selected region by semantic units	er/expand-region
M·=	Contract the selected region to its previous size	er/contract-region

Custom functions

Function	Description
abz-clean-mode	Global mode that format & clean buffer before save
abz-find-custom-file	Open the custom file
abz-indent-dwim	Indent region or buffer
abz-sudo-buffer	Reopen the current file as root

TODO

• Hydra

• Window management

• Swap windows

• Check existing searcher (ripgrep, ag, grep)

• chmod

• keymaps

• use functions in abz/abz.el

• compress backup-each-save ⇒ fork ⇒ gz/zst w/ auto-compression mode, see undo-tree source

• elpy → gitignore → no littering

• github.com/jwiegley/use-package#use-package-ensure-system-package

• github.com/regen100/cmake-language-server

License

link:NOTICE[role=include]