Rubocop: Cannot exclude vendor/ folder

[lenntt]

I'm using bundler, and all my gems are installed in projects_folder/vendor/ (including rubocop).
I've been succesfully excluding folders, but somehow I'm not able to exclude the vendor folder. Maybe it has something to do with rubocop being in it???

I think I've tried everything, like

vendor/**
'**/vendor/**'
vendor/**/*

etc.

(furthermore: in the code in Rubocop::Config#match_path? I see that pattern can either be a string or a regex... but how to define a regex in the rubocop.yml?)

[jonas054]

It looks like we have a bug, and it affects regexp as well as glob pattern matching. You can find the syntax for ruby regular expressions in YAML here, but it won't help you circumvent the bug.

I will investigate further.

[lenntt]

thanks for the fast response and clearing it out

[yujinakayama]

I guess this is a situation like below:

.
├── .rubocop.yml # config-A: this tries to exclude `vendor`
├── Gemfile
├── lib
│   └── foo.rb
└── vendor
    └── bundle
        └── ruby
            └── 2.0.0
                ├── gems
                │   ├── rubocop-0.8.3
                │   │   ├── .rubocop.yml # config-B: this does not inherit config-A
                │   │   ├── lib
                │   │   │   ├── rubocop
                │   │   │   │   ├── cli.rb # RuboCop refers only config-B when inspecting this file
...

I think this is an issue with the configuration loading design rather than bug.

[lenntt]

sorry for closing and reopening, pressed the wrong button.

I think the scenario sketched by @yujinakayama is correct.
(Though my definition of a bug may differ a little ;) )

[jonas054]

Very clear explanation @yujinakayama. I hadn't thought about this problem before, but now when I do, I want to call it a bug. It should be possible to exclude everything under vendor from config-A.

@SirLenz0rlot Did you have any other gems under vendor? Were they excluded? I think there may be two different problems that come into play here.

[lenntt]

@jonas054 Yes, all my gems are under vendor/bundle (except for e.g. bundler). I tried to exclude the entire vendor folder.

[jawwad]

I'm seeing some weird behavior on this...
I have vendor/** under Excludes: in my .rubocop.yml file.
While it does exclude files from vendor, it still ends up checking files in vendor/bundle/ruby/1.9.1/gems/parser-2.0.0.beta9

However it does exclude properly if I run rubocop this way...
rubocop --config .rubocop.yml

> rubocop
Inspecting 1043 files

> rubocop --config .rubocop.yml
Inspecting 765 files

[jonas054]

It seems we still have a bug. Thanks for reporting. I'm reopening the issue and will start to investigate.

[bogdan8]

@jonas054
Hi, I launch a rubocop through a Travise in the github
but for some reason it checks the folder vendore Maybe you know why?

Travis:

script: bundle exec rspec spec && bundle exec rubocop --config .rubocop.yml

.rubocop.yml

AllCops:
  DisplayStyleGuide: true
  DisplayCopNames: true
  Include:
    - '**/Gemfile'
    - '**/Rakefile'
  Exclude:
    - '**/bin/spring'
    - '**/bin/setup'
    - '**/bin/rake'
    - '**/bin/rails'
    - '**/db/schema.rb'
    - 'client/**/**'
    - 'config/**/**'
    - 'db/**/**'
    - 'bin/**'
    - 'app/models/role.rb'
    - 'vendor/*'
Rails:
  Enabled: true

Metrics/LineLength:
  Max: 120

Metrics/MethodLength:
  Max: 20

Style/Documentation:
  Enabled: false

Metrics/AbcSize:
  Max: 25

Metrics/ModuleLength:
  Exclude:
    - "**/*_spec.rb"

Metrics/BlockLength:
  Exclude:
    - "**/*_spec.rb"
  ExcludedMethods: ['included']

[jonas054]

@bogdan8 Yes, the correct pattern for excluding all files under vendor recursively is vendor/**/*.

[bogdan8]

@jonas054
Hi yes it helped me
Thanks)

[ianfixes]

I stumbled on this while looking for a way to ask the bundler where it's storing the dependencies -- that way, I could avoid doing _any_ work on files under that directory.

I ended up going with a more brute-force solution based on bundle show --paths, but I'd be glad to learn of a better way: https://github.com/Arduino-CI/arduino_ci/pull/98/files#diff-628053b8ae99f228ce5db85a0bd2a145R63

(This function is probably of more use to the RuboCop maintainers than the consumers of the gem)

[dmolesUC]

Is there a reason why vendor is not excluded by default?

[marcandre]

Is there a reason why vendor is not excluded by default?

I agree it probably should. I'll try to remember to do that when I tackle #7819; you may want to subscribe to that thread.

[jonas054]

It _is_ excluded by default. What happened here was that AllCops: Exclude was overridden in the local .rubocop.yml, so then you need to either set inherit_mode or copy the patterns you need to the local AllCops: Exclude.

[dmolesUC]

OK, I've been using RuboCop for six years and this is the first time I've heard of inherit_mode — I see it wasn't in the README back in the day.

Personally I think Exclude should default to merge, but failing that, maybe it should be documented more prominently -- or the fact that without it adding any custom Exclude will lose the defaults should be called out more explicitly. Given the special behavior of Include and Exclude with regard to shadowing in subdirectories, it's not entirely intuitive.

[philomory]

I have to agree with @dmolesUC ; it's pretty surprising to _add_ an exclude directive to .rubocop.yml and have that result in files that were previous being excluded no longer being so. It's true that after reading about it and reasoning about it you can totally understand how it works, but it's pretty confusing when you first encounter it.

[eregon]

:+1: on merging Exclude: should be the default, who doesn't want that?

[eregon]

I filed an issue to merge Exclude: by default, I believe that is always the intention for RuboCop users: #9325