Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[doc] Add a diagram to explain how ast-grep works #313

Closed
HerringtonDarkholme opened this issue May 16, 2023 · 7 comments
Closed

[doc] Add a diagram to explain how ast-grep works #313

HerringtonDarkholme opened this issue May 16, 2023 · 7 comments
Assignees
@HerringtonDarkholme
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@HerringtonDarkholme
Copy link
Member

Not everyone is familiar with tree-sitter, it is worth a diagram to explain ast-grep is using tree-sitter to parse code to a CST tree.

Also, the diagram can show the three way to use the software: pattern/yaml/api.
And the three main usages of the program: search/lint/rewrite.
@HerringtonDarkholme HerringtonDarkholme added documentation Improvements or additions to documentation enhancement New feature or request labels May 16, 2023
@HerringtonDarkholme HerringtonDarkholme self-assigned this May 16, 2023
@HerringtonDarkholme
Copy link
Member Author

Gogocode has a good example of diagram
https://gogocode.io/en/docs/specification/basic

@HerringtonDarkholme
Copy link
Member Author

HerringtonDarkholme commented May 16, 2023 •
edited

Ideally I can incorporate scrolling into the animation.
https://twitter.com/jh3yy/status/1658554036562415616

@suyanhanx
Copy link
Member

Looking forward to seeing it.

@HerringtonDarkholme
Copy link
Member Author

This mermaid plugin might be very helpful.
https://emersonbottero.github.io/vitepress-plugin-mermaid/

@suyanhanx
Copy link
Member

https://asciiflow.com/

This is a very simple helpful tool.

@HerringtonDarkholme
Copy link
Member Author

Something like this
https://www.codeshiftcommunity.com/docs/understanding-asts/

@HerringtonDarkholme HerringtonDarkholme transferred this issue from ast-grep/ast-grep Dec 24, 2023
@HerringtonDarkholme
Copy link
Member Author

HerringtonDarkholme commented Jun 6, 2024 •
edited

image
https://x.com/hd_nvim/status/1774670661438599398

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@HerringtonDarkholme HerringtonDarkholme

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@HerringtonDarkholme @suyanhanx