JosePedroDias / ts-ast

TS-AST

A little experiment to traverse typescript source code ASTs to find issues. I may eventually port this to the eslint parser used by eslint, though I like the very few dependencies and the types I get using the typescript package directly.

usage

npm run build
npm run run-single -- <root of the source code of 1 project>
npm run run-bulk -- <root project A> <root project B> ... <root project N>

It will run the rules defined in config.ts. You can make use of the context object to compute stats and cluster errors

Example output:

 ./src/parse.ts

import
 - promisify
from "util"

import
 - _glob as glob
from "glob"

import
 - Program
 - createProgram
 - forEachChild
 - Node
from "typescript"

import
from "chalk"

import
 - importStatements as onNode
from "./rules/importStatements"

import
 - importStatementsWithoutDist as onNode
from "./rules/importStatementsWithoutDist"

inspiration and reference

• https://satellytes.com/blog/post/typescript-ast-type-checker/
• https://nabeelvalley.co.za/docs/javascript/typescript-ast/
• https://www.typescriptlang.org/tsconfig
• https://github.com/isaacs/node-glob#glob-primer
• https://ts-ast-viewer.com/#
• https://astexplorer.net