jest/prefer-lowercase-title 樣式

🛠️ 此規則提供自動修正功能。

作用

強制 it、test 和 describe 的描述以小寫字母開頭。這樣可以提供更易讀的測試失敗訊息。此規則預設為停用。

範例

// invalid
it("Adds 1 + 2 to equal 3", () => {
  expect(sum(1, 2)).toBe(3);
});

// valid
it("adds 1 + 2 to equal 3", () => {
  expect(sum(1, 2)).toBe(3);
});

選項

{
  "jest/prefer-lowercase-title": [
    "error",
    {
      "ignore": ["describe", "test"]
    }
  ]
}

ignore

此陣列選項控制此規則檢查哪些 Jest 函式。有三個可能的值

• "describe"
• "test"
• "it"

預設情況下，這些選項都不啟用 (相當於 { "ignore": [] })。

{ "ignore": ["describe"] } 選項的正確程式碼範例

/* eslint jest/prefer-lowercase-title: ["error", { "ignore": ["describe"] }] */
describe("Uppercase description");

{ "ignore": ["test"] } 選項的正確程式碼範例

/* eslint jest/prefer-lowercase-title: ["error", { "ignore": ["test"] }] */
test("Uppercase description");

{ "ignore": ["it"] } 選項的正確程式碼範例

/* eslint jest/prefer-lowercase-title: ["error", { "ignore": ["it"] }] */
it("Uppercase description");

allowedPrefixes

此陣列選項允許指定前綴，其中包含標題可以開頭的大寫字母。當為 API 端點編寫測試時，您可能想使用 HTTP 方法作為前綴，這會很有用。預設情況下，不允許任何前綴 (相當於 { "allowedPrefixes": [] })。

{ "allowedPrefixes": ["GET"] } 選項的正確程式碼範例

/* eslint jest/prefer-lowercase-title: ["error", { "allowedPrefixes": ["GET"] }] */
describe("GET /live");

ignoreTopLevelDescribe

可以設定此選項，以允許只有最上層的 describe 區塊可以使用以大寫字母開頭的標題。 { "ignoreTopLevelDescribe": true } 選項的正確程式碼範例

/* eslint jest/prefer-lowercase-title: ["error", { "ignoreTopLevelDescribe": true }] */
describe("MyClass", () => {
  describe("#myMethod", () => {
    it("does things", () => {
      //
    });
  });
});

參考資料

• 規則來源