multiline-ternary

Enforce newlines between operands of ternary expressions

This rule was deprecated in ESLint v8.53.0. Please use the corresponding rule in @stylistic/eslint-plugin-js.

JavaScript allows operands of ternary expressions to be separated by newlines, which can improve the readability of your program.

For example:

var foo = bar > baz ? value1 : value2;
1

The above can be rewritten as the following to improve readability and more clearly delineate the operands:

var foo = bar > baz ?
    value1 :
    value2;

var foo = bar > baz
    ? value1
    : value2;
1
2
3
4
5
6
7
8

Rule Details

This rule enforces or disallows newlines between operands of a ternary expression. Note: The location of the operators is not enforced by this rule. Please see the operator-linebreak rule if you are interested in enforcing the location of the operators themselves.

Options

This rule has a string option:

• "always" (default) enforces newlines between the operands of a ternary expression.
• "always-multiline" enforces newlines between the operands of a ternary expression if the expression spans multiple lines.
• "never" disallows newlines between the operands of a ternary expression.

always

This is the default option.

Examples of incorrect code for this rule with the "always" option:

/*eslint multiline-ternary: ["error", "always"]*/

foo > bar ? value1 : value2;

foo > bar ? value :
    value2;

foo > bar ?
    value : value2;
1
2
3
4
5
6
7
8
9

Examples of correct code for this rule with the "always" option:

/*eslint multiline-ternary: ["error", "always"]*/

foo > bar ?
    value1 :
    value2;

foo > bar ?
    (baz > qux ?
        value1 :
        value2) :
    value3;

foo > bar
    ? (baz > qux
        ? value1
        : value2)
    : value3;
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

always-multiline

Examples of incorrect code for this rule with the "always-multiline" option:

/*eslint multiline-ternary: ["error", "always-multiline"]*/

foo > bar ? value1 :
    value2;

foo > bar ?
    value1 : value2;

foo > bar &&
    bar > baz ? value1 : value2;
1
2
3
4
5
6
7
8
9
10

Examples of correct code for this rule with the "always-multiline" option:

/*eslint multiline-ternary: ["error", "always-multiline"]*/

foo > bar ? value1 : value2;

foo > bar ?
    value1 :
    value2;

foo > bar ?
    (baz > qux ? value1 : value2) :
    value3;

foo > bar ?
    (baz > qux ?
        value1 :
        value2) :
    value3;

foo > bar &&
    bar > baz ?
        value1 :
        value2;

foo > bar
    ? baz > qux
        ? value1
        : value2
    : value3;
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

never

Examples of incorrect code for this rule with the "never" option:

/*eslint multiline-ternary: ["error", "never"]*/

foo > bar ? value :
    value2;

foo > bar ?
    value : value2;

foo >
    bar ?
    value1 :
    value2;
1
2
3
4
5
6
7
8
9
10
11
12

Examples of correct code for this rule with the "never" option:

/*eslint multiline-ternary: ["error", "never"]*/

foo > bar ? value1 : value2;

foo > bar ? (baz > qux ? value1 : value2) : value3;

foo > bar ? (
    baz > qux ? value1 : value2
) : value3;
1
2
3
4
5
6
7
8
9

When Not To Use It

You can safely disable this rule if you do not have any strict conventions about whether the operands of a ternary expression should be separated by newlines.

Compatibility

• JSCS: requireMultiLineTernary

Related Rules

• operator-linebreak

Version

This rule was introduced in ESLint v3.1.0.

Resources

• Rule source
• Tests source