Skip to main content

key-spacing

<admonition title="Deprecated" type="warning"> Formatting rules now live in <a href="https://eslint.style">eslint-stylistic</a>. <a href="https://eslint.style/rules/ts/key-spacing">@stylistic/ts/key-spacing</a> is the replacement for this rule. <br /> See <a href="/blog/deprecating-formatting-rules">Deprecating Formatting Rules</a> for more information. </admonition>

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.

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

Options​

See eslint/key-spacing options.

How to Use​

.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 ↗

Resources​

Taken with ❤️ from ESLint core.