Skip to content

Feat/brakeman clippy #366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 28, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
adding new tools
  • Loading branch information
alexcoderabbitai committed May 28, 2025
commit eb7e5b8f2b58a84ea403ddec7230746ecbdf87b1
40 changes: 40 additions & 0 deletions docs/tools/brakeman.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Brakeman
sidebar_label: Brakeman
description: CodeRabbit's guide to Brakeman.
---

```mdx-code-block
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
<ProPlanNotice />
```

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

## Supported Files

Brakeman will run on files with the following extensions:

- `Gemfile`
- `*.rb`
- `*.erb`

## Features

Brakeman can detect many critical vulnerabilities such as:

- SQL injection
- Cross-site scripting (XSS)
- Mass assignment
- Remote code execution
- And many more security vulnerabilities
- Out of date package versions
- Etc

## Links

- [Brakeman Official Website](https://brakemanscanner.org/)
- [Brakeman GitHub Repository](https://github.com/presidentbeef/brakeman)
- [Brakeman Documentation](https://brakemanscanner.org/docs/)
- [Warning Types](https://brakemanscanner.org/docs/warning_types/)
50 changes: 50 additions & 0 deletions docs/tools/clippy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: Clippy
sidebar_label: Clippy
description: CodeRabbit's guide to Clippy.
---

```mdx-code-block
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';

<ProPlanNotice />
```

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

## Supported Files

Clippy will run on files with the following extensions:

- `*.rs`

## Configuration

Clippy supports the following configuration files:

- `clippy.toml`
- `.clippy.toml`

:::note

Clippy does not require configuration to run. If no configuration file is found, it will use default settings.

A Cargo.toml is required.

:::

## Features

Clippy can detect many code quality issues such as:

- Style violations
- Common mistakes
- Performance issues
- Deprecated code patterns
- And many more Rust-specific issues

## Links

- [Clippy GitHub Repository](https://github.com/rust-lang/rust-clippy)
- [Clippy Documentation](https://rust-lang.github.io/rust-clippy/master/)
- [Available Lints](https://rust-lang.github.io/rust-clippy/master/index.html)