# AGENTS.md

A post-modern modal text editor.

## Setup

```
cargo build
```

## Commands

```
cargo test   # run the test suite
```

## Layout

- `tests/`           107 source files
- `helix-term/`      70 source files
- `helix-core/`      44 source files
- `helix-lsp-types/` 35 source files
- `helix-view/`      26 source files
- `helix-tui/`       22 source files

## Conventions

- Tests live alongside the code they cover, following `helix-core/tests/data/indent/languages.toml`.
- CI defines what passing means. See `.github/workflows/build.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `helix-term/src/commands.rs` is 239KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.