microsoft / microsoft/TypeScript

Support `@deprecated` marker on namespace aliases

未关闭
#62,340 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看
Domain: JSDoc Help Wanted Possible Improvement
主要语言
Go
星标
111k
派生
14.3k
平均合并
2 天 4 小时
30 天内合并 PR
132

描述

### 🔍 Search Terms

"@deprecated", "deprecated", "namespace", "namespace alias"

### ✅ Viability Checklist

- [x] This wouldn't be a breaking change in existing TypeScript/JavaScript code
- [x] This wouldn't change the runtime behavior of existing JavaScript code
- [x] This could be implemented without emitting different JS based on the types of the expressions
- [x] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
- [x] This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- [x] This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals

### ⭐ Suggestion

Note: Marking this as a feature request, very well might be a bug. It's one of those that are probably up for interpretation?

---

I'd like the ability to annotate namespace aliases with `@deprecated`. At the moment you'd need to mark the referenced type as deprecated, which often isn't viable.

Here's a little example:

```ts
// @filename: example.d.ts
export type Bar = string | number;

/** @deprecated */
export type Baz = string | number;

// @filename: foo.ts
import * as example from './example';

declare namespace JSX {
/** @deprecated */
export type Foo = string | number;

/** @deprecated */
export import Bar = example.Bar;

export import Baz = example.Baz;
}

let x: JSX.Foo; // Marked as deprecated
let y: JSX.Bar; // Not marked as deprecated (but should be)
let z: JSX.Baz; // Marked as deprecated
```

[TypeScript Playground Link](https://www.typescriptlang.org/play/?jsx=0&multiFile=true#code/PTAEAEDMEsBsFMB2BDAtvAXKeAPNAHBAOgBMiAXAZwChd8B7AJ3NHIE995QAhZR0ALyhK5RtEQBzUAB9QiAK6oARvEYBuatWAAqbRBLx8jeAGNk5eCVDbgtHA2asOXXgC9Bw0eKmyFy1RqaIBAwCCjoWJD09BQ00KgOLHrIlNh4CQigkIz0qKAA5ETAuAQI+YEGJrB8XOHwlPjIJlwAUgDKABqgAN7UAJA6euAGRqbmlta2fXRMLOycoABi0R4iYpIycooq6poDuvqGxmYWVjb9M47xiTx8HiUZ8ES8uxf2s6DXH2736YRPbg0AF9NAgWDgsO0OkRlvQNGDQGxIZ1nnx4fAWK5kdDAUA)

### 📃 Motivating Example

Allows developers to mark namespace aliases as deprecated, giving downstream users more warning when those aliases will go away.

### 💻 Use Cases

1. What do you want to use this for?

[preact](https://github.com/preactjs/preact) has long since loaded up the JSX namespace with unrelated types... shouldn't have, but did. We're looking to get rid of this in our next major and to help folks migrate we wanted to extract the types to the `preact` namespace and re-export them as aliases through the `JSX` namespace. This will avoid any breaking changes in the current version and allow folks to keep compatibility with v10 and the upcoming v11.

Unfortunately, however, we can't mark this usage as deprecated which is a shame.

2. What shortcomings exist with current approaches?

Just doesn't work. End users get no warning that the namespace alias is deprecated.

3. What workarounds are you using in the meantime?

Just duplicated all the types. Instead of extracted types that are consumed both as direct exports and namespace aliases, we've had to make copies. Those in the namespace get the deprecation comment, those outside do not.

It's pretty fragile obviously, any change to one now has to be reflected to the same interface in another file.

贡献指南

打开贡献指南

调研方向

从 issue 中的 TypeScript Playground 示例开始,跟踪命名空间成员和类型别名的弃用报告方式。为 `export import Bar = example.Bar` 添加回归覆盖,使 `JSX.Bar` 被标记为已弃用,同时保持现有的 `JSX.Baz` 行为不变。当命名空间别名产生预期的弃用警告且不改变 JavaScript 输出时,即表示完成。

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

评估

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

把新 issue 发到你的邮箱

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