microsoft / microsoft/TypeScript

Consider deprecating `<prefix>` type assertions

未关闭
#62,842 0 条评论 18 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

Awaiting More Feedback Suggestion
主要语言
Go
星标
111k
派生
14.3k
平均合并
2 天 4 小时
30 天内合并 PR
132

描述

### Acknowledgement

- [x] I acknowledge that issues using this template may be closed without further explanation at the maintainer's discretion.

### Comment

# Consider deprecating `` type assertions

## Background

TypeScript has two syntax forms to declare type assertions that have identical behavior:

- `value as type` *(modern)*
- `value` *(legacy, not supported in `*.tsx` files or with `erasableSyntaxOnly`)*

The `as` operator was introduced in September 2015 in [TypeScript 1.6](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-1-6.html#new-tsx-file-extension-and-as-operator) as the default way to cast in TSX files. The motivation was to remove ambiguity between JSX expressions and angle-bracket style of the type assertions.

[Official](https://www.typescriptlang.org/docs/handbook/jsx.html#the-as-operator) [documentation](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#type-assertions) is relatively unopinionated about which to prefer in scenarios where either is viable, but [some docs](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#literal-inference) only show the `as` syntax. Third-party educators barely mention `` assertions; Matt Pocock's materials mention them once to say *"don't use this".*

`` type assertions are not allowed with [`erasableSyntaxOnly`](https://www.typescriptlang.org/tsconfig/#erasableSyntaxOnly). Node.js built-in support for type stripping only supports the `as` syntax.

The TypeScript-ESLint rule [`consistent-type-assertions`](https://typescript-eslint.io/rules/consistent-type-assertions) defaults to preferring the `as` syntax and will error on `` usage.

## Opinion

Due to the greater compatibility, as well as engineer's preference for *"give me one way to do it"* consistency, the `as` syntax has been dominant for many years. I would speculate that most TypeScript users don't consciously know the old syntax exists. Either they don't come across it, or if they do they may casually overlook it and perhaps confuse it with some use of generics.

It would be constructive for TypeScript to build on the observed widespread preference and to set a clear direction for the future. This would decrease developer confusion and increase the compatibility of code in the wild.

## Proposal

There is a graduated set of steps that could be taken, similar to that taken for the [deprecated `module` keyword for namespace](https://github.com/microsoft/TypeScript/issues/51825) that reduced two-ways-to-do-it down to one. (I'll also highlight that deprecation was an excellent example of language stewardship, ecosystem cooperation, and forward-looking-yet-safe language evolution 💙)

There is value in beginning these steps, even if the process takes a long time, and even if not all steps are completed.

### 1. Discourage `` assertions in docs

This would be a clear message to the ecosystem in the TypeScript documentation that one style is universally preferred over the other. It may inspire linters to take a stronger stance.

### 2. Soft-deprecate via Editor feedback

Use the LSP ~strikethrough~ ability to provide a visual indication of the legacy style within the IDE, along with a Quick Fix to convert the code to the modern style.

### 3. Warn in the checker

An error is emitted that can be silenced via `"ignoreDeprecations"`. This represents formal deprecation.

### 4. Error in the checker

The final stage of deprecation.

## Contributions

It would be very easy to find folk willing to contribute these changes if the core team preferred that.

## FAQ

#### Will this disambiguate JSX? e.g. to safely allow JSX tags in regular `*.ts` files?

No. That's not the goal. There remain orthogonal issues blocking that.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

该 issue 没有指明实现文件或测试。首先查看提案的 documentation、editor-feedback 和 checker-deprecation 阶段,然后确定维护者希望推进哪个阶段;完成意味着形成一项经过同意、范围明确且有相应验证的变更。

由索引模型根据 Issue 内容生成。

评估

技术栈
typescript
领域
compilers
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。