microsoft / microsoft/TypeScript

Include CompilerHost in TransformationContext

Ouverte
#37,754 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

In Discussion Suggestion
Langage dominant
Go
Étoiles
111k
Forks
14.3k
Merge moyen
2 j 4 h
PR mergées (30 j)
132

Description

Search Terms

compiler host, CompilerHost,
transformation context, TransformationContext,
transformer, custom transformer

Suggestion

I'd like to access the CompilerHost instance from my custom transformers (via TransformationContext).

As far as I can see this wouldn't expose any "risky" patterns like #25147.

Use Cases

My specific use-case is resolving import declarations. This can be done using ts.resolveModuleName (https://github.com/microsoft/TypeScript/issues/28276#issuecomment-435016356), but this requires a CompilerHost instance.

Example

An example for my specific use-case would be:

const transformer: ts.TransformerFactory<ts.SourceFile> = context => {
    return file => {
        return ts.visitEachChild(
            file,
            node => {
                if (ts.isImportDeclaration(node)) {
                    const resolved = ts.resolveModuleName(
                        (node.moduleSpecifier as ts.StringLiteral).text,
                        file.fileName,
                        context.getCompilerOptions(),
                        context.getCompilerHost() // this is currently impossible
                    )
                    
                    // do something interesting with resolved
                }
                return node;
            },
            context
        )
    }
}

Workaround

Luckily there is a workaround for this:

const host = ts.createCompilerHost(context.getCompilerOptions());

But this feels redundant and somewhat "wrong".

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

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par les API de TransformationContext et de CompilerHost, puis suivez la manière dont les transformateurs personnalisés reçoivent le contexte et dont ts.resolveModuleName utilise un host. Définissez la forme prévue de l’API et vérifiez sa compatibilité avec les transformateurs existants. Le travail est terminé lorsqu’un transformateur peut accéder au CompilerHost pertinent pour la résolution des modules sans créer de host redondant.

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

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.