Skip to content

Commit 53d3c60

Browse files
update semgrep config with full details
1 parent d96fea2 commit 53d3c60

File tree

1 file changed

+26
-16
lines changed

1 file changed

+26
-16
lines changed

docs/tools/semgrep.md

+26-16
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,43 @@ sidebar_label: Semgrep
44
description: CodeRabbit's guide to Semgrep.
55
---
66

7-
[Semgrep](https://semgrep.dev/) is a static analysis tool designed to scan code for security vulnerabilities and code quality issues..
7+
[Semgrep](https://semgrep.dev/) is a static analysis tool designed to scan code
8+
for security vulnerabilities and code quality issues.
9+
10+
## Configuration
11+
12+
Semgrep uses a YAML style configuration file.
13+
14+
> Due to licensing it doesn't ship with the
15+
> [community-created Semgrep rules](https://github.com/returntocorp/semgrep-rules),
16+
> but you're free to use these in your own project.
17+
18+
Semgrep supports the following config files:
19+
20+
- User-defined config file set at `reviews.tools.semgrep.config_file` in your
21+
project's `.coderabbit.yaml` file or setting the "Review → Tools → Semgrep →
22+
Config File" field in CodeRabbit's settings page.
23+
24+
> **NOTE: If you do not set a config file in your `.coderabbit.yaml` or config
25+
> UI then semgrep will not be run.**
26+
27+
## Links
28+
29+
- [Semgrep Cli Reference](https://semgrep.dev/docs/cli-reference)
830

931
## Files
1032

1133
Semgrep will run on the following files and extensions:
1234

1335
- `Apex`
14-
- `Bash`
36+
- `Bash`
1537
- `.c`
1638
- `.cpp`
1739
- `.cs`
1840
- `.clj`
1941
- `.dart`
2042
- `Dockerfile`
21-
- `.ex`
43+
- `.ex`
2244
- `.html`
2345
- `.go`
2446
- `.java`
@@ -36,7 +58,7 @@ Semgrep will run on the following files and extensions:
3658
- `.py`
3759
- `.r`
3860
- `.rb`
39-
- `.rs`
61+
- `.rs`
4062
- `.scala`
4163
- `Scheme`
4264
- `.sol`
@@ -48,15 +70,3 @@ Semgrep will run on the following files and extensions:
4870
- `.xml`
4971
- `ERB`
5072
- `Jinja`
51-
52-
## Configuration
53-
54-
Semgrep uses a YAML style configuration file.
55-
56-
Semgrep supports the following config files:
57-
58-
- User-defined config file set at `reviews.tools.semgrep.config_file` in your project's `.coderabbit.yaml` file or setting the "Review → Tools → Semgrep → Config File" field in CodeRabbit's settings page.
59-
60-
## Links
61-
62-
- [Semgrep Cli Reference](https://semgrep.dev/docs/cli-reference)

0 commit comments

Comments
 (0)