Skip to main content

eslint-plugin-write-good-comments-2

eslint-plugin-write-good-comments-2 helps JavaScript and TypeScript projects keep source comments clear, concise, inclusive, and useful by linting both normal prose comments and TODO-style task comments.

What this documentation includes​

  • a full rule reference for the shipped rules
  • Getting Started guidance for Flat Config projects
  • lightweight developer notes for contributors
  • preset docs that stay aligned with the published plugin metadata
  • docs for the plugin's six shipped rules and two public presets

Next step​

Open Getting Started to enable the recommended preset quickly, then use the rule reference to expand into spellcheck, readability, or stricter comment quality checks.