A little Emacs-flavored terminal editor written in
let-go, almost-Clojure running on a Go
bytecode VM. Here's the fun part: the language you'd script it in is the same
language it's written in. There's no plugin API bolted on the side. Every
built-in command and key binding is defined with the exact same
defcommand/bind-key! your own config uses, so hacking on legmacs and
configuring legmacs are the same activity.
It's small. About 4,000 lines of Lisp for the whole editor, bundled modes included. For that, it does a lot more than I expected it would when I started:
- Emacs chords, kill ring, region, undo/redo, multiple buffers
- window splits (
C-x 2/C-x 3, mix and nest them), each window with its own cursor and scroll - a real, extensible mode system: major and minor modes, keymaps that shadow the global one key by key
- syntax highlighting for 20+ languages out of the box, plus paren
matching, auto-closing brackets, and depth-based auto-indent for all of
them (see Language support) -- and it's a one-call
register-prog-mode!to add your own - in-process eval (
C-x C-e/C-j), because it's a Lisp editing a Lisp in the very same runtime, so*scratch*is a live REPL over the editor itself -- and since let-go is close enough to Clojure's reader syntax,.clj/.cljc/.cljs/.bb/.ednfiles open into the same mode too - a dedicated
*repl*buffer (C-c C-z), for when you want an actual running transcript instead of building one by hand withC-j - keyboard macros, a mark ring, interactive query-replace, dabbrev-expand, comment-dwim, and bracketed paste
- structural expand-region for let-go, growing the selection one s-expression at a time
- swiper-style live incremental search
- vertico/ivy-style fuzzy completion for commands, files, and buffers
- CRUTCH, a bundled vi-style modal minor mode (yes, modal editing, if you want it)
- a themeable, segment-based mode line
All of it is built on the same public API, so any feature is also a worked example for the one you want to write.
brew install nooga/tap/legmacs
legmacs [file...]That's a self-contained native binary, no runtime to install. Prebuilt tarballs for macOS and Linux (amd64/arm64) are on the releases page.
You'll need lg, the let-go runtime (brew install nooga/tap/let-go). Then:
lg main.lg [file...]Drop a legmacs-init namespace at ~/.config/legmacs/legmacs_init.lg:
(ns legmacs-init
(:require [legmacs.keymap :as km :refer [defcommand]]))
(defcommand insert-banner "Insert a banner." [state]
(legmacs.buffer/insert-string state "<<< hello >>>"))
(km/bind-key! "C-c b" :insert-banner)Same defcommand/bind-key! the editor defines its own keys with. See
examples/legmacs_init.example.lg for a
fuller one.
let-go-mode and markdown-mode are hand-written (in-process eval for the
former); .clj/.cljc/.cljs/.bb/.edn reuse let-go-mode's syntax
handling as-is, since let-go is a Clojure dialect close enough in reader
syntax. Everything else comes from one spec-driven scanner
(legmacs/modes/prog.lg): syntax highlighting,
paren matching, auto-closing brackets, and auto-indent, all from a single
data map of comment markers, string delimiters, and keyword/type/constant
word sets.
| Language | Extensions |
|---|---|
| let-go / Clojure / EDN | .lg .clj .cljc .cljs .bb .edn |
| Markdown | .md .markdown |
| Go | .go |
| JavaScript / TypeScript | .js .jsx .mjs .cjs .ts .tsx |
| Python | .py |
| C / C++ | .c .h .cpp .hpp .cc .hh .cxx |
| Rust | .rs |
| Java | .java |
| Kotlin | .kt .kts |
| Swift | .swift |
| C# | .cs |
| PHP | .php |
| Zig | .zig |
| Ruby | .rb |
| Lua | .lua |
| Shell | .sh .bash .zsh |
| SQL | .sql |
| JSON | .json |
| YAML | .yaml .yml |
| TOML | .toml |
| CSS | .css |
| HTML | .html .htm |
| Dockerfile | Dockerfile .dockerfile |
| Makefile | Makefile .mk |
Adding one more is a single call from legmacs-init.lg:
(require '[legmacs.modes.prog :as prog])
(prog/register-prog-mode! :elixir "elixir-mode"
{:line-comments ["#"]
:string-delims ["\"" "'"]
:keywords #{"def" "defmodule" "do" "end" "if" "else" "case" "fn"}
:constants #{"true" "false" "nil"}}
[".ex" ".exs"])The complete keymap, the mode system, the scripting API, and how it's all put
together live in docs/GUIDE.md. Tests run with
lg test/run.lg.
MIT licensed.
