Skip to content

Document Emacs setup, fix stale docs, activate prettier #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DROOdotFOO merged 2 commits into from
Aug 8, 2026
Merged

Document Emacs setup, fix stale docs, activate prettier #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69dcb90
Document Emacs setup and fix stale doc references
DROOdotFOO Aug 8, 2026
0663b0c
Activate the prettier hook and reformat
DROOdotFOO Aug 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,6 @@ repos:
rev: v3.1.0
hooks:
- id: prettier
types: [json, yaml, markdown]
# types_or, not types: pre-commit ANDs `types`, so a single file could
# never be json AND yaml AND markdown, and the hook matched nothing.
types_or: [json, yaml, markdown]
88 changes: 55 additions & 33 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ chezmoi apply # Apply local source changes to home directory
chezmoi apply --force # Skip prompts for modified target files

make lint # shellcheck on scripts/ and utils/
make doctor # Health check (32 checks across tools, config, security)
make doctor # Health check across tools, config, security
make perf # 5-run shell startup benchmark
make perf-report # Bare vs configured startup breakdown
make test # Test suite (zsh syntax, module loading)
Expand All @@ -31,6 +31,11 @@ make setup-secrets # Install 1Password, AWS CLI, Infisical, Tailscale
make rotate-keys # SSH key rotation via 1Password + Tailscale sync
make theme-generate # Generate all tool configs from unified theme
make lazy-load-stats # Show lazy loading stats

