microsoft / microsoft/TypeScript

Type subscope for local type aliases

Abierto
#41,470 3 comentarios 15 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Awaiting More Feedback Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.3k
Merge medio
2 d 4 h
PR fusionados (30 d)
132

Descripción

Search Terms

type scope, type iife

Suggestion

A syntax that allows for a type subscope (like a js IIFE).

Use Cases

When constructing complex types, they are often not very readable without breaking them up into multiple type aliases. However, this means that you have to pass the type aliases through, along with their constraints, and it can become even less readable.

Examples

Basic examples of the concept / suggested syntax
// All of the below are equivalent to { p: { q: T } }

type X0<T> = {{
  type A = { q: T };
  type B = { p: A };
  type = B;
}}; 

type X1<T> = {{
  type = B;
  type A = { q: T };
  type B = { p: A };
}}; 

type X2<T> = {{
  type Q<U> = { q: U };
  type A = Q<T>;
  type B = { p: A };
  type = B;
}}; 

type X3<T> = {
  p: {{
    type A = { q: T };
    type = A;
  }};
};

type X4<T> = {{
  type = { p: { q: T } };
}};
Example of applying this to a real-world type

Consider the traditional approach in the following type:

// Bluebird-esque promisifyAll (monolithic):

type PromisifyAll<T> = {
  [K in keyof T & string as `${T}Async`]: (
    T[K] extends (...args: infer A) => void
      ? A extends [...infer B, (error: any, result?: infer R) => void]
        ? (...args: B) => Promise<R>
        : never
      : never
  )
}

This isn't very readable; it might help to extract some of it to type aliases:

// Bluebird-esque promisifyAll (refactored to type aliases):

type OrigArgs<Value> = Value extends (...args: infer A) => void ? A : never;
type SplitArgs<OrigArgs extends any[]> =
  OrigArgs extends [...infer A, (error: any, result?: infer R) => void]
    ? { args: A, result: R }
    : never;
type Func<SplitArgs extends { args: any[], result: any }> = (...args: SplitArgs["args"]) => Promise<SplitArgs["result"]>;
type PromisifyAll<T> = {
  [K in keyof T & string as `${T}Async`]: Func<SplitArgs<OrigArgs<T[K]>>>
}

That doesn't look great, pollutes the type scope, and has a bit of extends boilerplate.

With this proposal, you could write:

// Bluebird-esque promisifyAll (refactored to use type subscope):

type PromisifyAll<T> = {
  [K in keyof T & string as `${T}Async`]: {{
    type Value = T[K];
    type OrigArgs = Value extends (...args: infer A) => void ? A : never;
    type SplitArgs =
      OrigArgs extends [...infer A, (error: any, result?: infer R) => void]
        ? { args: A, result: R }
        : never;
    type Func = (...args: SplitArgs["args"]) => Promise<SplitArgs["result"]>;
    type = Func;
  }}
}

Or, a terser variant:

// Bluebird-esque promisifyAll (refactored to use type subscope, terser):

type PromisifyAll<T> = {
  [K in keyof T & string as `${T}Async`]: {{
    type OrigArgs = T[K] extends (...args: infer A) => void ? A : never;
    type SplitArgs =
      OrigArgs extends [...infer A, (error: any, result?: infer R) => void]
        ? { args: A, result: R }
        : never;
    type = (...args: SplitArgs["args"]) => Promise<SplitArgs["result"]>;
  }}
}

While we're all used to nested conditional types, if you saw the equivalent of the original type definition in runtime code, you would likely agree that it should be refactored.

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

No se mencionan archivos de implementación ni pruebas. Empieza revisando la sintaxis propuesta de type-subscope y los ejemplos; después, sigue las áreas del compilador responsables de analizar y resolver alias de tipo; el trabajo estará completo cuando haya una sintaxis acordada y un comportamiento correspondiente del sistema de tipos con pruebas.

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
28/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.