From 58ad523a86bb923b25b3f9ef71bb5aea83d5778a Mon Sep 17 00:00:00 2001
From: Ruhan <ruhan@coderabbit.ai>
Date: Tue, 6 Aug 2024 10:59:54 +0530
Subject: [PATCH] rubocop docs

---
 docs/tools/rubocop.md | 80 +++++++++++++++++++++++++++++++++++++++++++
 docs/tools/tools.md   |  2 ++
 2 files changed, 82 insertions(+)
 create mode 100644 docs/tools/rubocop.md

diff --git a/docs/tools/rubocop.md b/docs/tools/rubocop.md
new file mode 100644
index 00000000..f6c44d1c
--- /dev/null
+++ b/docs/tools/rubocop.md
@@ -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/)
diff --git a/docs/tools/tools.md b/docs/tools/tools.md
index 1f9093d6..d174ab88 100644
--- a/docs/tools/tools.md
+++ b/docs/tools/tools.md
@@ -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
@@ -73,3 +74,4 @@ Remove extraneous f prefix
 [Gitleaks]: ./gitleaks.md
 [Checkov]: ./checkov.md
 [Detekt]: ./detekt.md
+[Rubocop]: ./rubocop.md