# AGENTS.md

Apache ECharts is a powerful, interactive charting and data visualization library for browser

## Setup

```
npm ci
```

## Commands

```
npm run dev               # run locally
npm run build             # produce a build
npm run test              # run the test suite, must pass before any commit
npm run lint              # lint
npm run build:esm
npm run build:i18n
npm run build:lib
npm run build:extension
```

## Layout

- `src/`   596 source files
- `test/`  128 source files
- `i18n/`  54 source files
- `theme/` 43 source files
- `build/` 29 source files
- `dist/`  8 source files

## Conventions

- Tests live alongside the code they cover, following `test/-cases.html`.
- TypeScript is not in strict mode. Turning it on catches a whole class of mistakes before they run.
- 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.
- `dist/echarts.js` is 3757KB. 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.