My Emacs Configuration

New to Emacs?

If you're new to Emacs, check out these resources to get started:

• Essential Emacs Hotkeys
• Emacs Lisp Introduction
• Building a Modular Emacs Configuration

Contributing

I welcome feature requests and bug reports. Feel free to open an issue on GitHub or contact me directly.

Overview

A modular Emacs configuration with comprehensive language support, development tools, and UI enhancements. Designed for easy extension and maintenance, with particular focus on developer experience.

Features

General

• Easy installation of the configuration (packages are automatically installed via use-package)
• Performance optimizations for faster startup and responsiveness
• Frame and window management utilities (resize, zoom, tiling, etc.)
• Multiple cursor editing
• Snippets (yasnippet; user-defined ones can be put into ~/.emacs.d/snippets)
• Smart completion via company-mode and LSP
• Documentation lookup integration
• Many quality-of-life improvements for editing
• Embark integration for contextual actions

Development Tools

• Version control using Magit
• Language Server Protocol (LSP) support
• Syntax checking via Flycheck
• Code formatting and refactoring tools
• Comprehensive support for project management via Projectile
• Terminal integration via VTerm
• Puppet Bolt integration for infrastructure management

Language Support

Language support is primarily based on LSP and/or specialized modes:

• C/C++: LSP (clangd) + company + flycheck + CMake integration
• Python: lsp-pyright + company + flycheck
• Go: LSP (gopls) + comprehensive Go tooling
• Rust: rust-analyzer + cargo integration
• LaTeX: AUCTeX with compile-on-save functionality
• Web: HTML, CSS, JavaScript support
• PlantUML: Integrated preview and automatic generation of diagrams
• Org-mode: Enhanced with org-modern, org-journal, and custom babel support
• Ansible/Salt: YAML mode with specialized snippets and formatting
• Misc: Support for YAML, JSON, Docker, and many others

Additional Features

• Confluence export from Org mode documents
• EXWM (Emacs X Window Manager) integration (optional)
• Google Styleguide integration

Setup

Clone the repository to anywhere and install the submodules:

git clone --recursive https://github.com/0x17de/emacs-config/ /path/to/_0x17de-emacs-config/

Here's how your .emacs file could be structured. The most critical element is the load command. If you're unsure about the location of your .emacs file, simply execute M-: user-init-file RET (press Alt and colon together, type user-init-file, then hit Enter) in Emacs, and the minibuffer will display the path to your initialization file.

(package-initialize)

