Spelling and prose

The spelling configuration runs typos on code, comments, and documentation. The prose configuration runs Vale on documentation and comments. gspot selects both in every repository.

Spelling

typos checks American English by default. spelling.locale accepts en, en-us, en-gb, en-ca, and en-au:

gspot set spelling.locale en-gb

To accept a word, add it with a reason:

gspot set allowed_words Acmeflow --reason "Acmeflow is our product name."

Vale accepts the word too.

Prose

At level recommended, Vale checks ambiguous dates, link text, and image alt text. At level all, it adds the full style, with these limits; raising one needs a reason.

Setting	Default
prose.max_sentence_words	30
prose.max_list_item_words	45
prose.max_paragraph_sentences	6

The prose configuration lists the checks.