Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs(editors): add emacs and ast-grep.el #762

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.

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

Merged
merged 1 commit into from
Jun 26, 2025

Conversation

SunskyXH
Copy link
Contributor

@SunskyXH SunskyXH commented Jun 26, 2025

Add document about using ast-grep in emacs.

Summary by CodeRabbit

  • Documentation
    • Added a new section detailing Emacs editor integration, including installation and usage instructions for the ast-grep.el package.

Copy link

coderabbitai bot commented Jun 26, 2025

Walkthrough

A new Emacs integration section was added to the editor integration guide, detailing how to use the ast-grep.el package for code searching. The section provides installation instructions for both straight.el and Doom Emacs users. No other content or functionality was changed.

Changes

File Change Summary
website/guide/tools/editors.md Added Emacs integration section with ast-grep.el usage and installation instructions for two package managers.

Poem

In the warren of code, a new path appears,
Emacs joins the search, let’s all give three cheers!
With ast-grep.el at your nimble command,
Find patterns in code across all rabbit land.
Straight or with Doom, install and delight—
Editor bunnies, hop searching tonight!
🐇✨


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
website/guide/tools/editors.md (1)

144-156: Minor wording & Elisp-snippet nits

  1. Capitalise “Emacs” consistently.
  2. The straight-recipe symbol should match the package name (ast-grep.elast-grep).
  3. Doom’s package! form typically starts with a keyword list; quoting the symbol is unnecessary.
-[ast-grep.el](https://github.com/SunskyXH/ast-grep.el) is an emacs package for searching code using ast-grep with completing-read interface or consult.
+[ast-grep.el](https://github.com/SunskyXH/ast-grep.el) is an Emacs package for searching code using ast-grep with a completing-read interface or *consult*.

 ```elisp
-(straight-use-package '(ast-grep :type git :host github :repo "SunskyXH/ast-grep.el"))
+(straight-use-package '(ast-grep :type git :host github :repo "SunskyXH/ast-grep.el"))

-Or if you are using doomemacs, add to your packages.el
+Or, if you are using Doom Emacs, add to your packages.el:

-(package! ast-grep :recipe (:host github :repo "SunskyXH/ast-grep.el"))
+(package! ast-grep :recipe (:host github :repo "SunskyXH/ast-grep.el"))

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used: CodeRabbit UI**
**Review profile: CHILL**
**Plan: Pro**


<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 4321992044fb91fd0b99f8a77da0f3e230b443ba and f3281d7b740df0151d903716ac00fa6078d7bf16.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* `website/guide/tools/editors.md` (1 hunks)

</details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

@HerringtonDarkholme
Copy link
Member

Thanks!

@HerringtonDarkholme HerringtonDarkholme added this pull request to the merge queue Jun 26, 2025
Merged via the queue into ast-grep:main with commit 2c7957d Jun 26, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants