microsoft / microsoft/TypeScript
Add a `redeclare` keyword to redeclare class attributes, behaving like `override !:` while keeping type modifiers.
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 2g 4h
- PR unite (30g)
- 132
Descrizione
### 🔍 Search Terms
redeclare
declare override
Related issues:
- https://github.com/microsoft/typescript/issues/51515
- https://github.com/microsoft/typescript/issues/37771
- https://github.com/microsoft/TypeScript/issues/4062
### ✅ 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
A `redeclare` keyword behaving like `override` + `declare` while keeping previous type modifiers (e.g. `readonly`, `protected`, `public`).
```ts
type BaseType = {};
type Overriden = {x: number};
class A {
protected readonly foo: BaseType;
constructor(protected readonly faa: BaseType) {}
}
class B extends A {
redeclare foo: Overriden;
// equivalent to "override [protected readonly] foo!: Overriden"
constructor( redeclare faa: Overriden ) { super(faa); }
// idem above. Do not set faa itself.
}
```
We could use `redeclare` with modifiers, e.g. `public` or `-readonly` to override previous type modifiers:
```ts
redeclare public faa: Overriden; // make it public, do not change whether it is readonly or not, etc.
redeclare public faa; // make it public, do not change its type, whether it is readonly or not, etc.
redeclare -readonly faa; // make it read-write, do not change its type or its visibility.
```
I also suggest the related changes:
- in constructor parameters, `!:` would mean "declare but do not set".
- using `declare` as an alias to `!:` when used in constructor parameters, or with `override`.
Note: `redeclare` could also be used in other contexts, e.g. to precise a variable type (cf related issue), but this is not in the scope of this suggestion.
### 📃 Motivating Example
Currently, if you want to override an attribute, you have to:
```ts
type BaseType = {};
type Overriden = {x: number};
class A {
protected readonly foo: BaseType;
}
class B extends A {
override readonly foo!: Overriden;
}
```
However, if you forget one of the type modifier (here: `protected`) you would have no warnings as it might be voluntary. A reader do not know if this is a mistake or not.
By using `redeclare` you would ensure no type modifier is forgotten, while making intents explicit.
Indeed, if the type modifiers are modified in class `A`, using `redeclare` ensures that all subclasses has the correct type modifiers (except if explicitly stated otherwise).
Also, `redeclare` would enable to redeclare a type from the constructor, instead of having to provide the type twice.
```ts
type BaseType = {};
type Overriden = {x: number};
class A {
protected readonly foo: BaseType;
}
class B extends A {
constructor( redeclare foo: Overriden ) { ... }
}
```
### 💻 Use Cases
1. What do you want to use this for?
Safely re-declaring classes attributes.
3. What shortcomings exist with current approaches?
- We have to rewrite all type modifiers.
- In constructors parameters, we would have useless (or even unwanted) attribute assignations.
- Without constructors parameters, requires to provide the type twice.
- With a generic base class, this is quite brittle : the base class and each of its subclasses needs to know which of the attribute might be redeclared. This could lead too an excessive amount of generic types if too much attributes.
4. What workarounds are you using in the meantime?
I use constructors parameters with the useless assignations.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia leggendo le issue correlate #51515, #37771 e #4062 insieme agli esempi di redeclarazione e alla checklist di fattibilità. Chiarisci il comportamento proposto per gli attributi di classe e i parametri del costruttore, inclusi i modificatori ereditati e gli override espliciti; per considerare il lavoro completato sarebbe necessaria una progettazione del linguaggio concordata, che questa issue non fornisce ancora.
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à
- Tranquilla
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100