Skip to main content

🟡 Recommended

Use this as the default preset for most projects that want better source comments without enabling every stricter optional check on day one.

Config key

writeGoodComments.configs.recommended

Flat Config example

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

export default [writeGoodComments.configs.recommended];

This preset enables the lowest-noise baseline rules: prose quality, descriptive task comments, and inclusive-language checks.

Rules in this preset

  • Fix legend:
    • 🔧 = autofixable
    • 💡 = suggestions available
    • = report only
RuleFix
inclusive-language-comments
task-comment-format
write-good-comments