# AGENTS.md

A browser based code editor

## Setup

```
npm ci
```

## Commands

```
npm run build               # produce a build
npm run test                # run the test suite, must pass before any commit
npm run import-typescript
npm run postinstall
npm run prettier-check
npm run prettier
npm run pretty-quick
npm run simpleserver
```

## Layout

- `src/`               428 source files
- `website/`           78 source files
- `monaco-lsp-client/` 33 source files
- `samples/`           27 source files
- `build/`             23 source files
- `test/`              17 source files

## Conventions

- Tests live alongside the code they cover, following `src/languages/definitions/abap/abap.test.ts`.
- CI defines what passing means. See `.github/workflows/ci.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that.
- `src/languages/features/typescript/lib/typescriptServices.js` is 8900KB. 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.