eslint-plugin-write-good-comments-2

March 18, 2026 · View on GitHub

eslint-plugin-write-good-comments-2 improves source comments with write-good, retext-equality, retext-profanities, retext-spell, retext-readability, and descriptive task-comment enforcement so vague, inconsiderate, misspelled, or hard-to-read comment text is caught before it spreads through a codebase.

Installation

npm install --save-dev eslint-plugin-write-good-comments-2

import writeGoodComments from "eslint-plugin-write-good-comments-2";

export default [writeGoodComments.configs.recommended];

Preset	Preset page
🟡 `writeGoodComments.configs.recommended`	Recommended
🟣 `writeGoodComments.configs.all`	All

write-good-comments — run write-good against normal source comment prose.
task-comment-format — require TODO-style task comments to include a descriptive body.
inclusive-language-comments — require source comments to avoid exclusionary or inconsiderate language.
no-profane-comments — disallow profane wording in source comments.
spellcheck-comments — spellcheck comment prose with a curated technical vocabulary.
readability-comments — flag comment sentences that are unnecessarily hard to read.