Skip to content

Docs: Please specify propery type for ts.TransformerFactory in the entry-point and example #147

Open

Description

@bogeeee

In the readme, it says
(program: ts.Program, config: PluginConfig, extras: TransformerExtras) => ts.TransformerFactory
which is read as ts.TransformerFactory<any> but that's wrong imho because the type param / shouldn't be any

Also the example gives me a type error, when i try to specify it either via, what's in the readme

export default function(program: ts.Program, pluginConfig: PluginConfig, { ts: tsInstance }: TransformerExtras): (context: ts.TransformationContext) => (sourceFile: ts.SourceFile) => ts.SourceFile {
    ...
}

or via (taken from other projects):

export default function(program: ts.Program, pluginConfig: PluginConfig, { ts: tsInstance }: TransformerExtras): ts.TransformerFactory<ts.SourceFile> {
    ...
}

or as returning ts.TransformerFactory<ts.Node> ... nothing works.

So this is rather unclear for a new user, what type should be returned.
Thx !

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions