# AGENTS.md

This is the repo for Vue 2. For Vue 3, go to https://github.com/vuejs/core

## 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 format         # format
pnpm dev:cjs
pnpm dev:esm
pnpm dev:ssr
pnpm dev:compiler
```

## Layout

- `src/`        148 source files
- `test/`       133 source files
- `packages/`   87 source files
- `types/`      34 source files
- `benchmarks/` 7 source files
- `scripts/`    7 source files

## Conventions

- Tests live alongside the code they cover, following `packages/compiler-sfc/test/__snapshots__/compileScript.spec.ts.snap`.
- 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/ci.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`dist/`). Search will return the compiled copy, so edit the source, not that.

---

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.