agentreadme

Report · marked 27 Aug 2026

vitejs/vite

Solid foundations, held back in a few specific places.

TypeScript · 82,542 stars · 2,806 files · branch main

Fix these first

01
Environment config
Add a .env.example listing every variable with a safe placeholder value. It's the cheapest possible fix and it unblocks the whole first run.
02
Agent instruction file
Rename or symlink to AGENTS.md so tools other than one vendor's can read it. Keeping Copilot instructions alongside it costs nothing.
03
Static type checking
A type checker gives an agent an error message instead of a runtime surprise. It's the second-fastest feedback loop after the compiler.

The full marking

Every deduction below names the file or setting it came from.

Instructions 20/27 B+

Whether the repo tells an agent how to behave before it starts guessing.

Agent instruction file 8/12
Copilot instructions is present, but not the vendor-neutral AGENTS.md.
Rename or symlink to AGENTS.md so tools other than one vendor's can read it. Keeping Copilot instructions alongside it costs nothing.
Instruction quality 10/12
Specific enough that an agent can act on it.
Worth fixing: has no code blocks.
1,631 characters, a workable length
names the actual commands to run
uses headings, so an agent can skim it
README as an entry point 2/3
README exists but never explains how to get the thing running.
Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.
Setup 14/20 B+

Whether an agent can install the project and get it running without a human.

Deterministic install 6/6
pnpm-lock.yaml pins the dependency tree.
Found pnpm-lock.yaml
Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (preinstall, postinstall, format, lint, typecheck, test…)
scripts/ directory
Environment config 0/4
Nothing documents the environment this needs. An agent will get a runtime error it can't diagnose.
Add a .env.example listing every variable with a safe placeholder value. It's the cheapest possible fix and it unblocks the whole first run.
Pinned runtime version 2/2
The language runtime version is pinned.
package.json engines.node ^20.19.0 || >=22.12.0
Reproducible environment 0/2
No container or devcontainer definition.
A Dockerfile or devcontainer removes an entire class of 'it won't install' failures.
Verification loop 22/25 A

Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.

Tests exist 8/8
518 test files against 1592 source files.
e.g. packages/create-vite/__tests__/cli.spec.ts, packages/plugin-legacy/src/__tests__/index.spec.ts, packages/plugin-legacy/src/__tests__/readme.spec.ts
Test command is discoverable 7/7
An agent can find and run `npm run test`.
Continuous integration 4/4
13 GitHub Actions workflows define what "passing" means.
Lint and format rules 3/3
eslint.config.js encodes the house style.
Static type checking 0/3
No static type checking.
A type checker gives an agent an error message instead of a runtime surprise. It's the second-fastest feedback loop after the compiler.
Context economy 14/20 B+

Whether the repo fits in a context window, or fights it.

No committed build output 3/6
Generated output is committed: node_modules/.
Add these to .gitignore and `git rm -r --cached` them. Generated files pollute search results, so an agent grepping for a function finds the compiled copy and edits the wrong file.
.gitignore hygiene 3/3
.gitignore covers 22 patterns.
File sizes fit in context 4/6
1 source file is over 100KB.
A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.
packages/vite/src/node/plugins/css.ts — 114KB
Repository weight 4/5
About 74.1MB checked out, which is comfortable.

Here is your AGENTS.md

Drafted from what is actually in this repository: the install command from your lockfile, the commands you already declare, your real directory layout. Anything marked TODO needs a person. Save it at the root as AGENTS.md.

AGENTS.md — drafted for vitejs/vite
# AGENTS.md

Next generation frontend tooling. It's fast!

## 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 typecheck     # type check without emitting
pnpm lint          # lint
pnpm format        # format
pnpm preinstall
pnpm postinstall
```

## Layout

- `playground/` 1067 source files
- `packages/`   486 source files
- `docs/`       29 source files
- `scripts/`    7 source files

## Conventions

- Tests live alongside the code they cover, following `packages/create-vite/__tests__/cli.spec.ts`.
- CI defines what passing means. See `.github/workflows/bot.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/vite/src/node/plugins/css.ts` is 114KB. 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.

Open the raw markdown  or  curl -o AGENTS.md agentreadme.com/draft/vitejs/vite.md

Show the mark

The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.

agent ready 78 out of 100

[![agent ready](https://agentreadme.com/badge/vitejs/vite.svg)](https://agentreadme.com/vitejs/vite)

Other TypeScript repositories, marked

freeCodeCamp/freeCodeCamp 69 B openclaw/openclaw 68 B nilbuild/developer-roadmap 45 C vuejs/vue 67 B n8n-io/n8n 87 A anomalyco/opencode 80 A-

All TypeScript repositories

Think this mark is wrong?

Every deduction above names the file it came from, so this can be settled by looking. If a check missed something, that is a rule worth fixing.

Open an issue, already filled in