;; optional org mode encryption settings
(require 'org-crypt)
(org-crypt-use-before-save-magic)
(setq org-tags-exclude-from-inheritance (quote ("crypt")))
(setq org-crypt-key "123...GPGID...DEF")

;; optional for rust configuration (if you need Rust)
(setenv "PATH" (concat (getenv "PATH") ":" (getenv "HOME") "/.cargo/bin"))
(add-to-list 'exec-path (concat (getenv "HOME") "/.cargo/bin"))

;; INFO: Your custom config can be either here or inside /path/to/_0x17de-emacs-config/custom.el


;; IMPORTANT: This will actually enable this configuration
(load "/path/to/_0x17de-emacs/_0x17de-emacs")

;; optional for hugo blogging
;; (setq easy-hugo-basedir "~/hugo/0x17blog")

First-Time Setup

LSP and language features will need additional setup:

For Go development

Run once to install Go language tools:

M-x ox-install-go-dependencies

For Java development

Install the Java language server:

M-x lsp-install-server RET jdtls RET

For PlantUML

Set the path to your PlantUML jar file via M-x customize-group RET _0x17de RET, then make _0x17de/plantuml-jar-file point to the jar file location.

For EXWM (optional/experimental)

The EXWM configuration is rather experimental and not really supported. It is recommended to use emacs-lucid instead of emacs-gtk when trying this out. EXWM can be enabled through customize: M-x customize-group RET _0x17de RET.

Directory Structure

The configuration is organized into several directories:

• init/: Core initialization files
  • custom.el: User customization file
  • exwm.el: EXWM configuration
  • package.el: Package management
  • speedup.el: Performance optimizations
• langs/: Language-specific configurations
• utils/: Utility functions and tools
• snippets/: YASnippet templates
• ext/: External packages and resources

Customization

You can put your own customizations in either your .emacs file or in ~/.emacs.d/_0x17de/custom.el, which will be automatically loaded if it exists.

Hotkeys

Hotkey	Description
C-M-z |	Multiple cursors: select all instances of the selected region
C-M-z C-c	Multiple cursors: place cursor in every line of selected region
C-M-z C-M-c	Multiple cursors: place cursor on non-empty lines of selected region
C-M-z >	Multiple cursors: add a cursor at the next matching region
C-M-z <	Multiple cursors: add a cursor at the previous matching region
M-<mouse1>	Multiple cursors: add/remove a cursor at the pointer location
C-M-S-y	Show snippets for current mode
C-M-S-q	Close current buffer without asking
C-M-S-w	Close current buffer and window without asking
C-M-x	The original M-x since smex is used for command selection
C-M-|	Pipe region through shell command and replace with result
S-<tab>	Insert a real tab character instead of spaces
<f1>	Show documentation for item at point (context-dependent)
<f5>	Generic compile command (project-specific actions in some modes)
<tab>	Auto-indentation and completion (intelligent context handling)
C-x o	Smart navigation between windows/frames
M-<arrows>	Move between frames
C-M-<up/down>	Resize frames
C-:	Avy-goto-char
C-M-:	Avy-goto-char-timer

Language-Specific Features

C/C++ Projects

Place a .dir-locals.el in the project root for project-specific configuration. For CMake projects, the system will try to use $PROJECT_ROOT/build for builds.

Python Projects

Requires pyright to be installed (recommended via pipx install pyright).

Go Projects

Automatically formats code with gofmt/goimports on save.

LaTeX Projects

Use the minor mode latex-compile-on-save-mode to automatically compile on saving.

PlantUML Projects

Automatically generates and previews diagrams on save for .puml files.

Puppet Bolt

Use M-x _0x17de/bolt to open the Bolt interface for managing infrastructure.

Customization Options

The configuration uses a custom group called _0x17de with many customizable variables. You can use M-x customize-group RET _0x17de RET to see all options. Here are the main customizable features:

General Options

• _0x17de/backup-file-location: Directory for backup files (default: "~/.emacs.d/backups")
• _0x17de/focus-follows-mouse: Enable focus follows mouse (default: t)
• _0x17de/scroll-amount: Number of lines to scroll at a time (default: 5)
• _0x17de/modeline: Modeline style to use (default: doom-modeline)
• _0x17de/minibuffer-completion-framework: Completion framework (default: vertico)
• _0x17de/M-x-library: Command completion interface (default: amx)

Language-Specific Options

• _0x17de/plantuml:enable: Enable PlantUML mode (default: t)
• _0x17de/plantuml-jar-file: Path to PlantUML jar file
• _0x17de/lisp-paredit:enabled: Enable paredit for Lisp modes (default: nil)
• _0x17de/python-global-virtualenv-dir: Default directory for Python virtualenvs
• _0x17de/google-c-style-overrides: Customize C/C++ formatting

Environment Options

• _0x17de/exec-path-from-shell:enable: Import environment from shell (default: nil)
• _0x17de/bolt-command-path: Path to Puppet Bolt binary
• _0x17de/bolt-repo-path: Path to Bolt repository
• _0x17de/use-exwm: Enable EXWM window manager (default: nil)

You can customize these options either through the customize interface or by setting them in your init/custom.el file.

Troubleshooting

If you encounter issues with the configuration:

1. Start Emacs with emacs --debug-init to see initialization errors
2. Check the *Messages* buffer for warnings
3. Review package-specific logs (e.g., *lsp-log* for LSP issues)