agentreadme

Report · marked 26 Aug 2026

hexojs/hexo

Solid foundations, held back in a few specific places.

TypeScript · 41,773 stars · 302 files · branch master

Fix these first

01
Agent instruction file
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
02
Instruction quality
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
03
Written documentation
Prose that explains why the architecture is the way it is saves an agent from re-deriving it wrong.

The full marking

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

Instructions 3/27 F

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

Agent instruction file 0/12
None found. Every agent that opens this repo starts from zero.
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
Looked for AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, .cursorrules
Instruction quality 0/12
Nothing to judge, since there are no instructions.
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
README as an entry point 3/3
README has a clear getting-started section.
Setup 14/14 A+

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

Deterministic install 6/6
package-lock.json pins the dependency tree.
Found package-lock.json
Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (prepublishOnly, build, clean, eslint, test, test-cov…)
Environment config n/a
Not applicable — this reads as a library, with no environment to configure.
Pinned runtime version 2/2
The language runtime version is pinned.
package.json engines.node >=20.19.0
Reproducible environment n/a
Not applicable — a library doesn't need a container to be worked on.
Verification loop 24/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
127 test files against 274 source files.
e.g. test/benchmark.js, test/fixtures/_config.json, test/fixtures/banner.jpg
Test command is discoverable 7/7
An agent can find and run `npm run test`.
Continuous integration 4/4
6 GitHub Actions workflows define what "passing" means.
Lint and format rules 3/3
eslint.config.js encodes the house style.
Static type checking 2/3
Type checking is configured, but not in strict mode.
Turn on `"strict": true`. Type errors are the fastest feedback an agent gets, and non-strict mode silently discards most of them.
Context economy 20/20 A+

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

No committed build output 6/6
No generated directories committed.
.gitignore hygiene 3/3
.gitignore covers 10 patterns.
File sizes fit in context 6/6
No source file is large enough to crowd out a context window.
Repository weight 5/5
About 7.3MB 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 hexojs/hexo
# AGENTS.md

A fast, simple & powerful blog framework, powered by Node.js.

## Setup

```
npm ci
```

## Commands

```
npm run build            # produce a build
npm run test             # run the test suite, must pass before any commit
npm run prepublishOnly
npm run clean
npm run eslint
npm run test-cov
npm run prepare
```

## Layout

- `lib/`  149 source files
- `test/` 124 source files

## Conventions

- Tests live alongside the code they cover, following `test/benchmark.js`.
- 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/benchmark.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

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/hexojs/hexo.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 72 out of 100

[![agent ready](https://agentreadme.com/badge/hexojs/hexo.svg)](https://agentreadme.com/hexojs/hexo)

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