kodkod

A code editor (VSCode/Zed-like) built on egui-cr: a rope buffer for huge files, syntax highlighting via the highlight.cr shard (a 1:1 port of the highlight.js 11 engine, 38 common languages), a lazy-loading file tree, an image viewer tab (PNG/SVG), and a basic VIM modal layer.

Build & run

shards install          # once (egui-cr comes in as a path dependency)
rake build:dev          # → bin/kodkod (fast iteration)
./bin/kodkod            # or: ./bin/kodkod file.cr --dir .
rake spec               # headless spec suite, no GPU needed

A dev build runs 10-100× slower than release (no --release). For everyday use:

rake build:release      # shipped binary
OPT=-O3 rake build:dev  # middle ground: optimized, no full release

The native egui-cr static library is built automatically on first build (or set EGUI_DIR if egui.cr lives elsewhere).

Packaging (crosspack)

Releases are built and packed by the crosspack gem (see Gemfile and crosspack.yml; the matrix covers Linux, Windows and macOS — native builds on each host):

bundle install                      # once
bundle exec crosspack deps ubuntu-25.10   # verify host build deps
bundle exec crosspack build ubuntu-25.10  # rake icons + release build
bundle exec crosspack pack ubuntu-25.10   # → crosspacks/ubuntu/25.10/amd64/kodkod_0.1.0_amd64.deb
sudo apt install ./crosspacks/ubuntu/25.10/amd64/kodkod_0.1.0_amd64.deb

The deb installs /usr/local/bin/kodkod, a .desktop entry and the icon (build/appicon.png, regenerated from assets/kodkod.svg by rake icons).

CI (.github/workflows/build.yml) runs the same pipeline on all three desktops: pushing a v* tag publishes a GitHub release with the Ubuntu deb, the Windows MSI (WiX), the macOS DMG and portable archives; other builds upload the same files as workflow artifacts.

Keyboard

VIM mode

Modes: normal / insert / visual / command. Supported: motions (h j k l 0 ^ $ w b e gg G {n}G), operators (x r dd D yy cc C), change/delete (cw dw … counts included), put (p P), visual — charwise v (inclusive) and linewise V, motions extend the selection, d y c operate, o swaps the ends — undo/redo (u Ctrl+R), registers ("ayl etc.), : command line (:w :q :wq :q! :{n}), one unnamed + lettered registers.

Architecture

src/
  kodkod.cr          entry point
  app.cr             shell: tabs, explorer, menus, search, status bar
  code_editor.cr     the editor widget (gutter, scrollbars, virtual rows)
  editor_buffer.cr   buffer + caret/selection state, re-highlights on edit
  vim_mode.cr        modal input layer over the widget's caret cells
  file_tree.cr       lazy-loading directory tree
  quick_open.cr      Sublime-style Ctrl+P fuzzy file finder
                      (fuzzy.cr is the scorer)
  event_bus.cr       tiny pub/sub: fs events → index queue → UI
  gitignore.cr       .gitignore parser/matcher for the index walk
  symbol_extractor.cr regex-level definitions (def/class/macro…)
  symbol_index.cr    in-memory name → definitions database
  index_queue.cr     per-folder indexing jobs, gitignore-aware walk
  def_popup.cr       the ambiguous go-to-definition chooser popup
  symbol_browser.cr  the Indexing page's filterable definitions table
                      (virtualized; query matches name OR file)
  file_viewer.cr     the image tab: PNG (stb_image) / SVG (NanoSVG),
                     wheel zoom, drag pan, double-click refits
  rope.cr            the text buffer (piece-free rope; huge files)
  syntax/
    syntax.cr        facade: flat (scope, text) tokens over highlight.cr
    palette.cr       scope → color
    grammars/        crystal (highlight.js has none); the other 38
                     languages come from the shard
spec/                260 examples, headless (no GPU)

Syntax highlighting is delegated to the highlight.cr shard (a path dependency, ../myshards/highlight.cr): 38 common languages out of the box, plus kodkod's own Crystal grammar registered into the shard's HLJS instance at require time. Highlighting re-runs per edit and is disabled beyond 512 KB (HIGHLIGHT_MAX_CHARS in editor_buffer.cr).