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", () => {
      //
    });
  });
});

参考资料

• 规则来源