AST generator

This script creates Abstract Syntax Tree (AST) of all the files for supported languages in JSON format. AST is created by using the bundled babel parser (for JavaScript, TypeScript) or by invoking appropriate external tools (See table below).

Supported languages

| Language | Tool used | | ---------- | --------------------------- | | Bash | shfmt (cli) | | JavaScript | babel | | TypeScript | babel | | Vue | vue-template-compiler | | Svelte | svelte/compiler | | JSX | babel | | TSX | babel | | Dockerfile | dockerfile-ast | | Yaml | yaml-language-server-parser | | markdown | mdast-util-from-markdown | | xml | xast-util-from-xml | | html | hast-util-to-xast | | svg | hast-util-to-xast |

Usage

Installing

sudo npm install -g @joernio/astgen

Getting Help

bin/astgen -h
Options:
  -v, --version  Print version number                                  [boolean]
  -i, --src      Source directory                                 [default: "."]
  -o, --output   Output directory for generated AST json files
                                                            [default: "ast_out"]
  -t, --type     Project type. Default auto-detect
  -r, --recurse  Recurse mode suitable for mono-repos  [boolean] [default: true]
  -h             Show help                                             [boolean]

Example

Navigate to the project and run astgen command.

cd <path to project>
astgen

To specify the project type and the path to the project.

astgen -t nodejs -i <path to project>
astgen -t vue -i <path containing .vue files>

Troubleshooting

shfmt is bundled with astgen and should work for linux amd64. When using astgen on any other platform and architecture, please download and place the cli in the PATH.

ESM only

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.