跳至內容

typescript/prefer-ts-expect-error 吹毛求疵

🛠️ 此規則提供自動修正。

功能說明

強制使用 @ts-expect-error 而非 @ts-ignore。

為何這樣不好?

TypeScript 允許您透過在錯誤行之前立即放置以 @ts-ignore 或 @ts-expect-error 開頭的註解來抑制該行上的所有錯誤。這兩個指令的工作方式相同,除了 @ts-expect-error 如果放置在沒有錯誤的行之前,則會導致類型錯誤。

這表示 @ts-ignores 很容易被遺忘,即使它們正在抑制的錯誤被修復後,仍然留在程式碼中。這是危險的,因為如果該行出現新的錯誤,它將被遺忘的 @ts-ignore 抑制,因此會被忽略。

範例

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

/**
 * Explaining comment
 *
 * @ts-ignore */
const multiLine: number = "value";

參考

以 MIT 授權釋出。