microsoft / microsoft/TypeScript
The `@ts-ignore` vs. `@ts-expect-error` Dilemma: Missing a Warning-Only Redundancy Check
还没有人认领这个 Issue。
- 主要语言
- Go
- 星标
- 111k
- 派生
- 14.3k
- 平均合并
- 2 天 4 小时
- 30 天内合并 PR
- 132
描述
⭐ Suggestion
We propose introducing a mechanism (either a new directive or a configuration option) that provides a Warning-level diagnostic when a type suppression comment is unused.
This feature is needed to fill the gap between the permanently silent @ts-ignore and the build-breaking @ts-expect-error. The goal is to allow active awareness of stale code without halting the CI pipeline.
Specifically, we request one of the following:
- A New Directive: A directive functionally equivalent to
// @ts-expect-error, but which emits its unused check (the equivalent ofTS2578) as a Warning. - A Compiler Flag: An option to explicitly downgrade the severity of the
TS2578: Unused '@ts-expect-error' directivediagnostic from Error to Warning.
📃 Motivating Example
For development teams managing projects with frequent dependency updates, the choice between @ts-ignore and @ts-expect-error is a risk management problem.
Current strictness dictates that a successful, external fix to a dependency's type definition must immediately break our codebase to enforce comment removal. This high-cost cleanup process often drives teams toward the permanently unsafe @ts-ignore to maintain CI stability.
A warning-level check removes this friction. It guarantees that temporary suppressions are never forgotten (like @ts-expect-error) while ensuring that the build process remains robust and responsive to upstream improvements (unlike @ts-ignore). This allows teams to prioritize cleaning up stale suppressions as a continuous maintenance task, rather than a critical, synchronous intervention.
💻 Use Cases
-
What do you want to use this for?
This feature would be used primarily for temporary suppressions that are dependent on frequently changing external code (such as library dependencies or rapid internal package updates), ensuring the temporary fix is never forgotten while allowing the system to tolerate the external fix being resolved.
-
What shortcomings exist with current approaches?
The shortcomings are the two extremes created by the current directives:
Directive Does It Alert When Unused? Unused Diagnostic Output Workflow Impact @ts-ignoreNo None Too Loose: Encourages type safety neglect and hides new, unrelated bugs. @ts-expect-errorYes Hard Compilation Error ( TS2578)Too Strict: Halts the entire build/CI pipeline when the suppression becomes unused. When a developer explicitly or implicitly updates a dependency and the underlying type error is resolved, the resulting
TS2578error immediately fails the build. This forces a synchronous context switch and cleanup task, making it an impractical solution for temporary dependency workarounds in high-velocity teams. -
What workarounds are you using in the meantime?
The current workarounds leave much to be desired:
- Falling back to the permanently unsafe
@ts-ignoreto maintain CI stability. - Implementing brittle internal patches to TS to intercept and programmatically downgrade the severity of the
TS2578error
- Falling back to the permanently unsafe
🔍 Search Terms
@ts-expect-error @ts-ignore warning
✅ Viability Checklist
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
- This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
未指定文件或测试。首先跟踪现有的 @ts-expect-error 和 TS2578 诊断处理,然后比较提议的指令和编译器选项设计。当未使用的抑制产生警告级别的诊断,且不会导致 build 失败时,即视为完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- typescript
- 领域
- compilers
- Issue 类型
- 功能
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100