How to tell Rubocop to ignore a specific directory or file

Question

My project is extending open-source classes from a third-party gem that we don't want to hold to the same coding standards as our own code. Refactoring the gem code isn't a viable option. We just want Rubocop to ignore the copied code.

How can I instruct Rubocop to completely ignore a file or directory?

Try https://github.com/bbatsov/rubocop#includingexcluding-files — orde, Apr 27 '16 at 17:02
Why did you copy the gem's source code into your project's folder? — spickermann, Apr 27 '16 at 17:25
spickermann, because we need to modify some methods on the class, and our tech lead said we aren't allowed to use monkey patches to do it. — emery, Apr 27 '16 at 18:24
As an aside, why is Rubocop picking up the Gem's source code? Did you bundle-install the gem into a sub directory within your project? — user229044, Apr 29 '16 at 14:00
As another aside, if the gem is on github, you can clone the gem's github repo and then point your Gemfile to your clone. This is very easy to do. — Wayne Conrad, Apr 29 '16 at 14:14
A new module was written in our code, with classes that extend the CukeForker gem's classes and override their methods, in order to modify the gem's output and colorization. We had previously been monkey patching the gem's methods, but wanted to do this instead. However, within one of the gem classes that our module extended and called, an original method was being called instead of our new method, so that code needed to be copied into the new module and modified to call the new class. It was that code that caused Rubocop to fail. — emery, Apr 30 '16 at 17:25
The manual section referenced in @orde's comment is now at http://rubocop.readthedocs.io/en/latest/configuration/#includingexcluding-files rather than on the github main page. — David Moles, Aug 25 '16 at 18:22
@emery why don't you use refinements? http://yehudakatz.com/2010/11/30/ruby-2-0-refinements-in-practice/ — Yo Ludke, Oct 19 '16 at 15:37

score 141 · Accepted Answer · edited Aug 25 '16 at 18:21

141

As per orde's comment with the link to the manual I found .rubocop.yml and added the following:

AllCops:
  Exclude:
    - 'path/to/excluded/file.rb'

where the path is relative to .rubocop.yml

edited Aug 25 '16 at 18:21

David Moles

48,006
27
136
235

answered Apr 27 '16 at 17:15

emery

8,603
10
44
51

5

This should probably be the accepted answer, since it's short. One important note I just ran into though: this will override the default AllCops.Excludes, which in Rails mode at least, will prevent rubocop from checking `node_modules` and `vendor`. So you'll likely want to add those to your excludes as well. – Ramfjord Nov 08 '18 at 21:29
3

Note that you can do this for **specific** cops as well. E.g. `Metrics/BlockLength: \n Exclude: \n - 'Rakefile' \n - '**/*.rake' \n - 'factories/**/*.rb' \n - 'spec/**/*.rb'` I wish you could do newlines in code snippets for sub-comments. – stwr667 Oct 15 '19 at 04:06
Make sure you keep the default values as well (see https://github.com/rubocop/rubocop/blob/924b939202eddeee2516aec958a2487356f3e53c/config/default.yml#L63-L67) – Spone Feb 23 '22 at 21:40

score 57 · Answer 2 · edited Jan 28 '19 at 13:35

57

From rubocop/default.yml:

AllCops:
  Exclude:
    - 'node_modules/**/*'
    - 'vendor/**/*'

edited Jan 28 '19 at 13:35

Jason Swett

43,526
67
220
351

answered Dec 23 '17 at 13:38

Dorian

22,759
8
120
116

score 34 · Answer 3 · answered Jun 25 '20 at 14:33

34

Can also consider comments for a single file. Great for ignoring the linter for a quick and dirty temporary task.

# rubocop:disable all

module TempTask
  ...
end

# rubocop:enable all

answered Jun 25 '20 at 14:33

Dennis

56,821
26
143
139

Bear in mind that this won't skip the file, it will only suppress the warning, but Rubocop seems to still check the file. – Sergio Dec 15 '21 at 12:31

score 22 · Answer 4 · edited Jul 16 '19 at 20:41

22

For your convenience, here is the .rubocop.yml I frequently used.

See formal explanation of .rubocop.yml here.

AllCops:
  Exclude:
    - Berksfile
    - recipes/basic.rb
    - attributes/*.rb

# Customize rules
Metrics/LineLength:
  Max: 95

MethodLength:
  Max: 35

Metrics/AbcSize:
   Enabled: false

BlockLength:
  Max: 70

I constantly bump by rubocop errors and warning. Thus I've published this post.

Common Rubocop Errors: Improve Your Ruby Code Quality

edited Jul 16 '19 at 20:41

noraj

3,964
1
30
38

answered Oct 26 '16 at 10:05

DennyZhang

342
2
7

2

according to the explanation link, it's `Exclude:` not `Excludes:` – Beni Cherniavsky-Paskin Dec 17 '18 at 17:06
my config needs quotes around the directory or filename – Natus Drew Mar 28 '19 at 23:53
NOTE: To ignore all subdirectories and files in a directory, use something like this `- tmp/**/*`. – Joshua Pinter Oct 22 '20 at 14:54

Peter Nixey · Answer 5 · 2021-09-14T10:28:28.037

3

When using Rubocop through Visual Studio I could not get the former answers to work.

I eventually noticed that Rubocop was not in fact executing from the root of my project file but from my own root directory and so using:

# Doesn't work :(
AllCops:
  Exclude:
    - db/schema.rb

was failing because db was not in the same directory that Rubocop was looking for it.

I then changed it to

# Works :)
AllCops:
  Exclude:
    - */schema.rb

and it works fine. Note there are no quotation marks around the file name.

edited Sep 14 '21 at 10:28

answered Sep 14 '21 at 10:19

Peter Nixey

16,187
14
79
133

1

The correct config is ` - /**/*/schema.rb`, otherwise it will give you an error – Patrick Barattin Oct 22 '21 at 13:47
Actually `/**/schema.rb` is enough. No need for `/**/*/`. – devius Sep 20 '22 at 22:07

score 3 · Answer 6 · answered Dec 22 '21 at 03:25

I'm using a newer version and every time I add Exclude rubocop will hang. Turned out I need to tell how to merge Exclude. This might work for you

require:
  - rubocop-rails
inherit_mode:
  merge:
    - Exclude
AllCops:
  Exclude:
    - 'node_modules/**/*'
    - 'vendor/**/*'
  NewCops: disable

How to tell Rubocop to ignore a specific directory or file

6 Answers6

Linked