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

Commit 58ad523

Browse files
rubocop docs
1 parent 01fb00b commit 58ad523

File tree

2 files changed

+82
-0
lines changed

2 files changed

+82
-0
lines changed

‎docs/tools/rubocop.md‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
title: Rubocop
3+
sidebar_label: Rubocop
4+
description: CodeRabbit's guide to Rubocop.
5+
---
6+
7+
[Rubocop](https://rubocop.org/) A Ruby static code analyzer and formatter, based on the community Ruby style guide.
8+
9+
## Files
10+
11+
Rubocop will run on the following files and extensions:
12+
13+
-`.rb`
14+
-`.arb`
15+
-`.axlsx`
16+
-`.builder`
17+
-`.fcgi`
18+
-`.gemfile`
19+
-`.gemspec`
20+
-`.god`
21+
-`.jb`
22+
-`.jbuilder`
23+
-`.mspec`
24+
-`.opal`
25+
-`.pluginspec`
26+
-`.podspec`
27+
-`.rabl`
28+
-`.rake`
29+
-`.rbuild`
30+
-`.rbw`
31+
-`.rbx`
32+
-`.ru`
33+
-`.ruby`
34+
35+
-`.schema`
36+
-`.spec`
37+
-`.thor`
38+
-`.watchr`
39+
-`.irbrc`
40+
-`.pryrc`
41+
-`.simplecov`
42+
-`buildfile`
43+
-`Appraisals`
44+
-`Berksfile`
45+
-`Brewfile`
46+
-`Buildfile`
47+
-`Capfile`
48+
-`Cheffile`
49+
-`Dangerfile`
50+
-`Deliverfile`
51+
-`Fastfile`
52+
-`Fastfile`
53+
-`Gemfile`
54+
55+
-`Guardfile`
56+
-`Jarfile`
57+
-`Mavenfile`
58+
-`Podfile`
59+
-`Puppetfile`
60+
-`Rakefile`
61+
62+
-`rakefile`
63+
-`Schemafile`
64+
-`Snapfile`
65+
-`Steepfile`
66+
-`Thorfile`
67+
-`Vagabondfile`
68+
-`Vagrantfile`
69+
70+
## Configuration
71+
72+
Rubocop uses a YAML style configuration file.
73+
74+
-`.rubocop.yml`
75+
76+
CodeRabbit will use the default settings based on the profile selected if no config file is found.
77+
78+
## Links
79+
80+
-[Rubocop Configuration](https://docs.rubocop.org/rubocop/1.65/configuration.html/)

‎docs/tools/tools.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ Remove extraneous f prefix
5959
| TSX |[Biome][Biome]|
6060
| Typescript |[Biome][Biome]|
6161
| YAML |[YamlLint][YamlLint]|
62+
| Ruby |[Rubocop][Rubocop]|
6263

6364
[ShellCheck]: ./shellcheck.md
6465
[Ruff]: ./ruff.md
@@ -73,3 +74,4 @@ Remove extraneous f prefix
7374
[Gitleaks]: ./gitleaks.md
7475
[Checkov]: ./checkov.md
7576
[Detekt]: ./detekt.md
77+
[Rubocop]: ./rubocop.md

0 commit comments

Comments
(0)