Skip to main content

comma-dangle

danger
We strongly recommend you do not use this rule or any other formatting linter rules. Use a separate dedicated formatter instead. See What About Formatting? for more information.

Require or disallow trailing commas.

🔧

Some problems reported by this rule are automatically fixable by the --fix ESLint command line option.

Examples​

This rule extends the base eslint/comma-dangle rule. It adds support for TypeScript syntax.

See the ESLint documentation for more details on the comma-dangle rule.

How to Use​

.eslintrc.cjs
module.exports = {
  "rules": {
    // Note: you must disable the base rule as it can report incorrect errors
    "comma-dangle": "off",
    "@typescript-eslint/comma-dangle": "warn"
  }
};

In addition to the options supported by the comma-dangle rule in ESLint core, the rule adds the following options:

  • "enums" is for trailing comma in enum. (e.g. enum Foo = {Bar,})
  • "generics" is for trailing comma in generic. (e.g. function foo<T,>() {})
  • "tuples" is for trailing comma in tuple. (e.g. type Foo = [string,])

Options​

See eslint/comma-dangle options.

Resources​

Taken with ❤️ from ESLint core