Skip to content
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

Add ast-grep documentation page #21

Merged
merged 5 commits into from
Mar 12, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update coderabbig guide page with new coderabbit.yaml changes
  • Loading branch information
petrisorcoderabbit committed Mar 12, 2024
commit 72c2da72fb9e8f90e9c403452211e3e766ef1320
22 changes: 22 additions & 0 deletions docs/guides/customize-coderabbit.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ reviews:
base_branches:
- "develop"
- "feat/.*"
tools:
ast-grep:
rules_folder: "custom-rules-folder-name"
utils_folder: "custom-utils-folder-name"
chat:
auto_reply: true
```
Expand Down Expand Up @@ -110,6 +114,12 @@ Yaml settings:
`true`).
- **base_branches**: A list of base branches where the reviews will occur
apart from the default branch. Accepts regex pattern.
- **tools**: Configurations for the tools used in the review.
- **ast-grep**: Configurations for the ast-grep tool.
- **rules_folder**: The folder name where the custom ast-grep rules are
stored.
- **utils_folder**: The folder name where the custom ast-grep utils are
stored.
4. **chat**: Defines the behavior of CodeRabbit's bot in conversations.
- **auto_reply**: The bot automatically replies without the need of the user
tagging it ( default: `true` ).
Expand Down Expand Up @@ -154,6 +164,12 @@ settings:
collapse_walkthrough_comment: true
# Disable automatic code reviews for this repository.
disable_review: false
# External tools configurations
tools:
# tools configuration for ast-grep
ast-grep:
rules_folder: "custom-rules-folder-name"
utils_folder: "custom-utils-folder-name"
```

<!-- ![code](./images/ymlrabbit.png) -->
Expand Down Expand Up @@ -187,6 +203,12 @@ This configuration file consists of the following settings:
be posted.
13. **collapse_walkthrough_comment**: Specifies whether to collapse walkthrough
comments on the review.
14. **tools**: Configurations for the tools used in the review.
- **ast-grep**: Configurations for the ast-grep tool.
- **rules_folder**: The folder name where the custom ast-grep rules are
stored.
- **utils_folder**: The folder name where the custom ast-grep utils are
stored.

Refer:
[CodeRabbit configuration schema](https://coderabbit.ai/integrations/coderabbit-overrides.json).
Expand Down