noExcessiveNestedCallbacks (JavaScript)

Language JavaScript (and super languages)

Summary

Rule available since: v2.4.14
Diagnostic Category: lint/complexity/noExcessiveNestedCallbacks
This rule isn’t recommended, so you need to enable it.
This rule doesn’t have a fix.
The default severity of this rule is information.
Sources:
- Same as max-nested-callbacks

How to configure

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

Description

Enforce a maximum depth that callbacks can be nested.

Deeply nested callbacks make asynchronous control flow difficult to read and follow. This rule reports callback functions nested beyond the configured limit.

Examples

Invalid

1
foo1(function () {
2
    foo2(function () {
3
        foo3(function () {
4
            foo4(function () {
5
                foo5(function () {
6
                    foo6(function () {});
7
                });
8
            });
9
        });
10
    });
11
});

code-block.js:6:26 lint/complexity/noExcessiveNestedCallbacks ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ This callback is nested too deeply.
  
    4 │             foo4(function () {
    5 │                 foo5(function () {
  > 6 │                     foo6(function () {});
      │                          ^^^^^^^^^^^^^^
    7 │                 });
    8 │             });
  
  ℹ Callbacks nested 6 levels deep are harder to read and maintain. The configured maximum is 5.
  
  ℹ Extract some callbacks into named functions to reduce nesting.

Valid

1
foo1(handleFoo1);
2

3
function handleFoo1() {
4
    foo2(handleFoo2);
5
}

Options

max

The maximum callback nesting depth allowed (default: 5).

1
{
2
  "linter": {
3
    "rules": {
4
      "complexity": {
5
        "noExcessiveNestedCallbacks": {
6
          "level": "on",
7
          "options": {
8
            "max": 3
9
          }
10
        }
11
      }
12
    }
13
  }
14
}

Invalid

1
foo1(function () {
2
    foo2(function () {
3
        foo3(function () {
4
            foo4(function () {});
5
        });
6
    });
7
});

code-block.js:4:18 lint/complexity/noExcessiveNestedCallbacks ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ This callback is nested too deeply.
  
    2 │     foo2(function () {
    3 │         foo3(function () {
  > 4 │             foo4(function () {});
      │                  ^^^^^^^^^^^^^^
    5 │         });
    6 │     });
  
  ℹ Callbacks nested 4 levels deep are harder to read and maintain. The configured maximum is 3.
  
  ℹ Extract some callbacks into named functions to reduce nesting.

Valid

1
foo1(function () {
2
    foo2(function () {
3
        foo3(function () {});
4
    });
5
});

noExcessiveNestedCallbacks (JavaScript)

Summary

How to configure

Description

Examples

Invalid

Valid

Options

max

Invalid

Valid

Related links