make setup-emacs # Emacs config, packages, grammars, daemon restart
make emacs-status # Emacs version, daemon, packages, grammars
make emacs-grammars # Compile missing tree-sitter grammars
make emacs-restart # Restart the Emacs daemon
```

## Chezmoi Architecture
Expand Down Expand Up @@ -105,6 +110,8 @@ Setup scripts follow the pattern: `scripts/setup/setup-<tool>.sh` with subcomman

Commits run: trailing-whitespace, end-of-file-fixer, check-yaml, check-added-large-files (500KB), check-merge-conflict, shellcheck (error level, `-x` to follow sources, excludes `home/dot_zsh/*.zsh`), black (Python), prettier (JSON/YAML/Markdown). Encrypted files (`encrypted_*`) are excluded from whitespace hooks.

Note the prettier hook uses `types_or`, not `types` -- pre-commit ANDs `types`, so the original `types: [json, yaml, markdown]` matched nothing and the hook silently never ran. Chezmoi templates are unaffected either way: a `.json.tmpl` is not detected as JSON.

## Theming

Single source of truth: `[data.theme]` in `chezmoi.toml` (Synthwave84 palette). Templates reference colors as `{{ .theme.bg }}`, `{{ .theme.accent }}`, etc. Applied to: fzf (`tools.zsh.tmpl`), Starship (`starship.toml.tmpl`), Hammerspoon alerts. Static theme files in `config/theme/synthwave84.toml` for tools that can't use chezmoi templates.
Expand All @@ -113,6 +120,21 @@ Single source of truth: `[data.theme]` in `chezmoi.toml` (Synthwave84 palette).

Authoritative source for both is the shipped Zed theme JSON (`~/Library/Application Support/Zed/extensions/installed/synthwave84/themes/synthwave84.json`), not `config/theme/synthwave84.toml`, which had drifted on `keyword` and `type`.

## Emacs

Vanilla Emacs 30 (`emacs-plus@30`) at `~/.config/emacs`, source `home/private_dot_config/emacs/`. Runs as a daemon under `brew services`; `e` and `eg` (in `aliases/dev.zsh`) open terminal and GUI frames. `EDITOR` stays `nvim`.

Layout: `early-init.el.tmpl` (pre-frame), `init.el`, `lisp/droo-{defaults,ui,completion,git,lang,lsp}.el`, `themes/synthwave84-soft-theme.el.tmpl`, `banner.txt`. Only the two `.tmpl` files interpolate -- colors live solely in the theme.

Four things that are easy to get wrong:

- **`~/.emacs.d` silently wins.** `startup--xdg-or-homedot` (`startup.el`) returns `~/.emacs.d` whenever that directory merely _exists_ -- it never checks for an `init.el`. If it reappears, the entire XDG config is ignored with no error. `make doctor` fails on this, and `setup-emacs.sh` offers to trash it.
- **Runtime state must stay out of the config tree.** `~/.config/emacs` is chezmoi-managed, so anything Emacs writes there becomes `chezmoi verify` drift. `early-init.el` redirects `package-user-dir`, the eln cache, `custom-file`, and grammars to XDG data/cache/state. This is why no `home/.chezmoiignore` was needed -- adding one would newly activate as chezmoi's real ignore file.
- **The daemon does not inherit mise.** mise activates from `.zshrc`, which `exec-path-from-shell -l` never sources, so mise-managed servers (`ruff`, `rust-analyzer`) are invisible. `droo-defaults.el` adds `~/.local/share/mise/shims` to `exec-path` explicitly.
- **Language modes and eglot are gated.** `droo-lang.el` only remaps a major mode when its tree-sitter grammar is present, and `droo-lsp.el` only hooks `eglot-ensure` when the server binary is on `PATH` -- missing pieces degrade quietly instead of erroring. Both decide at load time, so **restart the daemon after `make emacs-grammars`** or installing a server.

Adding a language: add the grammar to `treesit-language-source-alist` and the mode to `auto-mode-alist` (or `major-mode-remap-alist`) in `droo-lang.el`, add the server to `droo/eglot-servers` in `droo-lsp.el`, then `make emacs-grammars && make emacs-restart`.

## Adding Features

**New alias**: Add to `home/dot_zsh/aliases/dev.zsh`
Expand Down Expand Up @@ -148,22 +170,22 @@ Local skills (`ethskills/`, `solidity-auditor/`, `noir/`) provide offline Ethere

Managed via `~/.mcp.json` (chezmoi template: `home/dot_mcp.json.tmpl`). Toggle in `chezmoi.toml`, then `chezmoi apply`.

| Server | Flag | Transport | Notes |
| ------------ | ---------------- | ---------- | --------------------------------- |
| context7 | always on | stdio | Library docs via npx |
| blockscout | always on | http | Blockchain data queries |
| coingecko | `coingecko` | http | Crypto market data |
| digest | `digest` | stdio | Multi-platform activity digest |
| recall | `recall` | stdio | Knowledge capture/retrieval (FTS5) |
| autoresearch | `autoresearch` | stdio | Autonomous experiment runner |
| watchdog | `watchdog` | stdio | Repo health monitor |
| prepper | `prepper` | stdio | Pre-session context builder |
| sentinel | `sentinel` | stdio | On-chain contract monitor |
| patchbot | `patchbot` | stdio | Polyglot dependency updater |
| signoz | `signoz` | stdio | Primary observability. API key from 1Password at runtime |
| regen | `regen` | stdio | Fluidify Regen incidents; wrapper injects `regen_url` (+ optional cookie). Correlates with signoz |
| datadog | `datadog` | http/OAuth | Disabled fallback (`datadog = false`). us5.datadoghq.com, no secrets |
| sentry | `sentry` | http/OAuth | mcp.sentry.dev, no secrets |
| Server | Flag | Transport | Notes |
| ------------ | -------------- | ---------- | ------------------------------------------------------------------------------------------------- |
| context7 | always on | stdio | Library docs via npx |
| blockscout | always on | http | Blockchain data queries |
| coingecko | `coingecko` | http | Crypto market data |
| digest | `digest` | stdio | Multi-platform activity digest |
| recall | `recall` | stdio | Knowledge capture/retrieval (FTS5) |
| autoresearch | `autoresearch` | stdio | Autonomous experiment runner |
| watchdog | `watchdog` | stdio | Repo health monitor |
| prepper | `prepper` | stdio | Pre-session context builder |
| sentinel | `sentinel` | stdio | On-chain contract monitor |
| patchbot | `patchbot` | stdio | Polyglot dependency updater |
| signoz | `signoz` | stdio | Primary observability. API key from 1Password at runtime |
| regen | `regen` | stdio | Fluidify Regen incidents; wrapper injects `regen_url` (+ optional cookie). Correlates with signoz |
| datadog | `datadog` | http/OAuth | Disabled fallback (`datadog = false`). us5.datadoghq.com, no secrets |
| sentry | `sentry` | http/OAuth | mcp.sentry.dev, no secrets |

Agent MCP servers (coingecko through patchbot) all share the same `<binary> serve` invocation pattern — they're CLIs from [agent-skills](https://github.com/DROOdotFOO/agent-skills) that double as MCP stdio servers.

Expand Down Expand Up @@ -194,26 +216,26 @@ Skills are portable `SKILL.md` files sourced from [DROOdotFOO/agent-skills](http

**Code pattern skills** -- language-specific examples and idioms:

| Skill | Triggers on |
| ----------- | -------------------------------------------------------------------------- |
| claude-api | `anthropic` imports, SDK usage |
| droo-stack | Elixir, TS, Go, Rust, C, Zig, Python, Lua, Shell, Noir, Chezmoi |
| raxol | Raxol TUI/agent imports, headless/MCP tools |
| raxol-payments | :raxol_payments/:raxol_earn, Xochi/Riddler, agent wallets, ACP jobs |
| raxol-symphony | :raxol_symphony, tracker-driven coding-agent orchestration |
| design-ux | Component design, layout, tokens, accessibility, TUI aesthetics, DESIGN.md |
| nix | `.nix` files, flakes, NixOS, Home Manager, agent-skills packaging, rigup |
| native-code | NIFs (C/Rust), SIMD (Zig), erl_nif.h, Rustler, BEAM native boundary |
| Skill | Triggers on |
| -------------- | -------------------------------------------------------------------------- |
| claude-api | `anthropic` imports, SDK usage |
| droo-stack | Elixir, TS, Go, Rust, C, Zig, Python, Lua, Shell, Noir, Chezmoi |
| raxol | Raxol TUI/agent imports, headless/MCP tools |
| raxol-payments | :raxol_payments/:raxol_earn, Xochi/Riddler, agent wallets, ACP jobs |
| raxol-symphony | :raxol_symphony, tracker-driven coding-agent orchestration |
| design-ux | Component design, layout, tokens, accessibility, TUI aesthetics, DESIGN.md |
| nix | `.nix` files, flakes, NixOS, Home Manager, agent-skills packaging, rigup |
| native-code | NIFs (C/Rust), SIMD (Zig), erl_nif.h, Rustler, BEAM native boundary |

**Web3 skills** -- blockchain development, auditing, and data:

| Skill | Triggers on |
| -------------- | -------------------------------------------------------------------------- |
| ethskills | Ethereum tooling, EIP/ERC standards, framework selection |
| Skill | Triggers on |
| ---------------- | -------------------------------------------------------------------------- |
| ethskills | Ethereum tooling, EIP/ERC standards, framework selection |
| solidity-auditor | `.sol` files, foundry.toml, auditing, security review |
| noir | `.nr` files, Nargo.toml, ZK circuits, Aztec contracts/security/e2e testing |
| blockscout | On-chain data queries, contract state, token balances, ENS, NFT holdings |
| coingecko | Token prices, market caps, DEX pools, trending tokens, price history |
| noir | `.nr` files, Nargo.toml, ZK circuits, Aztec contracts/security/e2e testing |
| blockscout | On-chain data queries, contract state, token balances, ENS, NFT holdings |
| coingecko | Token prices, market caps, DEX pools, trending tokens, price history |

**MCP-companion skills** -- reference docs for MCP agent tools:

Expand Down
47 changes: 31 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,21 @@ brew install chezmoi && chezmoi init --apply https://github.com/DROOdotFOO/dotfi

## What's In Here

| Category | Tools |
| ------------- | ------------------------------------------------------------ |
| **Terminal** | Ghostty, tmux |
| **Editors** | Zed, Neovim (27 plugins, mona.nvim) |
| **Shell** | Zsh + Starship + fzf + zoxide |
| **CLI** | eza, bat, fd, ripgrep, delta, jq, yq |
| **Files** | yazi with image/PDF/archive preview |
| **System** | btop, fastfetch, tldr (`help`) |
| **Windows** | Hammerspoon + PaperWM (macOS) |
| **Launcher** | Raycast (macOS) |
| **AI** | Claude Code (54 skills, 8 agents, 31 MCP tools) |
| **Secrets** | 1Password (SSH agent + age encryption), AWS CLI, Infisical |
| **Network** | Tailscale with pre-configured hosts |
| **Languages** | Elixir, Rust, Go, Python, Node.js, Lua (via mise) |
| **Fonts** | Monaspace + Nerd Font |
| Category | Tools |
| ------------- | --------------------------------------------------------------- |
| **Terminal** | Ghostty, tmux |
| **Editors** | Zed, Neovim (27 plugins, mona.nvim), Emacs 30 (eglot + treesit) |
| **Shell** | Zsh + Starship + fzf + zoxide |
| **CLI** | eza, bat, fd, ripgrep, delta, jq, yq |
| **Files** | yazi with image/PDF/archive preview |
| **System** | btop, fastfetch, tldr (`help`) |
| **Windows** | Hammerspoon + PaperWM (macOS) |
| **Launcher** | Raycast (macOS) |
| **AI** | Claude Code (54 skills, 8 agents, 31 MCP tools) |
| **Secrets** | 1Password (SSH agent + age encryption), AWS CLI, Infisical |
| **Network** | Tailscale with pre-configured hosts |
| **Languages** | Elixir, Rust, Go, Python, Node.js, Lua (via mise) |
| **Fonts** | Monaspace + Nerd Font |

## Terminal Tools

Expand Down Expand Up @@ -101,6 +101,20 @@ PaperWM tiling -- enable with `paperwm = true` in chezmoi.toml, then `make setup
| `s` | Flash jump |
| `gd` | Go to definition |

### Emacs

Runs as a daemon under `brew services`. `e` opens a terminal frame, `eg` a GUI frame.

| Key | Action |
| --------- | ---------------------------- |
| `C-s` | Search buffer (consult-line) |
| `C-x b` | Switch buffer |
| `C-x g` | Magit status |
| `C-x p f` | Find file in project |
| `C-.` | Context actions (embark) |
| `C-c l r` | LSP rename (eglot) |
| `M-n` | Next diagnostic |

## Commands

```bash
Expand All @@ -112,7 +126,7 @@ chezmoi apply # Apply local changes
# Tools
make brew-install # Install Brewfile packages
make lint # Shellcheck everything
make doctor # 32-point health check
make doctor # Health check (tools, config, security)
make setup-secrets # 1Password, AWS, Infisical, Tailscale
make setup-paperwm # PaperWM.spoon for Hammerspoon
make dashboard # Service status overview
Expand Down Expand Up @@ -173,6 +187,7 @@ dotfiles/
│ │ ├── ghostty/ # Terminal
│ │ ├── zed/ # Editor
│ │ ├── nvim/ # Neovim (27 plugins)
│ │ ├── emacs/ # Emacs 30 (XDG; theme is templated)
│ │ ├── btop/ # System monitor
│ │ ├── yazi/ # File manager
│ │ ├── fastfetch/ # System info
Expand Down
6 changes: 4 additions & 2 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
## Index

- **[Main README](../README.md)** - Quick start and overview
- **[Advanced Usage](advanced-usage.md)** - Configuration and customization
- **[Project Templates](templates.md)** - Template reference
- **[Performance](performance.md)** - Shell startup profiling
- **[Neovim Plugins](nvim-plugins.md)** - Plugin reference
- **[NixOS Installation](nixos-installation.md)** - NixOS setup

## Quick Reference

Expand All @@ -19,7 +21,7 @@ make generate-template web3 my-project --with-direnv
make doctor

# Performance monitoring
make performance-monitor ACTION=measure
make perf
```

## Environment Shortcuts
Expand Down
Loading