KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #ai-agent #developer-tools #claude-code #codex #deepseek-harness #ai-agents #cli #react #mcp

grep-ast

★ 40 Open GitHub ↗

CLI tool to grep files for AST patterns using css-like selector strings

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# grep-ast

CLI tool that searches your codebase for AST patterns using [equivalent-exchange](https://github.com/suchipi/equivalent-exchange/) and [esquery](https://github.com/estools/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](https://estools.github.io/esquery/).

To get an idea of the AST format you need to grep over, you can use [AST Explorer](https://astexplorer.net/). To match the default parser and parser options for grep-ast, choose JavaScript, `@babel/parser`, and then press the gear next to `@babel/parser` 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]
  --pattern        Glob pattern matching which files to look in. Defaults to
                   './**/*.{c,m,}{j,t}s{,x}'.  Use flag more than once to
                   provide more than one glob pattern.                  [string]
  --ignore         Glob pattern to ignore (gets prefixed with '!'). Use flag
                   more than once to provide more than one ignore
                   pattern.                                             [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 export a parse function. Defaults to
                   'equivalent-exchange'.                               [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

grep-ast

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README