noExcessiveNestedTestSuites

JavaScript (and super languages)

摘要

¥Summary

规则生效日期：v1.6.0

¥Rule available since: v1.6.0
诊断类别：lint/complexity/noExcessiveNestedTestSuites

¥Diagnostic Category: lint/complexity/noExcessiveNestedTestSuites
此规则没有修复方案。

¥This rule doesn’t have a fix.
此规则的默认严重级别为 information。

¥The default severity of this rule is information.
此规则属于以下域：

¥This rule belongs to the following domains:
- test
来源：

¥Sources:
- 与 jest/max-nested-describe 相同
  
  ¥Same as jest/max-nested-describe
- 与 vitest/max-nested-describe 相同
  
  ¥Same as vitest/max-nested-describe

如何配置

¥How to configure

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

描述

¥Description

此规则强制测试文件中嵌套 describe() 的最大深度。

¥This rule enforces a maximum depth to nested describe() in test files.

为了提高测试中的代码清晰度，规则将嵌套的 describe 限制为 5。

¥To improve code clarity in your tests, the rule limits nested describe to 5.

示例

¥Examples

无效

¥Invalid

1
describe('foo', () => {
2
  describe('bar', () => {
3
    describe('baz', () => {
4
      describe('qux', () => {
5
        describe('quxx', () => {
6
          describe('too many', () => {
7
            it('should get something', () => {
8
              expect(getSomething()).toBe('Something');
9
            });
10
          });
11
        });
12
      });
13
    });
14
  });
15
});

code-block.js:6:11 lint/complexity/noExcessiveNestedTestSuites ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Excessive `describe()` nesting detected.
  
     4 │       describe(‘qux’, () => {
     5 │         describe(‘quxx’, () => {
   > 6 │           describe(‘too many’, () => {
       │           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   > 7 │             it(‘should get something’, () => {
   > 8 │               expect(getSomething()).toBe(‘Something’);
   > 9 │             });
  > 10 │           });
       │           ^^
    11 │         });
    12 │       });
  
  ℹ Excessive nesting of describe() calls can hinder test readability.
  
  ℹ Consider refactoring and reduce the level of nested describe to improve code clarity.

有效

¥Valid

1
describe('foo', () => {
2
  describe('bar', () => {
3
    it('should get something', () => {
4
      expect(getSomething()).toBe('Something');
5
    });
6
  });
7
  describe('qux', () => {
8
    it('should get something', () => {
9
      expect(getSomething()).toBe('Something');
10
    });
11
  });
12
});

noExcessiveNestedTestSuites

摘要

如何配置

描述

示例

无效

有效

相关链接