microsoft / microsoft/TypeScript

Support `@deprecated` marker on namespace aliases

Aperta
#62,340 0 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Domain: JSDoc Help Wanted Possible Improvement
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

### 🔍 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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con l’esempio di TypeScript Playground nell’issue e segui come viene segnalata la deprecazione per i membri dei namespace e gli alias di tipo. Aggiungi una copertura di regressione per `export import Bar = example.Bar` in modo che `JSX.Bar` venga contrassegnato come deprecato, mentre il comportamento esistente di `JSX.Baz` rimanga invariato. Il lavoro è completato quando gli alias di namespace producono l’avviso di deprecazione previsto senza modificare l’output JavaScript.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
compilers
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.