← Back to rules

eslint/capitalized-comments Style

🛠️ An auto-fix is available for this rule.

What it does

Enforces or disallows capitalization of the first letter of a comment.

Why is this bad?

Inconsistent capitalization of comments can make code harder to read. This rule helps enforce a consistent style across the codebase.

Examples

Examples of incorrect code for this rule with the default "always" option:

// lowercase comment
/* lowercase block comment */

Examples of correct code for this rule with the default "always" option:

// Capitalized comment
/* Capitalized block comment */
// 123 - comments starting with non-letters are ignored

Configuration

Configuration for the capitalized-comments rule.

The first element specifies whether comments should "always" or "never" begin with a capital letter. The second element is an optional object containing additional options.

The 1st option

type: "always" | "never"

The 2nd option

This option is an object with the following properties:

block

type: object

Configuration options specific to block comments.

block.ignoreConsecutiveComments

type: boolean

If true, consecutive comments will be ignored after the first comment.

block.ignoreInlineComments

type: boolean

If true, inline comments (comments in the middle of code) will be ignored.

block.ignorePattern

type: string

A regex pattern. Comments that match the pattern will not cause violations.

ignoreConsecutiveComments

type: boolean

If true, consecutive comments will be ignored after the first comment.

ignoreInlineComments

type: boolean

If true, inline comments (comments in the middle of code) will be ignored.

ignorePattern

type: string

A regex pattern. Comments that match the pattern will not cause violations.

line

type: object

Configuration options specific to line comments.

line.ignoreConsecutiveComments

type: boolean

If true, consecutive comments will be ignored after the first comment.

line.ignoreInlineComments

type: boolean

If true, inline comments (comments in the middle of code) will be ignored.

line.ignorePattern

type: string

A regex pattern. Comments that match the pattern will not cause violations.

How to use

To enable this rule using the config file or in the CLI, you can use:

Config (.oxlintrc.json)

{
  "rules": {
    "capitalized-comments": "error"
  }
}

CLI

oxlint --deny capitalized-comments

References

• Rule Source