https://github.com/buehler/node-typescript-parser

Parser for typescript (and javascript) files, that compiles those files and generates a human understandable AST.
https://github.com/buehler/node-typescript-parser

ast ecmascript parser parsing typescript typescript-parser

Last synced: 4 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/buehler/node-typescript-parser
• Owner: buehler
• License: mit
• Created: 2017-06-21T06:57:48.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-04-15T10:04:44.000Z (9 months ago)
• Last Synced: 2024-05-11T21:20:54.987Z (8 months ago)
• Topics: ast, ecmascript, parser, parsing, typescript, typescript-parser
• Language: TypeScript
• Homepage:
• Size: 618 KB
• Stars: 141
• Watchers: 3
• Forks: 46
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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.

[![Build Status](https://travis-ci.org/buehler/node-typescript-parser.svg)](https://travis-ci.org/buehler/node-typescript-parser)

[![Build Status Windows](https://ci.appveyor.com/api/projects/status/j06bqjc4tkdt7sej?svg=true)](https://ci.appveyor.com/project/buehler/node-typescript-parser)

[![npm](https://img.shields.io/npm/v/typescript-parser.svg?maxAge=3600)](https://www.npmjs.com/package/typescript-parser)

[![codecov](https://codecov.io/gh/buehler/node-typescript-parser/branch/master/graph/badge.svg)](https://codecov.io/gh/buehler/node-typescript-parser)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![Greenkeeper badge](https://badges.greenkeeper.io/buehler/node-typescript-parser.svg)](https://greenkeeper.io/)

[![Gitter](https://img.shields.io/gitter/room/node-typescript-parser/Lobby.svg)](https://gitter.im/node-typescript-parser/Lobby)

## How to use

After you install the package via:

[![NPM](https://nodei.co/npm/typescript-parser.png?downloads=true&stars=true)](https://nodei.co/npm/typescript-parser/)

### [View Source Docs](https://buehler.github.io/node-typescript-parser/)

You can use the parser with:

```typescript

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](https://github.com/semantic-release/semantic-release) and is located under the

[release section](https://github.com/buehler/node-typescript-parser/releases).

## Licence

This software is licenced under the [MIT](LICENSE) licence.