message-length

A deny rule by default: it refuses a message longer than its rune cap, 160 unless the caller names one.

What it catches

A message longer than its rune cap, 160 unless the caller names one.

Dimension

economy: words that carry nothing. A finding is counted on the dimension of its rule, the cost it names to the reader.

Why

A message is read in a terminal at the moment something went wrong: about two lines hold a verdict, one command and a ref, and the rationale belongs behind the ref.

Default decision

The code is PRF9001. The decision depends on the kind of text judged:

Changing it

A decisions table sets this rule to deny, advise or off, for everything judged or for the files a glob matches. Proofread reads the table from the file its -decisions flag names:

{
  "rules": {"message-length": "advise"},
  "paths": {"blog/**": {"message-length": "off"}}
}

rules applies to every file. A glob in paths applies to the files it matches, and the last match wins. A rule set to off never reports.

Seeing it

A finding names the rule, its code and the decision that applies, and links here:

{"rule": "message-length", "code": "PRF9001", "decision": "deny", "url": "https://eli.gladman.cc/magus/reference/proofread/message-length/"}

proofread rules prints this entry with every other rule's.

See also

• All proofread rules - every rule, grouped by what it checks
• Writing rules - how the rules apply to this repository's pages and pull requests
• The findings contract - the fields every finding carries