Skip to content

Commit 72e1d97

Browse files
feat: semgrep (#98)
1 parent e0b9768 commit 72e1d97

File tree

2 files changed

+64
-0
lines changed

2 files changed

+64
-0
lines changed

docs/tools/semgrep.md

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
title: Semgrep
3+
sidebar_label: Semgrep
4+
description: CodeRabbit's guide to Semgrep.
5+
---
6+
7+
[Semgrep](https://semgrep.dev/) is a static analysis tool designed to scan code for security vulnerabilities and code quality issues..
8+
9+
## Files
10+
11+
Semgrep will run on the following files and extensions:
12+
13+
- `Apex`
14+
- `Bash`
15+
- `.c`
16+
- `.cpp`
17+
- `.cs`
18+
- `.clj`
19+
- `.dart`
20+
- `Dockerfile`
21+
- `.ex`
22+
- `.html`
23+
- `.go`
24+
- `.java`
25+
- `.js`
26+
- `.jsx`
27+
- `.json`
28+
- `.jl`
29+
- `.jsonnet`
30+
- `.kt`
31+
- `.kts`
32+
- `Lisp`
33+
- `.lua`
34+
- `.ml`
35+
- `.php`
36+
- `.py`
37+
- `.r`
38+
- `.rb`
39+
- `.rs`
40+
- `.scala`
41+
- `Scheme`
42+
- `.sol`
43+
- `.swift`
44+
- `.tf`
45+
- `.ts`
46+
- `.tsx`
47+
- `.yaml`
48+
- `.xml`
49+
- `ERB`
50+
- `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)

docs/tools/tools.md

+2
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ Remove extraneous f prefix
6060
| Python | [Ruff][Ruff] |
6161
| Regal | [Regal][Regal] |
6262
| Ruby | [Rubocop][Rubocop] |
63+
| Semgrep | [Semgrep][Semgrep] |
6364
| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] |
6465
| Swift | [SwiftLint][SwiftLint] |
6566
| Terraform | [Checkov][Checkov] |
@@ -87,4 +88,5 @@ Remove extraneous f prefix
8788
[PMD]: ./pmd.md
8889
[Cppcheck]: ./cppcheck.md
8990
[CircleCi]: ./circleci.md
91+
[Semgrep]: ./semgrep.md
9092

0 commit comments

Comments
 (0)