README.md

TypeScript Call Graph

This CLI will create an interactive graph of all the functions and their calls in the TypeScript files you provide.

⚠️ this is a work in progress 🚧 more visualizations are coming soon

How to use

npm install -g typescript-call-graph

Inside any directory, run:

tcg

It will remind you how to use the CLI: you need to provide specific files, or globs (wildcard paths):

tcg myFile.ts folder/* anotherFolder/**/*

Developing

Clone repository. Edit index.ts and/or extract.ts and run npm start to build changes, npm test to run CLI against files in this repository.

Suggestions or PRs for how to improve this CLI are very welcome 🙇

You may also edit this repository as you'd like and install your custom version of tcg command with npm run global

Thank you

• Matteo Abrate for the tangled tree visualization
• Mike Bostock for the arc diagram
• GraphViz, node-graphviz, and d3-graphviz for the simple graph
• Mermaid-JS for a way to create a graph
• Tutorial and code for processing TypeScript (AST)
• Tutorial for creating a CLI
• TS-Call-Graph for inspiration