複雜度

強制程式中允許的最大循環複雜度

循環複雜度衡量程式碼中線性獨立路徑的數量。此規則允許設定循環複雜度閾值。

function a(x) {
    if (true) {
        return x; // 1st path
    } else if (false) {
        return x+1; // 2nd path
    } else {
        return 4; // 3rd path
    }
}
1
2
3
4
5
6
7
8
9

規則詳情

此規則旨在透過限制程式中允許的循環複雜度量來降低程式碼複雜度。因此，當循環複雜度超過設定的閾值（預設值為 20）時，它會發出警告。

最大值為 2 的不正確程式碼範例

在 Playground 中開啟

/*eslint complexity: ["error", 2]*/

function a(x) {
    if (true) {
        return x;
    } else if (false) {
        return x+1;
    } else {
        return 4; // 3rd path
    }
}

function b() {
    foo ||= 1;
    bar &&= 1;
}

function c(a = {}) { // default parameter -> 2nd path
    const { b = 'default' } = a; // default value during destructuring -> 3rd path
}

function d(a) {
    return a?.b?.c; // optional chaining with two optional properties creates two additional branches
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

最大值為 2 的正確程式碼範例

在 Playground 中開啟

/*eslint complexity: ["error", 2]*/

function a(x) {
    if (true) {
        return x;
    } else {
        return 4;
    }
}

function b() {
    foo ||= 1;
}
1
2
3
4
5
6
7
8
9
10
11
12
13

類別欄位初始化器和類別靜態區塊是隱含函數。因此，它們的複雜度會針對每個初始化器和每個靜態區塊單獨計算，並且不會影響封閉程式碼的複雜度。

最大值為 2 的其他不正確程式碼範例

在 Playground 中開啟

/*eslint complexity: ["error", 2]*/

class C {
    x = a || b || c; // this initializer has complexity = 3
}

class D { // this static block has complexity = 3
    static {
        if (foo) {
            bar = baz || qux;
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

最大值為 2 的其他正確程式碼範例

在 Playground 中開啟

/*eslint complexity: ["error", 2]*/

function foo() { // this function has complexity = 1
    class C {
        x = a + b; // this initializer has complexity = 1
        y = c || d; // this initializer has complexity = 2
        z = e && f; // this initializer has complexity = 2

        static p = g || h; // this initializer has complexity = 2
        static q = i ? j : k; // this initializer has complexity = 2

        static { // this static block has complexity = 2
            if (foo) {
                baz = bar;
            }
        }

        static { // this static block has complexity = 2
            qux = baz || quux;
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

選項

此規則具有數字或物件選項

"max" (預設值：20) 強制執行最大複雜度
"variant": "classic" | "modified" (預設值："classic") 要使用的循環複雜度變體

max

使用 max 屬性自訂閾值。

"complexity": ["error", { "max": 2 }]
1

已棄用： 物件屬性 maximum 已棄用。請改用屬性 max。

或使用簡寫語法

"complexity": ["error", 2]
1

variant

要使用的循環複雜度變體

"classic" (預設值) - 經典 McCabe 循環複雜度
"modified" - 修改後的循環複雜度

修改後的循環複雜度 與經典循環複雜度相同，但每個 switch 陳述式只會將複雜度值增加 1，無論它包含多少個 case 陳述式。

此規則使用 { "max": 3, "variant": "modified" } 選項的正確程式碼範例

在 Playground 中開啟

/*eslint complexity: ["error", {"max": 3, "variant": "modified"}]*/

function a(x) {     // initial modified complexity is 1
    switch (x) {    // switch statement increases modified complexity by 1
        case 1:
            1;
            break;
        case 2:
            2;
            break;
        case 3:
            if (x === 'foo') {  // if block increases modified complexity by 1
                3;
            }
            break;
        default:
            4;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19