Skip to main content

key-spacing

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.

Enforce consistent spacing between property names and type annotations in types and interfaces.

🔧

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

Examples​

This rule extends the base eslint/key-spacing rule. This version adds support for type annotations on interfaces, classes and type literals properties.

Options​

.eslintrc.cjs
module.exports = {
  "rules": {
    // Note: you must disable the base rule as it can report incorrect errors
    "key-spacing": "off",
    "@typescript-eslint/key-spacing": "error"
  }
};
Try this rule in the playground ↗

See eslint/key-spacing options.

How to Use​

Resources​

Taken with ❤️ from ESLint core