shiki AGENTS.md

AGENTS.md

Read this first

• CLAUDE.md is the exhaustive source of truth (layout, keybindings, config schema, git sync, release automation, per-file design rationale). Read the relevant section before any architectural change. IDEA.md is the design spec. AGENTS.md only covers what you'd otherwise guess wrong.
• This is a Rust Cargo workspace (shiki-core → shiki-config → shiki-tui → shiki-cli, strict one-way deps). Binary name is shiki (in shiki-cli/src/main.rs), launched with no args = TUI, -- <args> = CLI subcommands.

Commands

cargo check --workspace                          # fast iteration
cargo test --workspace                           # the whole suite
cargo clippy --workspace --all-targets -- -D warnings   # CI gate — the -D warnings matters
cargo fmt --all                                  # then re-clippy
cargo audit                                      # CI runs this; ignore list lives in .cargo/audit.toml
cargo run -p shiki-cli -- --help                 # CLI; no args launches the TUI

• CI (ci.yml) runs fmt --check (ubuntu only), clippy -D warnings and cargo test on all 3 OSes. Clippy is matrixed because shiki-core/src/editor.rs has #[cfg(target_os = ...)] blocks.
• Never commit a clippy failure; -- -D warnings is enforced in CI.

Testing

• There are ~293 #[test]s (134 in shiki-core, 17 shiki-config, 129 shiki-tui, 13 shiki-cli) — CLAUDE.md's "almost no tests yet" paragraph is stale. They are all inline #[cfg(test)] modules inside source files (no tests/ dirs, no #[ignore], no fixture setup). cargo test --workspace is green.
• To exercise the CLI/TUI without touching real user data, override XDG dirs (used via directories::ProjectDirs::from("", "", "shiki")):

XDG_CONFIG_HOME=/tmp/shiki-test-config XDG_DATA_HOME=/tmp/shiki-test-data cargo run -p shiki-cli -- notebook create personal

• For shiki-tui logic, prefer pure functions over constructing a full App in a test — the pattern is panel_drawer::drawer_hit_at(notebook_count, area, column, row) (takes plain numbers, not &App).