fabianwildgrube / node-typescript-parser

Parser for typescript (and javascript) files, that compiles those files and generates a human understandable AST.

Fork of node-typescript-parser

This fork adds that the decorators of properties of a class are now also analyzed and added to the AST that node-typescript-parser creates.

To ensure that this fork can be used as a npm dependency directly from github, make sure to run npm build and commit the built resources for every code update!

The following is the original project description:

node typescript parser

This package is a TypeScript and ECMAScript parser. It uses the underlying typescript parser to generate a more or less human readable AST out of .js or .ts files.

How to use

After you install the package via:

View Source Docs

You can use the parser with:

const parser = new TypescriptParser();

// either:
const parsed = await parser.parseSource(/* typescript source code as string */);

// or a filepath
const parsed = await parser.parseFile('/user/myfile.ts', 'workspace root');

You can also parse multiple files at ones.

To use the declaration index (which is basically a list of symbols for your files) instantiate an index first and throw him some files.

After the parsing is done, you'll get an index with resolved exports and declarations.

Keep in mind, that the index'll only contain exported declarations.

Changelog

The changelog is generated by semantic release and is located under the release section.

Licence

This software is licenced under the MIT licence.