grep-ast

CLI tool that searches your codebase for AST patterns using @babel-parser and esquery.

Usage

``sh


For example, to find all module.exports = :

npx grep-ast 'AssignmentExpression > MemberExpression[object.name=module][property.name=exports]'

Or to find all dynamic requires:

npx grep-ast 'CallExpression[callee.name=require]:not([arguments.0.type=StringLiteral])'
`

To quickly test your query syntax, you can use esquery's live demo app.

To get an idea of the AST format you need to grep over, you can use AST Explorer. To match the default parser and parser options for grep-ast, choose JavaScript, babylon7, and then press the gear next to babylon7 to open its settings, and uncheck "estree".

CLI Options

`
Options:
--help Show help [boolean]
--version Show version number [boolean]
--selector CSS-like selector string to search AST for [string]
--patterns Space-separated list of glob patterns matching which files to
look in. Defaults to './*/.{js,jsx}'. [string]
--ignore Comma-separated list of glob patterns to ignore [string]
--gitignore Whether to omit files listed in your .gitignore file(s).
Defaults to 'true'. [boolean] [default: true]
--encoding The encoding to read your files as. Defaults to 'utf-8'.
[string]
--parser The name of a parser module to use to parse your files. It
should have a parse function on it. Defaults to
'@babel/parser'. [string]
--parserOptions Options to pass to your parser's parse function, encoded as a
JSON string. [string]
--getLoc Function that receives an AST node and returns an object
describing the node's location. Defaults to 'node =>
node.loc'. [string]
``

License

MIT