GRAIN

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

8 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.

33 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.

Turning the document into something a machine enforces.

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