microsoft / microsoft/TypeScript

Codefix: removing inferable types

Abierto
#35,691 1 comentario 4 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Awaiting More Feedback Domain: LS: Quick Fixes Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.4k
Merge medio
1 d 19 h
PR fusionados (30 d)
117

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

El issue no menciona archivos del repositorio, pruebas ni puntos de entrada. Empieza revisando los ejemplos de variables, parámetros y miembros de clase, y luego compara el comportamiento propuesto con el auto-fixer de @typescript-eslint/no-inferable-types; se considera terminado cuando un codefix elimina de forma segura solo las anotaciones inferibles descritas, sin cambiar la salida en tiempo de ejecución.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript
Área
compilers
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.