raxol CLAUDE.md

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Essential Commands

Initial setup

mix deps.get

The termbox2 NIF source (in packages/raxol_terminal/lib/termbox2_nif/c_src/) is vendored directly in the repo, no git submodules needed.

Building & Compilation

MIX_ENV=test mix compile
MIX_ENV=test mix compile --warnings-as-errors

Testing

MIX_ENV=test mix test --exclude slow --exclude integration --exclude docker
MIX_ENV=test mix test test/path/to/test_file.exs      # specific file
MIX_ENV=test mix test test/path/to/test_file.exs:42   # specific line
MIX_ENV=test mix test --max-failures 5                 # limit failures
MIX_ENV=test mix test --failed                         # rerun failed

Note: TMPDIR=/tmp and SKIP_TERMBOX2_TESTS=true are set automatically via .claude/settings.json. MIX_ENV=test must be specified explicitly for compile and test commands.

Code Quality

mix raxol.check               # All checks: format, compile, credo, dialyzer, security, docs, rate, test
mix raxol.check --quick       # Skip dialyzer
mix raxol.check --only format,credo  # Run specific checks only
mix raxol.check --skip test   # Skip specific checks
mix format                    # Format code
mix format --check-formatted  # Check formatting (CI)
mix credo                     # Style checks
mix dialyzer                  # Type checking

Packages format at their own line length (98), not the root's 80. The root .formatter.exs delegates every packages/* path to that package's own config (:subdirectories), so mix format from the repo root is correct for any file in the repo and matches what CI checks.

CI gates the same thing in two places, both in the format job: the root mix format --check-formatted, then a loop running each package's own gate. Every package is covered, so cd packages/<pkg> && mix format is a no-op on a clean tree. If it rewrites files, that is a real diff and not drift.