microsoft / microsoft/TypeScript
Add `import type "mod"`
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.4k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
Search Terms
type-only import
Suggestion
The new type-only import syntax supports most variations of import statement but not this one:
import type 'mod'
It may seem stupid because no type is actually imported?! But it's in fact useful if mod contains some global declarations that you need.
Global declarations are currently only imported from: typeroots (@types/* by default) or types configs; and referenced modules.
This syntax is even more useful because it can't be emulated today. If you do (EDIT: see triple-slash comment)import 'mod' then typing works but TS assumes you import the module for side-effects and will not erase it.
Use Cases
I encountered this today.
One package I use provides some dependency injection and basically defines the following module augmentation:
inject(x: 'myType'): MyType
which is a strongly typed overload of
inject<T = unknown>(x: string): T.
Inject itself comes from another library so code that wants to use this import needs to do this:
import { inject } from 'other-lib';
import type 'my-lib';
let my = inject('myType'); // correctly typed as MyType
Current work-arounds include:
- Importing a type
import { MyType } from 'my-lib'but if you don't use it in code it'll be a warning; - Import without type
import 'my-lib'but it won't be erased; Add this lib to(EDIT: not really working, see my comment below for an alternative solution.)typerootsortypesand do nothing (might be better in some cases).- Use
/// <reference types="mod" />, which works but I think most people have forgotten about? (I have 😜)
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
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
El issue propone admitir import type "mod" para cargar declaraciones globales sin emisión en tiempo de ejecución, con un ejemplo relacionado con la ampliación de módulos. El issue no identifica archivos de implementación ni tests, así que primero localiza los tests del parser de imports, de la comprobación de tipos y de la emisión; se considerará terminado cuando la sintaxis pase la comprobación de tipos y produzca la salida omitida prevista.
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
- 25/100