Skip to content

Commit 9680877

Browse files
committed
tools: add semgrep file types
1 parent 66312f7 commit 9680877

File tree

1 file changed

+25
-46
lines changed

1 file changed

+25
-46
lines changed

Diff for: docs/tools/semgrep.md

+25-46
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,13 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1010
<ProPlanNotice />
1111
```
1212

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

1615
## Configuration
1716

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
1918
use the following files if any are set in the root directory of your
20-
repostitory.
19+
repository.
2120

2221
- `semgrep.yml` or `semgrep.yaml`
2322
- `semgrep.config.yml` or `semgrep.config.yaml`
@@ -28,10 +27,12 @@ Semgrep supports the following config files:
2827
project's `.coderabbit.yaml` file or setting the "Review → Tools → Semgrep →
2928
Config File" field in CodeRabbit's settings page.
3029

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

3332
:::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+
3536
:::
3637

3738
## Links
@@ -41,43 +42,21 @@ CodeRabbit will only run Semgrep if your repository contains a Semgrep config fi
4142

4243
## Files
4344

44-
Semgrep will run on the following files and extensions:
45-
46-
- `Apex`
47-
- `Bash`
48-
- `.c`
49-
- `.cpp`
50-
- `.cs`
51-
- `.clj`
52-
- `.dart`
53-
- `Dockerfile`
54-
- `.ex`
55-
- `.html`
56-
- `.go`
57-
- `.java`
58-
- `.js`
59-
- `.jsx`
60-
- `.json`
61-
- `.jl`
62-
- `.jsonnet`
63-
- `.kt`
64-
- `.kts`
65-
- `Lisp`
66-
- `.lua`
67-
- `.ml`
68-
- `.php`
69-
- `.py`
70-
- `.r`
71-
- `.rb`
72-
- `.rs`
73-
- `.scala`
74-
- `Scheme`
75-
- `.sol`
76-
- `.swift`
77-
- `.tf`
78-
- `.ts`
79-
- `.tsx`
80-
- `.yaml`
81-
- `.xml`
82-
- `ERB`
83-
- `Jinja`
45+
Semgrep will run on the following files types:
46+
47+
- C/C++
48+
- C#
49+
- Go
50+
- Java
51+
- JavaScript
52+
- Kotlin
53+
- Python
54+
- TypeScript
55+
- Ruby
56+
- Rust
57+
- JSX
58+
- PHP
59+
- Scala
60+
- Swift
61+
- Terraform
62+
- JSON

0 commit comments

Comments
 (0)