shiki CLAUDE.md

CLAUDE.md

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

Project

shiki (私記) is a TUI note-taking app written in Rust, inspired by Yazi's three-pane layout and modal navigation. Notes are plain Markdown files with YAML frontmatter, organized into "notebooks" (directories, each its own git repo). Full design spec, motivation, keybindings, config format, and included themes are documented in IDEA.md — read it before making architectural changes, since it's the source of truth for intended behavior (layout, CLI commands, config schema, etc).

Commands

cargo build --workspace              # build everything
cargo check --workspace              # fast type-check (use this while iterating)
cargo clippy --workspace --all-targets   # lint; keep this clean before considering work done
cargo fmt --all                      # format (run after editing, before checking clippy)
cargo run -p shiki-cli -- <args>     # run the binary, e.g. `-- new "titulo"`, `-- daily`, no args launches the TUI

There are ~293 #[test]s: 134 in shiki-core, 17 in shiki-config, 129 in shiki-tui, 13 in shiki-cli — cargo test --workspace is green. They're all inline #[cfg(test)] modules inside the source files (no tests/ dirs, no #[ignore], no fixture setup), so the pattern set by panel_drawer::tests (shiki-tui/src/panel_drawer.rs) — covering drawer_hit_at's mouse coordinate math as a plain function of numbers, not &App — is the norm. When adding tests, put them as #[cfg(test)] modules in the relevant file; shiki-core/shiki-config have no TUI/terminal dependency, so they're the easiest to unit test. For shiki-tui, prefer designing the function to not need &App in the first place (as drawer_hit_at does) over constructing a full App in a test.

To exercise the CLI without touching the real user config/data, override XDG dirs (used via directories::ProjectDirs::from("", "", "shiki") in shiki-config):