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
Copy file name to clipboardExpand all lines: docs/tools/semgrep.md
+25-46
Original file line number
Diff line number
Diff line change
@@ -10,14 +10,13 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
10
10
<ProPlanNotice />
11
11
```
12
12
13
-
[Semgrep](https://semgrep.dev/) is a static analysis tool designed to scan code
14
-
for security vulnerabilities and code quality issues.
13
+
[Semgrep](https://github.com/semgrep/semgrep) is an open-source static analysis tool designed to scan code for security vulnerabilities and code quality issues.
15
14
16
15
## Configuration
17
16
18
-
Semgrep uses a YAML style configuration file. By default we will automatically
17
+
Semgrep uses a YAML style configuration file. By default, we will automatically
19
18
use the following files if any are set in the root directory of your
20
-
repostitory.
19
+
repository.
21
20
22
21
-`semgrep.yml` or `semgrep.yaml`
23
22
-`semgrep.config.yml` or `semgrep.config.yaml`
@@ -28,10 +27,12 @@ Semgrep supports the following config files:
28
27
project's `.coderabbit.yaml` file or setting the "Review → Tools → Semgrep →
29
28
Config File" field in CodeRabbit's settings page.
30
29
31
-
Due to licensing, CodeRabbit does not ship with the [community-created Semgrep rules](https://github.com/returntocorp/semgrep-rules), but you're free to use these in your own `semgrep.yml` config file.
30
+
Due to licensing, CodeRabbit does not ship with the [community-created Semgrep rules](https://github.com/returntocorp/semgrep-rules).
32
31
33
32
:::note
34
-
CodeRabbit will only run Semgrep if your repository contains a Semgrep config file. This config must use the default file names or you must define the path to this file in the `.coderabbit.yaml` or config UI.
33
+
34
+
CodeRabbit will only run Semgrep if your repository contains a Semgrep config file. This config must use the default file names, or you must define the path to this file in the `.coderabbit.yaml` or config UI.
35
+
35
36
:::
36
37
37
38
## Links
@@ -41,43 +42,21 @@ CodeRabbit will only run Semgrep if your repository contains a Semgrep config fi
41
42
42
43
## Files
43
44
44
-
Semgrep will run on the following files and extensions:
0 commit comments