Skip to content

mightytroll/ts-ast-parser

 
 

Repository files navigation

TypeScript Abstract Syntax Tree Parser


License: MIT TypeScript Maintainability Rating codecov Build and Test Workflow


Website   •   Playground

This project is still in beta until we reach version 1.0.0. There could be breaking changes between minor versions.

What it is

Simplifies the TypeScript AST generated from the TypeScript compiler.

Features

Reflects the following declarations:

  • Import declarations
  • Export declarations
  • Function declarations
  • Variable declarations
  • Interface declarations
  • Type Alias declarations
  • Enum declarations
  • JSDoc
  • Class declarations
  • Decorators
  • Inheritance
  • Mixins (coming soon)
  • Custom elements (coming soon)

Supported output formats:

  • JSON

Projects in this monorepo

Name Version Description
@ts-ast-parser/core @ts-ast-parser/core Reads the TS Compiler AST and outputs a simplified version of it
@ts-ast-parser/readers @ts-ast-parser/readers Helps to read and search the reflected AST.

Documentation

Documentation is available on the website

Contributing

See CONTRIBUTING.md for more information.

About

Simplifies the TypeScript AST for generating documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 94.8%
  • JavaScript 4.6%
  • Shell 0.6%