← Back to rules

jest/prefer-lowercase-title 스타일

An auto-fix is available for this rule.

동작 방식

it, test, describe, 및 bench의 설명이 소문자로 시작하도록 강제합니다. 이를 통해 더 가독성이 뛰어난 테스트 실패 메시지를 제공합니다.

왜 좋지 않은가?

테스트 실패 시 소문자 메시지를 사용하면 일반적으로 문법적으로 더 정확한 실패 메시지를 얻을 수 있습니다.

예시

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

it("Adds 1 + 2 to equal 3", () => {
  expect(sum(1, 2)).toBe(3);
});

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

it("adds 1 + 2 to equal 3", () => {
  expect(sum(1, 2)).toBe(3);
});

이 규칙은 eslint-plugin-vitest와 호환됩니다. 이를 사용하려면 .oxlintrc.json에 다음 구성 설정을 추가하세요:

{
  "rules": {
    "vitest/prefer-lowercase-title": "error"
  }
}

구성 옵션

이 규칙은 다음 속성을 가지는 구성 객체를 수용합니다.

allowedPrefixes

type: string[]

기본값: []

이 배열 옵션을 사용해 제목이 대문자로 시작할 수 있는 접두사를 지정할 수 있습니다. 이는 API 엔드포인트 테스트를 작성할 때 유용할 수 있으며, 여기서 HTTP 메서드를 접두사로 사용하고 싶을 경우에 적합합니다. 기본적으로 허용되는 것이 없습니다 (즉, { "allowedPrefixes": [] }와 동일).

{ "allowedPrefixes": ["GET"] } 옵션에 대한 적절한 코드 예시:

/* jest/prefer-lowercase-title: ["error", { "allowedPrefixes": ["GET"] }] */
describe("GET /live");

ignore

type: string[]

기본값: []

이 배열 옵션은 이 규칙이 어떤 Jest 또는 Vitest 함수를 확인할지 제어합니다. 가능한 값은 네 가지입니다:

• "describe"
• "test"
• "it"
• "bench"

기본적으로 이러한 옵션 중 어느 것도 활성화되지 않습니다 (즉, { "ignore": [] }와 동일).

{ "ignore": ["describe"] } 옵션에 대한 적절한 코드 예시:

/* jest/prefer-lowercase-title: ["error", { "ignore": ["describe"] }] */
describe("대문자 설명");

{ "ignore": ["test"] } 옵션에 대한 적절한 코드 예시:

/* jest/prefer-lowercase-title: ["error", { "ignore": ["test"] }] */
test("대문자 설명");

{ "ignore": ["it"] } 옵션에 대한 적절한 코드 예시:

/* jest/prefer-lowercase-title: ["error", { "ignore": ["it"] }] */
it("대문자 설명");

ignoreTopLevelDescribe

type: boolean

기본값: false

이 옵션을 설정하면 상위 레벨의 describe 블록만 대문자로 시작하는 제목을 허용할 수 있습니다.

{ "ignoreTopLevelDescribe": true } 옵션에 대한 적절한 코드 예시:

/* jest/prefer-lowercase-title: ["error", { "ignoreTopLevelDescribe": true }] */
describe("MyClass", () => {
  describe("#myMethod", () => {
    it("does things", () => {
      //
    });
  });
});

lowercaseFirstCharacterOnly

type: boolean

기본값: true

이 옵션을 설정하면 테스트 이름의 첫 번째 문자만 소문자로 변환되었는지 검증합니다.

{ "lowercaseFirstCharacterOnly": true } 옵션에 대한 적절한 코드 예시:

/* vitest/prefer-lowercase-title: ["error", { "lowercaseFirstCharacterOnly": true }] */
describe("myClass", () => {
  describe("myMethod", () => {
    it("does things", () => {
      //
    });
  });
});

{ "lowercaseFirstCharacterOnly": true } 옵션에 대한 부적절한 코드 예시:

/* vitest/prefer-lowercase-title: ["error", { "lowercaseFirstCharacterOnly": true }] */
describe("MyClass", () => {
  describe("MyMethod", () => {
    it("does things", () => {
      //
    });
  });
});

사용 방법

구성 파일을 사용하거나 명령줄에서 이 규칙을 활성화하기 위해 다음과 같이 사용할 수 있습니다:

구성 파일 (.oxlintrc.json)

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

CLI

oxlint --deny jest/prefer-lowercase-title --jest-plugin

참고 문서

• 규칙 소스