Skip to content
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

rubocop docs #73

Merged
merged 1 commit into from
Aug 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
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
80 changes: 80 additions & 0 deletions docs/tools/rubocop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
title: Rubocop
sidebar_label: Rubocop
description: CodeRabbit's guide to Rubocop.
---

[Rubocop](https://rubocop.org/) A Ruby static code analyzer and formatter, based on the community Ruby style guide.

## Files

Rubocop will run on the following files and extensions:

- `.rb`
- `.arb`
- `.axlsx`
- `.builder`
- `.fcgi`
- `.gemfile`
- `.gemspec`
- `.god`
- `.jb`
- `.jbuilder`
- `.mspec`
- `.opal`
- `.pluginspec`
- `.podspec`
- `.rabl`
- `.rake`
- `.rbuild`
- `.rbw`
- `.rbx`
- `.ru`
- `.ruby`

- `.schema`
- `.spec`
- `.thor`
- `.watchr`
- `.irbrc`
- `.pryrc`
- `.simplecov`
- `buildfile`
- `Appraisals`
- `Berksfile`
- `Brewfile`
- `Buildfile`
- `Capfile`
- `Cheffile`
- `Dangerfile`
- `Deliverfile`
- `Fastfile`
- `Fastfile`
- `Gemfile`

- `Guardfile`
- `Jarfile`
- `Mavenfile`
- `Podfile`
- `Puppetfile`
- `Rakefile`

- `rakefile`
- `Schemafile`
- `Snapfile`
- `Steepfile`
- `Thorfile`
- `Vagabondfile`
- `Vagrantfile`

## Configuration

Rubocop uses a YAML style configuration file.

- `.rubocop.yml`

CodeRabbit will use the default settings based on the profile selected if no config file is found.

## Links

- [Rubocop Configuration](https://docs.rubocop.org/rubocop/1.65/configuration.html/)
2 changes: 2 additions & 0 deletions docs/tools/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ Remove extraneous f prefix
| TSX | [Biome][Biome] |
| Typescript | [Biome][Biome] |
| YAML | [YamlLint][YamlLint] |
| Ruby | [Rubocop][Rubocop] |

[ShellCheck]: ./shellcheck.md
[Ruff]: ./ruff.md
Expand All @@ -73,3 +74,4 @@ Remove extraneous f prefix
[Gitleaks]: ./gitleaks.md
[Checkov]: ./checkov.md
[Detekt]: ./detekt.md
[Rubocop]: ./rubocop.md