microsoft / microsoft/TypeScript
Add `import type "mod"`
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.3k
- Merge moyen
- 2 j 4 h
- PR mergées (30 j)
- 132
Description
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.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
L’issue propose de prendre en charge import type "mod" pour charger des déclarations globales sans émission à l’exécution, avec un exemple impliquant une augmentation de module. Aucun fichier d’implémentation ni test n’est identifié dans l’issue ; commencez donc par localiser les tests du parseur d’imports, de la vérification des types et de l’émission ; le travail sera considéré comme terminé lorsque la syntaxe passera la vérification des types et produira la sortie effacée attendue.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- compilers
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 25/100