← Back to rules

jest/max-nested-describe 스타일

작동 방식

이 규칙은 중첩된 describe() 호출의 최대 깊이를 제한합니다.

왜 좋지 않은가?

describe() 블록을 너무 깊게 중첩하면 테스트 세트가 읽기 어렵고 이해하기 어려워집니다.

예시

다음과 같은 패턴은 기본 옵션 { "max": 5 } 에서 경고로 간주됩니다:

잘못된 코드 예시:

describe("foo", () => {
  describe("bar", () => {
    describe("baz", () => {
      describe("qux", () => {
        describe("quxx", () => {
          describe("너무 많은", () => {
            it("어떤 것을 가져와야 한다", () => {
              expect(getSomething()).toBe("Something");
            });
          });
        });
      });
    });
  });
});

describe("foo", function () {
  describe("bar", function () {
    describe("baz", function () {
      describe("qux", function () {
        describe("quxx", function () {
          describe("너무 많은", function () {
            it("어떤 것을 가져와야 한다", () => {
              expect(getSomething()).toBe("Something");
            });
          });
        });
      });
    });
  });
});

올바른 코드 예시:

describe("foo", () => {
  describe("bar", () => {
    it("어떤 것을 가져와야 한다", () => {
      expect(getSomething()).toBe("Something");
    });
  });
  describe("qux", () => {
    it("어떤 것을 가져와야 한다", () => {
      expect(getSomething()).toBe("Something");
    });
  });
});

describe("foo2", function () {
  it("어떤 것을 가져와야 한다", () => {
    expect(getSomething()).toBe("Something");
  });
});

describe("foo", function () {
  describe("bar", function () {
    describe("baz", function () {
      describe("qux", function () {
        describe("이것이 한계입니다", function () {
          it("어떤 것을 가져와야 한다", () => {
            expect(getSomething()).toBe("Something");
          });
        });
      });
    });
  });
});

이 규칙은 eslint-plugin-vitest 와 호환되며, 이를 사용하려면 .oxlintrc.json에 다음 구성 항목을 추가하세요:

{
  "rules": {
    "vitest/max-nested-describe": "error"
  }
}

구성

이 규칙은 다음 속성을 가진 구성 객체를 수용합니다:

max

타입: 정수

기본값: 5

허용되는 중첩된 describe 호출의 최대 깊이.

사용 방법

이 규칙을 설정 파일 또는 CLI를 통해 활성화하려면 다음을 사용할 수 있습니다:

구성 (.oxlintrc.json)

{
  "plugins": ["jest"],
  "rules": {
    "jest/max-nested-describe": "error"
  }
}

CLI

oxlint --deny jest/max-nested-describe --jest-plugin

참고 자료

• 규칙 소스