Skip to content

fix(docs): Update lspconfig setup snippet #728

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

Conversation

mrjones2014
Copy link
Contributor

@mrjones2014 mrjones2014 commented Apr 10, 2025

The current snippet is a little confusing and doesn't work if you just copy/paste it. This updates the snippet to be fully copy/paste-able to work out of the box and be a little bit more clear when reading it.

Summary by CodeRabbit

  • New Features
    • Broadened language support with the addition of a supported filetypes list.
    • Enhanced project detection by accepting multiple configuration file formats.
  • Refactor
    • Streamlined the tool configuration process for a more consistent and simplified integration.

Copy link

coderabbitai bot commented Apr 10, 2025

Walkthrough

This change refactors the Neovim LSP configuration for ast-grep within the documentation. The previous local variable approach has been replaced by a direct call to the setup method on the lspconfig.ast_grep module. Key modifications include removing the single_file_support option, updating the root_dir to use a more flexible root pattern function that supports both sgconfig.yaml and sgconfig.yml, and adding a new filetypes parameter.

Changes

File(s) Change Summary
website/guide/tools/editors.md Refactored Neovim LSP ast-grep configuration: replaced configs.ast_grep with direct setup method call; removed single_file_support; updated root_dir using root_pattern; added filetypes parameter.

Sequence Diagram(s)

sequenceDiagram
    participant E as Editor/Neovim
    participant L as lspconfig.ast_grep
    participant U as lspconfig.util

    E->>L: Call setup({...})
    L->>U: Use root_pattern(["sgconfig.yaml", "sgconfig.yml"])
    U-->>L: Return project root path
    L-->>E: Apply LSP configuration with filetypes and cmd parameters
Loading

Poem

In a burrow of code, the changes did start,
I hopped through the config with a bright, updated heart.
No more local vars cluttering my space,
Direct setup now wins the race.
With new roots and filetypes so neat,
This rabbit's code now skips with a beat!
🥕🚀


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3cf8edf and 2e324cc.

📒 Files selected for processing (1)
  • website/guide/tools/editors.md (1 hunks)
🔇 Additional comments (1)
website/guide/tools/editors.md (1)

98-106: Enhanced Neovim LSP configuration snippet is clear and functional.

The new snippet directly calls require('lspconfig').ast_grep.setup({...}), which simplifies the configuration process and avoids potential confusion from using intermediary local variables. The update removes the unnecessary single_file_support, introduces an explicit filetypes list for supported languages, and improves root directory detection by accepting both sgconfig.yaml and sgconfig.yml. This aligns well with the PR objectives of enhancing clarity and ensuring the snippet works out-of-the-box.


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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@HerringtonDarkholme HerringtonDarkholme added this pull request to the merge queue Apr 10, 2025
Merged via the queue into ast-grep:main with commit 754f0d1 Apr 10, 2025
1 check passed
@mrjones2014 mrjones2014 deleted the mrj/fix-nvim-instructions branch April 10, 2025 18:21
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