Textlint

To increase the quality of Frontity's documentation the repository includes textlint, a tool that will generate a report over the texts added or modified to the repo

Most of the rules used by textlink will generate just a warning (⚠️) but a few of them will generate an error (⛔️). No errors are allowed in the commits so they should be fixed to be able to complete the commit

Most of these errors detected can be fixed by doing npx textlink --fix <pattern-files>

The rules used to generate the reports are the ones specified under the textlint property in the package.json. For now they are:

• ⚠️ textlint-rule-alex: Alex helps you find gender favouring, polarising, race related, religion inconsiderate, or other unequal phrasing.
• ⚠️ textlint-rule-common-misspellings: Check common misspellings from Wikipedia: Lists of common misspellings.
• ⚠️ textlint-rule-en-capitalization: Check and fix capitalization.
• ⚠️ textlint-rule-no-empty-section: Check for empty sections.
• ⚠️ textlint-rule-no-exclamation-question-mark: Disallow exclamation and question marks.
• ⚠️ textlint-rule-one-sentence-per-line: A fixable textlint rule adding a line break after each sentence, also known as Semantic Line Breaks (SemBr).
• ⚠️ textlint-rule-period-in-list-item: Check with or without period in list item.
• ⚠️ textlint-rule-rousseau: Check English sentence using rousseau.
• ⚠️ textlint-rule-spelling: Check spellings with much more language dictionaries.
• ⛔️ textlint-rule-terminology: Check and fix correct terms spelling. Check the default terminology.
• ⚠️ textlint-rule-write-good: Proofreading with btford/write-good. "write good" is a "naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too."