jest/consistent-test-it 样式

🛠️ 此规则可自动修复。

它做什么

Jest 允许你选择定义测试的方式，使用 it 或 test 关键字，每个关键字有多种形式

• it: it、xit、fit、it.only、it.skip。
• test: test、xtest、test.only、test.skip。

示例

/*eslint jest/consistent-test-it: ["error", {"fn": "test"}]*/
test("foo"); // valid
test.only("foo"); // valid

it("foo"); // invalid
it.only("foo"); // invalid

/*eslint jest/consistent-test-it: ["error", {"fn": "it"}]*/
it("foo"); // valid
it.only("foo"); // valid
test("foo"); // invalid
test.only("foo"); // invalid

/*eslint jest/consistent-test-it: ["error", {"fn": "it", "withinDescribe": "test"}]*/
it("foo"); // valid
describe("foo", function () {
  test("bar"); // valid
});

test("foo"); // invalid
describe("foo", function () {
  it("bar"); // invalid
});

选项

此规则可按如下方式配置

{
  type: "object",
  properties: {
    fn: {
      enum: ["it", "test"],
    },
    withinDescribe: {
      enum: ["it", "test"],
    },
  },
  additionalProperties: false,
}

fn

决定使用 test 或 it。

withinDescribe

决定在 describe 范围内使用 test 或 it。

此规则与 eslint-plugin-vitest 兼容，要使用此规则，请将以下配置添加到你的 .eslintrc.json

{
  "rules": {
     "vitest/consistent-test-it": "error"
  }
}


## References
- [Rule Source](https://github.com/oxc-project/oxc/blob/main/crates/oxc_linter/src/rules/jest/consistent_test_it.rs)