← Back to rules

jest/valid-title 正しさ

🛠️ An auto-fix is available for this rule for some violations.

何を行うか

Jest および Vitest のブロックのタイトルが有効であるかを確認します。

タイトルは次の条件を満たさなければなりません：

• 空文字列ではないこと、
• 文字列であること、
• ブロック名で始まらないこと、
• 先頭や末尾に空白がないこと。

なぜ問題か

無効なタイトルは誤解を招きやすく、テストの目的を理解しにくくします。

例

このルールに対して不正なコードの例：

describe("", () => {});
describe("foo", () => {
  it("", () => {});
});
it("", () => {});
test("", () => {});
xdescribe("", () => {});
xit("", () => {});
xtest("", () => {});

このルールに対して正しいコードの例：

describe("foo", () => {});
it("bar", () => {});
test("baz", () => {});

オプション

interface Options {
  ignoreSpaces?: boolean;
  ignoreTypeOfTestName?: boolean;
  ignoreTypeOfDescribeName?: boolean;
  allowArguments?: boolean;
  disallowedWords?: string[];
  mustNotMatch?: Partial<Record<"describe" | "test" | "it", string>> | string;
  mustMatch?: Partial<Record<"describe" | "test" | "it", string>> | string;
}

使用方法

このルールを設定ファイルまたは CLI で有効化するには、次のように使用できます：

Config (.oxlintrc.json)

{
  "plugins": ["jest"],
  "rules": {
    "jest/valid-title": "error"
  }
}

CLI

oxlint --deny jest/valid-title --jest-plugin

参照

• ルールのソース