Skip to main content

ESLint plugin for source comment quality

eslint-plugin-write-good-comments-2

Keep source comments clear, inclusive, readable, and maintainable with one plugin built for modern JavaScript and TypeScript teams.

  • npm version badge
  • npm total downloads badge
  • latest GitHub release badge
  • open GitHub stars badge
  • open GitHub issues badge
  • codecov coverage badge
  • GitHub actions CI badge
  • Rules6 shipped
  • Presets2 rollout-ready
  • RuntimeESM + CJS

Highlights

Built for comment-focused linting workflows

The docs site now points directly at the most useful rollout, rule, preset, and API paths instead of making you hunt through multiple shallow entry pages.

Comment-aware analysis

Analyze comment prose only, with markdown-aware handling for inline code spans, block comments, and JSDoc.

Open overview โ†’

Two practical presets

Adopt a low-noise baseline with recommended, or turn on the full six-rule stack with all.

Compare presets โ†’

Six focused rules

Combine write-good, inclusive language, profanity, spellcheck, readability, and task-comment checks in one plugin.

Browse rules โ†’