GRAIN

The APERTURESyndicate code standard: naming, contracts, shape, boundaries — the part of code that survives any formatter.

11 pages

Start here

What the standard is, and the fastest way to judge whether it is worth adopting.

What GRAIN is, the three principles behind it, and the three adoption levels.

A real handler rewritten rule by rule, with the price of every violation.

Every term the standard uses, explained on code from the walkthrough.

The rules themselves: closed vocabularies, function shape, boundaries, files.

34 verbs with contracts, unit suffixes, boolean prefixes, words that say nothing.

The funnel, the numbers behind it, where time and randomness may live, and the two classes of failure.

One role per file, domain-shaped directories, and the five comment tags.

Why generated code is recognisable, and what the standard deliberately leaves alone.

The same vocabularies where code ends: configuration files and the names events travel under.

A config key reads by the same laws as a variable name — and where config ends and data begins.

An event is a fact that happened, not a command: the closed participle vocabulary and why a live name is never renamed.

Turning the document into something a machine enforces.

Levels, badge, ESLint plugin, checker, pre-commit, and what a machine cannot check.

Why a model drifts back to the style it was trained on, and Small GRAIN — twelve laws that fit in a prompt.