microsoft / microsoft/TypeScript
Narrowing string down to a module specifier
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.3k
- Merge medio
- 2 d 4 h
- PR fusionados (30 d)
- 132
Descripción
🔍 Search Terms
string, narrow, module, import, specifier
✅ Viability Checklist
- 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, new syntax sugar for JS, etc.)
- This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
⭐ Suggestion
Being able to declare a string as resolvable (a module specifier), without having to use an actual import or typeof import(specifier).
📃 Motivating Example
The following shows what this issue is about, using a hypothetical Resolvable:
// Would be nice if one could resolve/dereference these anywhere, not only inside `import`.
// Get intellisense and type checker support for string and identifier here:
const foo: Resolvable = "foo";
const bar: Resolvable = "bar";
// and here:
const b: Record<string, Resolvable> = {
[foo],
baz: bar,
};
// Nuh-uh: "Hello World!" is not resolvable;
b[foo] = "Hello World!";
// and anywhere;
await import(feelingBazyToday ? b["baz"] : b[foo]);
The following shows a workaround, with clearly different DX and architecture.
const foo = "foo";
const bar = "bar";
// Is the following pattern beneficial or does it hurt?
// To me it looks like useless wrappers and repetition.
// It's also harder to describe the `typeof a`, although
// one may rely on inference in some situations.
const a: Record<string, ((...x: any[]) => GoodLuck)> = {
foo: () => import(foo),
baz: () => import(bar),
};
// May or may not be ok, but it's a different problem.
a[foo] = console.log;
await (feelingBazyToday ? a["baz"] : a[foo])();
💻 Use Cases
- What do you want to use this for?
- What shortcomings exist with current approaches?
- What workarounds are you using in the meantime?
-
Improving DX in IDEs without compromising on runtime code. In particular it would help prevent errors everywhere a (future) module specifier string is decoupled from the dynamic import.
-
Dynamic imports have runtime effects. It's currently not possible to dereference a specifier before use (anywhere it might appear).
-
Either: Writing
typeof import(foo)(and deleting it again), when one wants to know (or navigate to) whatfoowould resolve to. This partially solves the problem, by effectively validating the string, but that information is lost. Or: A different architecture similar to the workaround in the motivating example. Also note, that the described feature can't be implemented in TS user land with things like utility types or type discrimination; so it's not merely sugar for existing functionality. Every workaround will lack a key aspect of the described feature.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
No se nombra ningún archivo fuente, prueba ni punto de entrada. Empieza revisando la sugerencia y los ejemplos motivadores, y después determina cómo un tipo module-specifier resoluble permitiría realizar comprobaciones y navegación sin cambiar el JavaScript emitido; el trabajo estaría terminado cuando existan un diseño decidido y el comportamiento correspondiente de type-checker e IDE.
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
- Necesita aclaración
- Aptitud para principiantes
- 25/100