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

Add ast-grep documentation page #21

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f1eaec1
Add ast-grep documentation page
petrisorcoderabbit Mar 8, 2024
fc4ac62
Update the ast-grep documentation to include the coderabbit config fi…
petrisorcoderabbit Mar 8, 2024
eec460d
Fix language review
petrisorcoderabbit Mar 11, 2024
7d868b1
Update coderabbit.yaml schema for ast-grep tool naming
petrisorcoderabbit Mar 12, 2024
72c2da7
Update coderabbig guide page with new coderabbit.yaml changes
petrisorcoderabbit Mar 12, 2024
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
Next Next commit
Fix language review
  • Loading branch information
@petrisorcoderabbit
petrisorcoderabbit committed Mar 11, 2024
commit eec460dd1d8abf61218bbe6eadcb0a6b823223cd
16 changes: 8 additions & 8 deletions docs/integrations/ast-grep.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ By default, users can add AST-Grep rules by following these steps:
1. Create a folder that keeps all the `custom-name` in your project directory.
2. Add individual `.yaml` files for each AST-Grep rule within the `custom-name` folder.
3. Ensure each `.yaml` file contains the necessary AST-Grep rule configurations.
4. Ensure that all rules contains a `message` property, that is going to be used on the review process.
4. Ensure that all rules contains a `message` property, that will be used in the review process.
5. Add the `custom-name` folder to the `.code-rabbit.yml` file under `tools.ast_grep` configuration.
```yaml
#...
Expand Down Expand Up @@ -86,7 +86,7 @@ Atomic rule defines the most basic matching rule that determines whether one syn
#### **Relational rule**
Relational rule defines the relationship between two syntax nodes. There are four kinds of relational rule: `inside`, `has`, `follows` and `precedes`.

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.
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.

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

Expand All @@ -99,11 +99,11 @@ rule:
```

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

**all**

The `all` rule matches if all sub rules match.
The `all` rule matches if all sub-rules match.
```yaml
rule:
all:
Expand All @@ -113,7 +113,7 @@ rule:

**any**

`any` rule matches if any sub rule matches.
`any` rule matches if any sub-rule matches.
```yaml
rule:
any:
Expand All @@ -124,7 +124,7 @@ rule:

**not**

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

```yaml
rule:
Expand Down Expand Up @@ -203,7 +203,7 @@ rule:

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

- Javascript
- JavaScript
- Typescript
- C#
- Golang
Expand All @@ -215,7 +215,7 @@ CodeRabbit supports multiple programming languages for defining AST-Grep rules.

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

### **Javascript**
### **JavaScript**
#### Importing files without an extension is not allowed
```yaml
id: find-import-file
Expand Down