# AGENTS.md

An open source code editor for the web, written in JavaScript, HTML and CSS.

## Setup

```
npm install
```

## Commands

```
npm run test          # run the test suite, must pass before any commit
npm run prepush
npm run postinstall
npm run eslint
```

## Layout

- `src/`   781 source files
- `test/`  210 source files
- `tasks/` 7 source files
- `tools/` 3 source files

## Conventions

- Tests live alongside the code they cover, following `src/extensibility/node/spec/Installation.spec.js`.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `test/perf/OpenFile-perf-files/brackets-concat.js` is 3290KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

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.