useConsistentObjectDefinition

JavaScript (and super languages)

Summary

Diagnostic Category: lint/nursery/useConsistentObjectDefinition
This rule doesn’t have a fix.
The default severity of this rule is error.
Sources:
- Inspired from object-shorthand

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

1
{
2
    "options": {
3
        "syntax": "explicit"
4
    }
5
}

1
let foo = 1;
2
let invalid = {
3
    foo
4
};

code-block.js:3:5 lint/nursery/useConsistentObjectDefinition ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

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

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

code-block.js:2:5 lint/nursery/useConsistentObjectDefinition ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

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

Valid

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

Invalid

1
{
2
    "options": {
3
        "syntax": "shorthand"
4
    }
5
}

1
let foo = 1;
2
let invalid = {
3
    foo: foo
4
};

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

Valid

1
let foo = 1;
2
let valid = {
3
    foo,
4
    bar() { return "bar"; },
5
};

Options

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

1
{
2
    "options": {
3
        "syntax": "explicit"
4
    }
5
}

syntax

The syntax to use:

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

Default: explicit

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "nursery": {
5
        "useConsistentObjectDefinition": "error"
6
      }
7
    }
8
  }
9
}

useConsistentObjectDefinition

Summary

Description

Example

Invalid

Valid

Invalid

Valid

Options

syntax

How to configure

Related links