Principle records — 60–70 lines max

Keep architect-lint `.rule.md` files short: one principle, compact examples, link related rules for depth.

Nx·Monorepo Hygiene·Medium·Since 2026-05-25

nx-monorepo-principle-record-brevity

Why it matters

Failure modes if this rule is ignored

Stake	If ignored
Agent gets lost	Long principle records bury the rule — reviewers and agents skip the middle and miss the actual constraint.
Hard to change	Bloated examples duplicate what related rules already say — two places drift when one changes.

How to fix

Target 60–70 lines per .rule.md (including frontmatter). pnpm validate fails above 70 for rules added on or after 2026-05-25.

One principle per file. Two or three tagged bullets in "Why it matters". One short "How to fix" paragraph. Incorrect and Correct examples show the pattern only — not full implementations. Split into a second rule or use related: when you need more depth.

Examples

Bad

# Agent payloads use schema allowlists, not blocklist sanitization

(117 lines: three essay paragraphs, two 40-line code blocks,
registerTools helper, toRunEvent mapper, and blocklist variants
all in one file)

Good

# Agent payloads use schema allowlists, not blocklist sanitization

(~65 lines: three bullets, one paragraph how-to-fix,
15-line incorrect block, 20-line correct block,
related: nestjs-realtime-stream-structured-agent-events)

When not to apply

Legacy rules above 70 lines may remain until edited — then trim or split to meet the limit.

Related principles

• Documentation in a place you can't missNxnx-monorepo-docs-readme-required

Contribute

View sourceSuggest editDiscuss