← 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; // test 함수 이름의 타입 무시 여부
  ignoreTypeOfDescribeName?: boolean; // describe 함수 이름의 타입 무시 여부
  allowArguments?: boolean; // 인수 허용 여부
  disallowedWords?: string[]; // 사용 금지 단어 목록
  mustNotMatch?: Partial<Record<"describe" | "test" | "it", string>> | string; // 반드시 일치하지 않아야 하는 패턴
  mustMatch?: Partial<Record<"describe" | "test" | "it", string>> | string; // 반드시 일치해야 하는 패턴
}

사용 방법

이 규칙을 설정 파일 또는 명령줄에서 활성화하려면 다음과 같이 사용할 수 있습니다:

설정 파일 (.oxlintrc.json)

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

CLI

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

참고 자료

• 규칙 소스