← Back to rules

eslint/object-shorthand Style

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

What it does

Require or disallow method and property shorthand syntax for object literals

Why is this bad?

Stylistic preference

Example

Here are a few common examples using the ES5 syntax:

var properties = { x: x, y: y, z: z };
var methods = { a: function () {}, b: function () {} };

Now here are ES6 equivalents:

var properties = { x, y, z };
var methods = { a() {}, b() {} };

Configuration

The 1st option

type: "always" | "methods" | "properties" | "consistent" | "consistent-as-needed" | "never"

The 2nd option

This option is an object with the following properties:

avoidExplicitReturnArrows

type: boolean

default: false

avoidQuotes

type: boolean

default: false

ignoreConstructors

type: boolean

default: false

methodsIgnorePattern

type: string

How to use

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

Config (.oxlintrc.json)

{
  "rules": {
    "object-shorthand": "error"
  }
}

Config (oxlint.config.ts)

import { defineConfig } from "oxlint";

export default defineConfig({
  rules: {
    "object-shorthand": "error",
  },
});

CLI

oxlint --deny object-shorthand

Version

This rule was added in v1.59.0.

References

• Rule Source
• Open rule in Oxc Playground