Skip to content

Commit 82d7eed

Browse files
petrisorcoderabbitharjotgill
authored andcommitted
Fix language review
1 parent 9941a21 commit 82d7eed

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/integrations/ast-grep.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ By default, users can add AST-Grep rules by following these steps:
3030
1. Create a folder that keeps all the `custom-name` in your project directory.
3131
2. Add individual `.yaml` files for each AST-Grep rule within the `custom-name` folder.
3232
3. Ensure each `.yaml` file contains the necessary AST-Grep rule configurations.
33-
4. Ensure that all rules contains a `message` property, that is going to be used on the review process.
33+
4. Ensure that all rules contains a `message` property, that will be used in the review process.
3434
5. Add the `custom-name` folder to the `.code-rabbit.yml` file under `tools.ast_grep` configuration.
3535
```yaml
3636
#...
@@ -86,7 +86,7 @@ Atomic rule defines the most basic matching rule that determines whether one syn
8686
#### **Relational rule**
8787
Relational rule defines the relationship between two syntax nodes. There are four kinds of relational rule: `inside`, `has`, `follows` and `precedes`.
8888

89-
All four relational rules accept a sub rule object as their value. The sub rule will match the surrounding node while the relational rule itself will match the target node.
89+
All four relational rules accept a sub-rule object as their value. The sub-rule will match the surrounding node while the relational rule itself will match the target node.
9090

9191
> Official documentation guide on [Relational Rule](https://ast-grep.github.io/guide/rule-config/relational-rule.html)
9292

@@ -99,11 +99,11 @@ rule:
9999
```
100100

101101
#### **Composite rule**
102-
Composite rule defines the logical relationship between multiple sub rules. There are three kinds of composite rule: `all`, `any` and `not`.
102+
Composite rule defines the logical relationship between multiple sub-rules. There are three kinds of composite rule: `all`, `any` and `not`.
103103

104104
**all**
105105

106-
The `all` rule matches if all sub rules match.
106+
The `all` rule matches if all sub-rules match.
107107
```yaml
108108
rule:
109109
all:
@@ -113,7 +113,7 @@ rule:
113113

114114
**any**
115115

116-
`any` rule matches if any sub rule matches.
116+
`any` rule matches if any sub-rule matches.
117117
```yaml
118118
rule:
119119
any:
@@ -124,7 +124,7 @@ rule:
124124

125125
**not**
126126

127-
`not` applies negation to a sub rule. It matches if the sub rule does not match.
127+
`not` applies negation to a sub-rule. It matches if the sub-rule does not match.
128128

129129
```yaml
130130
rule:
@@ -203,7 +203,7 @@ rule:
203203

204204
CodeRabbit supports multiple programming languages for defining AST-Grep rules.
205205

206-
- Javascript
206+
- JavaScript
207207
- Typescript
208208
- C#
209209
- Golang
@@ -215,7 +215,7 @@ CodeRabbit supports multiple programming languages for defining AST-Grep rules.
215215

216216
Below are examples of AST-Grep rules in different languages:
217217

218-
### **Javascript**
218+
### **JavaScript**
219219
#### Importing files without an extension is not allowed
220220
```yaml
221221
id: find-import-file

0 commit comments

Comments
 (0)