diff options
| -rw-r--r-- | README.md | 120 | ||||
| -rw-r--r-- | init.el | 20 |
2 files changed, 137 insertions, 3 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..78e6224 --- /dev/null +++ b/README.md @@ -0,0 +1,120 @@ +# Emacs Configuration + +Personal Emacs configuration focused on simplicity and modern tooling while respecting default Emacs keybindings. + +## Philosophy + +- Clean and minimal configuration +- Prefer built-in Emacs functionality when possible +- Use modern, actively maintained packages +- Respect default Emacs keybindings +- Single `init.el` file for simplicity + +## Structure + +``` +~/.emacs.d/ +├── init.el # Main configuration file +├── elisp/ # Custom configuration modules +│ ├── c-init.el # C/C++ configuration +│ └── ansible-init.el # Ansible/YAML configuration +└── README.md # This file +``` + +## Key Packages + +### Completion Framework +- **vertico** - Vertical completion UI +- **orderless** - Flexible completion style (space-separated patterns) +- **consult** - Enhanced commands (buffer switching, search, etc.) +- **marginalia** - Helpful annotations in completion candidates + +### Development +- **company** - Auto-completion +- **flycheck** - Syntax checking +- **treesit-auto** - Tree-sitter modes with automatic grammar installation +- **magit** - Git interface +- **forge** - GitHub/GitLab integration for magit +- **magit-todos** - Show TODO/FIXME comments in magit status + +### Editing +- **paredit** - Structured editing for Lisp +- **expand-region** - Smart region expansion +- **move-text** - Move lines/regions up and down +- **visual-regexp** - Visual feedback for regexp replace +- **yasnippet** - Snippet expansion +- **emmet-mode** - HTML/CSS abbreviation expansion +- **rainbow-delimiters** - Colorize nested delimiters + +### Modes +- **markdown-mode** - Markdown editing +- **terraform-mode** - Terraform configuration files +- **yaml-mode** - YAML files +- **json-mode** - JSON files +- **hgignore-mode** - Mercurial ignore files + +### Utilities +- **ibuffer-project** - Group buffers by project +- **exec-path-from-shell** - Import shell environment variables +- **rg** - ripgrep integration + +## Key Bindings + +### Custom Bindings +- `C-c c` - Compile +- `C-c r` - Recompile +- `C-c a` - Align regexp +- `C-c g` - Consult ripgrep (search with preview) +- `C-c s` - Launch eshell +- `C-x g` - Magit status +- `C-x C-b` - ibuffer (better buffer list) +- `C-=` - Expand region +- `M-p` / `M-n` - Move text up/down +- `M-%` - Visual regexp replace +- `C-M-%` - Visual regexp query replace + +### Enhanced Default Bindings +- `M-x` - Command execution (enhanced with vertico) +- `C-x b` - Switch buffer (enhanced with consult) +- `M-y` - Yank from kill ring (enhanced with consult) +- `M-/` - Company completion + +## Installation + +1. Clone this repository: + ```bash + git clone [email protected]:lukehoersten/emacs.d.git ~/.emacs.d + ``` + +2. Launch Emacs - packages will auto-install on first run + +3. For tree-sitter modes, grammars install automatically when first opening a file + +## Tree-sitter Support + +Tree-sitter provides faster, more accurate syntax highlighting and parsing. Enabled automatically for: +- JavaScript/TypeScript +- JSON +- Python +- And many more (via `treesit-auto`) + +Grammars install automatically on first use. + +## Customizations + +Emacs customizations are redirected to `custom.el` (gitignored) to keep `init.el` clean. +The configuration uses `package-require` for explicit package management. + +## Updating Packages + +```elisp +M-x package-refresh-contents +M-x package-update-all +``` + +## Notes + +- Theme: Solarized Light (GUI only) +- Font: Inconsolata-12 (GUI only) +- Shell: eshell (launched automatically on startup) +- Whitespace cleanup on save enabled globally @@ -69,7 +69,7 @@ (require 'package-require) (package-require '(rg company exec-path-from-shell expand-region vertico orderless consult marginalia magit forge magit-todos markdown-mode hgignore-mode move-text paredit - rainbow-delimiters json-mode json-reformat flycheck treesit-auto ibuffer-project + rainbow-delimiters json-mode json-reformat flycheck treesit-auto ibuffer-project jinx solarized-theme terraform-mode visual-regexp yasnippet yaml-mode emmet-mode)) @@ -79,8 +79,22 @@ (require 'ansible-init) +;;; jinx spellcheck setup +(with-eval-after-load 'jinx + (unless (executable-find "enchant-2") + (display-warning + 'jinx + (concat "Enchant library not found. Jinx spell-checking requires enchant.\n\n" + "To install:\n" + (if (eq system-type 'darwin) + " macOS: brew install enchant\n" + " Ubuntu/Debian: sudo apt install libenchant-2-dev\n") + "\nAfter installation, restart Emacs.") + :warning))) + + ;;; text-mode -(add-hook 'fundamental-mode-hook 'flyspell-mode) ; spellcheck text +(add-hook 'fundamental-mode-hook 'jinx-mode) ; spellcheck text (add-hook 'fundamental-mode-hook 'turn-on-auto-fill) ; autofill text @@ -194,7 +208,7 @@ ;;; markdown-mode -(add-hook 'markdown-mode-hook 'flyspell-mode) +(add-hook 'markdown-mode-hook 'jinx-mode) (setq-default markdown-command "pandoc -f gfm") |