8000 updateschemaexample (#31) · coderabbitai/coderabbit-docs@dd26db6 · GitHub
[go: up one dir, main page]

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit dd26db6

Browse files
authored
updateschemaexample (#31)
* updateschemaexample * Update customize-coderabbit.md
1 parent 9b24fbe commit dd26db6

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

docs/guides/customize-coderabbit.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,13 @@ reviews:
5555
- "feat/.*"
5656
tools:
5757
ast-grep:
58-
rules_directory: "custom-rules-directory-name"
59-
utils_directory: "custom-utils-directory-name"
58+
rule_dirs:
59+
- "rules"
60+
util_dirs:
61+
- "utils"
62+
packages:
63+
- "ast-grep-essentials"
64+
- "my-awesome-org/my-awesome-package" # public repository that contains ast-grep
6065
chat:
6166
auto_reply: true
6267
```
@@ -105,10 +110,11 @@ YAML settings:
105110
apart from the default branch. Accepts regex pattern.
106111
- **`tools`**: Configurations for the tools used in the review.
107112
- **`ast-grep`**: Configurations for the `ast-grep` tool.
108-
- **`rules_directory`**: The directory name where the custom `ast-grep`
113+
- **`rule_dirs`**: The directory name where the custom `ast-grep`
109114
rules are stored.
110-
- **`utils_directory`**: The directory name where the custom `ast-grep`
115+
- **`util_dirs`**: The directory name where the custom `ast-grep`
111116
utils are stored.
117+
- **`packages`**: A package allows you to share rules across multiple projects. Essentially, a package is a collection of `ast-grep` rules.
112118
4. **`chat`**: Defines the behavior of CodeRabbit's bot in conversations.
113119
- **`auto_reply`**: The bot automatically replies without the need of the
114120
user tagging it (default: `true`).
@@ -155,11 +161,7 @@ settings:
155161
# Disable automatic code reviews for this repository.
156162
disable_review: false
157163
# External tools configurations
158-
tools:
159-
# tools configuration for ast-grep
160-
ast-grep:
161-
rules_directory: "custom-rules-directory-name"
162-
utils_directory: "custom-utils-directory-name"
164+
163165
```
164166

165167
This configuration file consists of the following settings:
@@ -191,12 +193,7 @@ This configuration file consists of the following settings:
191193
be posted.
192194
13. **`collapse_walkthrough_comment`**: Specifies whether to collapse
193195
walkthrough comments on the review.
194-
14. **`tools`**: Configurations for the tools used in the review.
195-
- **`ast-grep`**: Configurations for the `ast-grep` tool.
196-
- **`rules_directory`**: The directory name where the custom `ast-grep`
197-
rules are stored.
198-
- **`utils_directory`**: The directory name where the custom `ast-grep`
199-
utils are stored.
196+
200197

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

0 commit comments

Comments
 (0)
0