# AGENTS.md

Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown

## Setup

```
pnpm install
```

## Commands

```
pnpm dev              # run locally
pnpm build            # produce a build
pnpm test             # run the test suite, must pass before any commit
pnpm lint             # lint
pnpm clean
pnpm copy:dompurify
pnpm copy:mermaid
pnpm copy:editor
```

## Layout

- `packages/` 931 source files
- `e2e/`      75 source files
- `scripts/`  15 source files
- `tests/`    2 source files
- `demos/`    1 source file

## Conventions

- Tests live alongside the code they cover, following `e2e/diagrams/journey/simple-test.mmd`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/autofix.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

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.