跳至內容

jest/require-top-level-describe 樣式

作用

如果測試案例(testit)或鉤子(beforeAllbeforeEachafterEachafterAll)未位於頂層 describe 區塊中,則此規則會觸發警告。

範例

javascript
// invalid

// Above a describe block
test("my test", () => {});
describe("test suite", () => {
  it("test", () => {});
});

// Below a describe block
describe("test suite", () => {});
test("my test", () => {});

// Same for hooks
beforeAll("my beforeAll", () => {});
describe("test suite", () => {});
afterEach("my afterEach", () => {});

//valid

// Above a describe block
// In a describe block
describe("test suite", () => {
  test("my test", () => {});
});

// In a nested describe block
describe("test suite", () => {
  test("my test", () => {});
  describe("another test suite", () => {
    test("my other test", () => {});
  });
});

選項

您也可以使用 maxNumberOfTopLevelDescribes 選項,強制限制頂層允許的 describe 數量

json
{
  "jest/require-top-level-describe": [
    "error",
    {
      "maxNumberOfTopLevelDescribes": 2
    }
  ]
}

參考資料

根據 MIT 許可發布。