← Back to rules

typescript/prefer-ts-expect-error Pedantic

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

что делает

@ts-ignore 대신 @ts-expect-error 사용을 강제합니다.

왜 이 것이 나쁜가요?

TypeScript는 오류가 발생하는 줄 바로 앞에 @ts-ignore 또는 @ts-expect-error로 시작하는 주석을 넣음으로써 해당 줄의 모든 오류를 무시할 수 있게 허용합니다. 두 지시어는 동일하게 작동하지만, @ts-expect-error는 실제로 오류가 없는 줄 위에 위치할 경우 타입 오류를 유발합니다.

이는 @ts-ignore가 잊혀질 수 있으며, 원래 억제하려던 오류가 해결된 후에도 코드 내에 그대로 남아 있을 수 있음을 의미합니다. 이것은 위험합니다. 왜냐하면 그 줄에 새로운 오류가 발생했을 때, 잊혀진 @ts-ignore 때문에 오류가 무시되게 되고, 그 결과 발견되지 않을 수 있기 때문입니다.

예시

이 규칙에 대해 잘못된 코드 예시:

// @ts-ignore
const str: string = 1;

/**
 * 설명 주석
 *
 * @ts-ignore */
const multiLine: number = "value";

이 규칙에 대해 올바른 코드 예시:

/**
 * 설명 주석
 *
 * @ts-expect-error */
const multiLine: number = "value";

사용 방법

구성 파일 또는 명령줄 인터페이스에서 이 규칙을 활성화하기 위해 다음을 사용할 수 있습니다:

Config (.oxlintrc.json)

{
  "rules": {
    "typescript/prefer-ts-expect-error": "error"
  }
}

CLI

oxlint --deny typescript/prefer-ts-expect-error

참고 자료

• 규칙 소스