# AGENTS.md

A Vue.js 2.0 UI Toolkit for Web

## Setup

```
yarn install
```

## Commands

```
yarn dev           # run locally
yarn test          # run the test suite, must pass before any commit
yarn lint          # lint
yarn bootstrap
yarn build:file
yarn build:theme
yarn build:utils
yarn build:umd
```

## Layout

- `packages/` 254 source files
- `src/`      93 source files
- `types/`    91 source files
- `test/`     68 source files
- `examples/` 62 source files
- `build/`    27 source files

## Conventions

- Tests live alongside the code they cover, following `build/webpack.test.js`.
- CI defines what passing means. See `.github/workflows/preview-build.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/utils/lodash.js` is 567KB. 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.