useConsistentObjectDefinitions

import { Tabs, TabItem } from '@astrojs/starlight/components';

<Tabs> <TabItem label="JavaScript (and super languages)" icon="seti:javascript"> ## Summary - Rule available since: `v2.0.0` - Diagnostic Category: [`lint/style/useConsistentObjectDefinitions`](/reference/diagnostics#diagnostic-category) - This rule isn't recommended, so you need to enable it. - This rule has a [**safe**](/linter/#safe-fixes) fix. - The default severity of this rule is [**warning**](/reference/diagnostics#warning). - Sources: - Inspired from [`object-shorthand`](https://eslint.org/docs/latest/rules/object-shorthand)

How to configure

json

{
	"linter": {
		"rules": {
			"style": {
				"useConsistentObjectDefinitions": "error"
			}
		}
	}
}

Description

Require the consistent declaration of object literals. Defaults to explicit definitions.

ECMAScript 6 provides two ways to define an object literal: {foo: foo} and {foo}. The two styles are functionally equivalent. Using the same style consistently across your codebase makes it easier to quickly read and understand object definitions.

Example

Invalid

json

{
	"linter": {
		"rules": {
			"style": {
				"useConsistentObjectDefinitions": {
					"options": {
						"syntax": "shorthand"
					}
				}
			}
		}
	}
}

let foo = 1;
let invalid = {
    foo: foo
};

<pre class="language-text"><code class="language-text">code-block.js:3:5 <a href="https://biomejs.dev/linter/rules/use-consistent-object-definitions">lint/style/useConsistentObjectDefinitions</a> FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ⚠ Do not use explicit object property syntax when shorthand syntax is possible. 1 │ let foo = 1; 2 │ let invalid = { > 3 │ foo: foo │ ^^^^^^^^ 4 │ }; 5 │ ℹ Using shorthand object property syntax makes object definitions more concise. ℹ Safe fix: Use shorthand object property syntax. 3 │ ····foo:·foo │ ----- </code></pre>

let invalid = {
    bar: function() { return "bar"; },
};

<pre class="language-text"><code class="language-text">code-block.js:2:5 <a href="https://biomejs.dev/linter/rules/use-consistent-object-definitions">lint/style/useConsistentObjectDefinitions</a> FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ⚠ Do not use explicit object property syntax when shorthand syntax is possible. 1 │ let invalid = { > 2 │ bar: function() { return "bar"; }, │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 3 │ }; 4 │ ℹ Using shorthand object property syntax makes object definitions more concise. ℹ Safe fix: Use shorthand object property syntax. 2 │ ····bar:·function()·{·return·"bar";·}, │ ---------- </code></pre>

Valid

let foo = 1;
let valid = {
    foo,
    bar() { return "bar"; },
};

Invalid

json

{
	"linter": {
		"rules": {
			"style": {
				"useConsistentObjectDefinitions": {
					"options": {
						"syntax": "explicit"
					}
				}
			}
		}
	}
}

let foo = 1;
let invalid = {
    foo
};

<pre class="language-text"><code class="language-text">code-block.js:3:5 <a href="https://biomejs.dev/linter/rules/use-consistent-object-definitions">lint/style/useConsistentObjectDefinitions</a> FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ⚠ Do not use shorthand object property syntax. 1 │ let foo = 1; 2 │ let invalid = { > 3 │ foo │ ^^^ 4 │ }; 5 │ ℹ Using explicit object property syntax makes object definitions more readable and consistent. ℹ Safe fix: Use explicit object property syntax. 3 │ ····foo:·foo │ +++++ </code></pre>

let invalid = {
    bar() { return "bar"; },
};

<pre class="language-text"><code class="language-text">code-block.js:2:5 <a href="https://biomejs.dev/linter/rules/use-consistent-object-definitions">lint/style/useConsistentObjectDefinitions</a> FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ⚠ Do not use shorthand object property syntax. 1 │ let invalid = { > 2 │ bar() { return "bar"; }, │ ^^^^^^^^^^^^^^^^^^^^^^^ 3 │ }; 4 │ ℹ Using explicit object property syntax makes object definitions more readable and consistent. ℹ Safe fix: Use explicit object property syntax. 2 │ ····bar:·function·()·{·return·"bar";·}, │ +++++++++++ </code></pre>

Valid

let foo = 1;
let valid = {
    foo: foo,
    bar: function() { return "bar"; },
};

Options

Use the options to specify the syntax of object literals to enforce.

json

{
	"linter": {
		"rules": {
			"style": {
				"useConsistentObjectDefinitions": {
					"options": {
						"syntax": "explicit"
					}
				}
			}
		}
	}
}

syntax

The syntax to use:

shorthand: enforces the use of shorthand object property syntax when possible.
explicit: enforces the use of explicit object property syntax in every case.

Default: shorthand

</TabItem> </Tabs>

How to configure

Description

Example

Invalid

Valid

Invalid

Valid

Options

syntax

Related links