microsoft / microsoft/TypeScript

Codefix: removing inferable types

Aperta
#35,691 1 commento 4 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Awaiting More Feedback Domain: LS: Quick Fixes Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

Search Terms

inferable types no-inferable-types no-inferrable-types removal

Suggestion

It is somewhat unnecessary to add : type declarations for member, parameter, and/or variable types already inferable from code.

// This type declaration actually requests a lower amount of type information,
// as `number` is less specific (narrow) than `3`
const value: number = 3;

It'd be nice to have a codefix to remove them to clean up code.

Use Cases

These unnecessary type declarations can easily get introduced in code as it gets changing during editing, and can cause visual clutter.

We should note that some users choose to prefer including these inferable type declarations as a style preference to increase the amount of type information visible purely from source code.

The @typescript-eslint/no-inferable-types already exists with an auto-fixer for a good starting reference.

Examples

Variables such as the above value can generally have their type removed if either is true:

  • The variable is let, contains an initializer, and the type is the same as what it would be inferred as

    // We can remove `: number` here
    let value: number = 0;
    
    // We cannot remove `: number | string`, as `| string` is not added by TypeScript
    let otherValue: number | string = 0;
    
  • The variable is const and the type is less narrow than what the type is inferred as

Parameters can similarly be treated as let parameters:

// The `: string` can be safely removed
function takesStringWithDefault(input: string = "") { }

Parameters can also have type declarations removed if their parent function is already declared to be a type that provides the same type declaration for the parameter:

type TakesString = (input: string) => void;

// We can remove the `: string` here too
const takesString: TakesString = (input: string) => {};

Class members can be treated as let variables here too.

class WithValue {
    // We can remove the `: string` here
    value: string = "";
}

Checklist

My suggestion meets these guidelines:

  • 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, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

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

Nell’issue non sono indicati file del repository, test o punti di ingresso. Inizia esaminando gli esempi di variabili, parametri e membri della classe, quindi confronta il comportamento proposto con l’auto-fixer di @typescript-eslint/no-inferable-types; il lavoro è completato quando un codefix rimuove in modo sicuro solo le annotazioni inferibili descritte, senza modificare l’output a runtime.

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.