Skip to content

Commit 9cd059e

Browse files
Feat/brakeman clippy (#366)
* adding new tools * add to list and changelog
1 parent ee9fe04 commit 9cd059e

File tree

4 files changed

+106
-1
lines changed

4 files changed

+106
-1
lines changed

docs/changelog.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,18 @@ description: The latest updates and changes to CodeRabbit.
55
sidebar_position: 13
66
---
77

8+
## May 25, 2025
9+
10+
### New Security and Code Quality Tools
11+
12+
We're excited to announce the addition of two powerful tools to our static analysis arsenal:
13+
14+
- **Brakeman**: A static analysis security vulnerability scanner for Ruby on Rails applications. It helps identify security issues in your Ruby codebase by analyzing Gemfile, Ruby files (_.rb), and ERB templates (_.erb).
15+
16+
- **Clippy**: The official linter for Rust code, helping catch common mistakes and improve your Rust code quality. It analyzes \*.rs files and supports configuration through clippy.toml files.
17+
18+
Both tools can be configured through their respective config files or through CodeRabbit's settings page. See our [tools documentation](https://docs.coderabbit.ai/tools/) for more details.
19+
820
## May 19, 2025
921

1022
### Lua Support with Luacheck

docs/tools/brakeman.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Brakeman
3+
sidebar_label: Brakeman
4+
description: CodeRabbit's guide to Brakeman.
5+
---
6+
7+
```mdx-code-block
8+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
9+
10+
<ProPlanNotice />
11+
```
12+
13+
[Brakeman](https://brakemanscanner.org/) is a static analysis tool which checks Ruby on Rails applications for security vulnerabilities. It scans your application's code for potential security issues and provides detailed reports about any vulnerabilities it finds.
14+
15+
## Supported Files
16+
17+
Brakeman will run on files with the following extensions:
18+
19+
- `Gemfile`
20+
- `*.rb`
21+
- `*.erb`
22+
23+
## Features
24+
25+
Brakeman can detect many critical vulnerabilities such as:
26+
27+
- SQL injection
28+
- Cross-site scripting (XSS)
29+
- Mass assignment
30+
- Remote code execution
31+
- And many more security vulnerabilities
32+
- Out of date package versions
33+
- Etc
34+
35+
## Links
36+
37+
- [Brakeman Official Website](https://brakemanscanner.org/)
38+
- [Brakeman GitHub Repository](https://github.com/presidentbeef/brakeman)
39+
- [Brakeman Documentation](https://brakemanscanner.org/docs/)
40+
- [Warning Types](https://brakemanscanner.org/docs/warning_types/)

docs/tools/clippy.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: Clippy
3+
sidebar_label: Clippy
4+
description: CodeRabbit's guide to Clippy.
5+
---
6+
7+
```mdx-code-block
8+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
9+
10+
<ProPlanNotice />
11+
```
12+
13+
[Clippy](https://github.com/rust-lang/rust-clippy) is a collection of lints to catch common mistakes and improve your Rust code. It is the official linter for the Rust programming language.
14+
15+
## Supported Files
16+
17+
Clippy will run on files with the following extensions:
18+
19+
- `*.rs`
20+
21+
## Configuration
22+
23+
Clippy supports the following configuration files:
24+
25+
- `clippy.toml`
26+
- `.clippy.toml`
27+
28+
:::note
29+
30+
Clippy does not require configuration to run. If no configuration file is found, it will use default settings.
31+
32+
A Cargo.toml is required.
33+
34+
:::
35+
36+
## Features
37+
38+
Clippy can detect many code quality issues such as:
39+
40+
- Style violations
41+
- Common mistakes
42+
- Performance issues
43+
- Deprecated code patterns
44+
- And many more Rust-specific issues
45+
46+
## Links
47+
48+
- [Clippy GitHub Repository](https://github.com/rust-lang/rust-clippy)
49+
- [Clippy Documentation](https://rust-lang.github.io/rust-clippy/master/)
50+
- [Available Lints](https://rust-lang.github.io/rust-clippy/master/index.html)

docs/tools/list.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
3535
| Protobuf | [Buf][Buf] | Code Quality |
3636
| Python | [Ruff][Ruff] | Code Quality |
3737
| Regal | [Regal][Regal] | Code Quality |
38-
| Ruby | [RuboCop][RuboCop] | Code Quality |
38+
| Ruby | [RuboCop][RuboCop], [Brakeman][Brakeman] | Code Quality, Code Security |
39+
| Rust | [Clippy][Clippy] | Code Quality |
3940
| Semgrep | [Semgrep][Semgrep] | Code Security |
4041
| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] | Code Quality |
4142
| Shopify | [Shopify CLI][ShopifyCLI] | Code Quality |
@@ -74,3 +75,5 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
7475
[oxlint]: /tools/oxlint.md
7576
[ShopifyCLI]: /tools/shopify-cli.md
7677
[Luacheck]: /tools/luacheck.md
78+
[Brakeman]: /tools/brakeman.md
79+
[Clippy]: /tools/clippy.md

0 commit comments

Comments
 (0)