← Back to rules

vitest/prefer-describe-function-title 스타일

An auto-fix is available for this rule.

작동 방식

특정 함수를 테스트할 때, 이 규칙은 describe()에 고정된 문자열 대신 이름이 지정된 함수를 전달하도록 강제합니다.

왜 좋지 않은가?

특정 함수와 관련된 테스트에서, 테스트 대상 함수의 이름이 변경되면 describe 제목이 더 이상 일치하지 않게 되어 미래에 혼란을 야기할 수 있습니다. 함수를 사용하면 함수 이름이 변경되어도 일관성 유지가 보장됩니다.

예시

이 규칙에 부적절한 코드 예시:

// myFunction.test.js
import { myFunction } from "./myFunction";

describe("myFunction", () => {
  // ...
});

이 규칙에 적절한 코드 예시:

// myFunction.test.js
import { myFunction } from "./myFunction";

describe(myFunction, () => {
  // ...
});

사용 방법

구성 파일 또는 CLI를 통해 이 규칙을 활성화하려면 다음을 사용할 수 있습니다:

구성 파일 (.oxlintrc.json)

{
  "plugins": ["vitest"],
  "rules": {
    "vitest/prefer-describe-function-title": "error"
  }
}

CLI

oxlint --deny vitest/prefer-describe-function-title --vitest-plugin

참고 자료

• 규칙 소스