message-commands

A deny rule by default: it refuses a message naming more than one backticked command.

What it catches

A message naming more than one backticked command.

Dimension

structure: the reader has to reconstruct the order or the purpose. A finding is counted on the dimension of its rule, the cost it names to the reader.

Why

A reader runs the first command a message names. A second competes with it, so a message names the one to run first.

Default decision

The code is PRF9003. 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-commands": "advise"},
  "paths": {"blog/**": {"message-commands": "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-commands", "code": "PRF9003", "decision": "deny", "url": "https://eli.gladman.cc/magus/reference/proofread/message-commands/"}

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