JSPM

typescript-ast-explorer

0.0.5
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3
  • Score
    100M100P100Q22416F
  • License MIT

Command line tool to explore TypeScript projects and SourceFile abstract syntax tree interactively

Package Exports

  • typescript-ast-explorer

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (typescript-ast-explorer) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

typescript-ast-explorer

Contents

Summary

  • Demo screen casts
  • Explore a local TypeScript project with an Command Line interactive tool.
  • Navigate through the AST nodes and source code at same time
  • See it file structure and the AST nodes inside each file.
  • JavaScript / TypeScript API for GUI component to select files/folders/nodes interactively (based on blessed/accursed/ts-morph)

Install

npm install -g typescript-ast-explorer

Usage

cd my/typescript/project
typescript-ast-explorer

Options

No options - WIP - it's mostly an interactive tool

TODO

  • --tsConfigPath - to load a ts project other then current folder's
  • use accursed and remove a lots of files.
  • API to reuse as AST node selector - project file / folder selector
  • query elements across the project using CSS-like language (tsquery)
  • filter nodes by kind or name or query
  • apply refactors interactively
  • tree expand all - collapse all
  • move the tree to its own file
  • stateful modal, selections, expansions, etc
  • show errors except in modals
  • navigate with arrows 2-d instead of tab only (1-d)
  • a general option/menu to hide boxes - or perhaps a halo on them to collapse ?
  • confirmation before exit
  • move blessed reusable utilities to their own package
  • in file view - remove details parent and leave the children only.
  • should we add the code view in the file view?
  • currently, because of custom .d.ts, the project needs to declare the types in its own ts.config.json
  • file view: expand first folder automatically.
  • when switching from files view to code view it should open in last viewed node and vice versa - auto-expanding the tree