You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 16, 2025. It is now read-only.
- **`ignore_title_keywords`**: Review will be ignored if a pull request
96
97
title contains one of the list of keywords (case-insensitive). Example:
@@ -102,13 +103,14 @@ YAML settings:
102
103
- **`base_branches`**: A list of base branches for which the reviews will
103
104
trigger, apart from the default branch. Accepts regex pattern. Example:
104
105
105
-
```yaml
106
-
base_branches:
107
-
- "develop"
108
-
- "feat/.*"
109
-
```
106
+
```yaml
107
+
base_branches:
108
+
- "develop"
109
+
- "feat/.*"
110
+
```
110
111
111
112
- **`tools`**: Configurations for the tools used in the review.
113
+
112
114
- **`ast-grep`**: Configurations for the `ast-grep` tool.
113
115
- **`rule_dirs`**: The directory name where the custom `ast-grep` rules
114
116
are stored.
@@ -118,47 +120,53 @@ YAML settings:
118
120
projects. Essentially, a package is a collection of `ast-grep` rules.
119
121
- **`github-checks`**: Configuration for GitHub Checks integration.
120
122
- **`enabled`**: Enable integration, defaults to true.
121
-
- **`timeout_ms`**: Time in milliseconds to wait for all GitHub Checks to conclude, defaults to 90000 (1.5 minutes), maximum is 300000 (5 minutes), minimum is 0 (no timeout).
123
+
- **`timeout_ms`**: Time in milliseconds to wait for all GitHub Checks to
124
+
conclude, defaults to 90000 (1.5 minutes), maximum is 300000 (5
125
+
minutes), minimum is 0 (no timeout).
122
126
- **`markdownlint`**: Configuration for `markdownlint` integration.
123
127
- **`enabled`**: Enable integration, defaults to true.
124
128
- **`ruff`**: Configuration for `ruff` integration.
125
129
- **`enabled`**: Enable integration, defaults to true.
126
130
- **`shellcheck`**: Configuration for `shellcheck` integration.
127
131
- **`enabled`**: Enable integration, defaults to true.
128
132
- **`languagetool`**: Configuration for `languagetool` integration.
133
+
129
134
- **`enabled`**: Enable integration, defaults to true.
130
-
- **`level`**: The level of the rule. Can be one `default` or `picky`. If set to `picky`, additional rules will be activated, i.e. rules that you might only find useful when checking formal text.
131
-
- **`enabled_rules`**: IDs of rules to be enabled. The rule won't run unless 'level' is set to a level that activates the rule.
135
+
- **`level`**: The level of the rule. Can be one `default` or `picky`. If
136
+
set to `picky`, additional rules will be activated, i.e. rules that you
137
+
might only find useful when checking formal text.
138
+
- **`enabled_rules`**: IDs of rules to be enabled. The rule won't run
139
+
unless 'level' is set to a level that activates the rule.
132
140
- **`disabled_rules`**: IDs of rules to be disabled.
133
141
- **`enabled_categories`**: IDs of categories to be enabled.
134
142
- **`disabled_categories`**: IDs of categories to be disabled.
135
-
- **`enabled_only`**: Only the rules and categories whose IDs are specified with `enabled_rules` or `enabled_categories` are enabled.
143
+
- **`enabled_only`**: Only the rules and categories whose IDs are
144
+
specified with `enabled_rules` or `enabled_categories` are enabled.
136
145
137
146
```yaml
138
-
ast-grep:
139
-
rule_dirs:
140
-
- "rules"
141
-
util_dirs:
142
-
- "utils"
143
-
packages:
144
-
- "ast-grep-essentials"
145
-
- "my-awesome-org/my-awesome-package" # public GitHub repository that contains ast-grep rules
146
-
github-checks:
147
-
enabled: true
148
-
timeout_ms: 90000
149
-
markdownlint:
150
-
enabled: true
151
-
ruff:
152
-
enabled: true
153
-
shellcheck:
154
-
enabled: true
155
-
languagetool:
156
-
enabled: true
157
-
enabled_only: false
158
-
level: default
159
-
enabled_categories:
160
-
- "TON_ACADEMIC"
161
-
- "CASING"
147
+
ast-grep:
148
+
rule_dirs:
149
+
- "rules"
150
+
util_dirs:
151
+
- "utils"
152
+
packages:
153
+
- "my-awesome-org/my-awesome-package" # public GitHub repository that contains ast-grep rules
154
+
github-checks:
155
+
enabled: true
156
+
timeout_ms: 90000
157
+
markdownlint:
158
+
enabled: true
159
+
ruff:
160
+
enabled: true
161
+
shellcheck:
162
+
enabled: true
163
+
languagetool:
164
+
enabled: true
165
+
enabled_only: false
166
+
level: default
167
+
enabled_categories:
168
+
- "TON_ACADEMIC"
169
+
- "CASING"
162
170
```
163
171
164
172
5. **`chat`**:Defines the behavior of CodeRabbit's bot in conversations.