Rule: curly

Enforces braces for if/for/do/while statements.

Rationale

if (foo === bar)
    foo++;
    bar++;

In the code above, the author almost certainly meant for both foo++ and bar++ to be executed only if foo === bar. However, they forgot braces and bar++ will be executed no matter what. This rule could prevent such a mistake.

Notes:

Config

One of the following options may be provided:

• "as-needed" forbids any unnecessary curly braces.
• "ignore-same-line" skips checking braces for control-flow statements that are on one line and start on the same line as their control-flow keyword

Config examples

"curly": true

"curly": [true, "ignore-same-line"]

"curly": [true, "as-needed"]

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "as-needed",
      "ignore-same-line"
    ]
  }
}

Code examples:

"rules": { "curly": true }

if (x > 0) {
    doStuff();
}

if (x > 0)
    doStuff();

if (x > 0) doStuff();

"rules": { "curly": [true, "ignore-same-line"] }

if (x > 0) doStuff();

if (x > 0)
    doStuff()

"rules": { "curly": [true, "as-needed"] }

if (x > 0)
    doStuff();

if (x > 0) {
    customerUpdates.push(getInfo(customerId));
    return customerUpdates;
}

if (x > 0) {
    doStuff();
}