Rule Reference | eslint-plugin-write-good-comments-2

📄️R001 ✍️ write-good-comments

Check source comments with write-good and report low-quality prose.

Require TODO-style task comments to include a descriptive body.

Require source comments to avoid exclusionary or inconsiderate language.

Disallow profane wording in source comments.

Spellcheck source comments with cspell dictionaries and a curated coding vocabulary.

Flag source comments that are hard to read with retext-readability.