Hidden directories should not be searched by default

[sometimesfood]

According to rubocop's README hidden directories should not be searched by default:

Hidden directories (i.e., directories whose names start with a dot) are not searched by default.

However, when I upgraded to 0.29.1, rubocop started to include my .bundle directory by default.

Steps to reproduce:

cd $(mktemp -dt rubocop-XXXX)
cat > Gemfile <<EOS
source 'https://rubygems.org'
gem 'rubocop'
EOS
bundle install --path .bundle
bundle exec rubocop

For me, this results in Inspecting 29 files; all of them in .bundle. Is this the intended behaviour or should the README be updated?

[rrosenblum]

I have found what the issue is here. Not all of the hidden files are being linted, only the special files that have been included by the .rubocop.yml or the default.yml file

# Common configuration.
AllCops:
  # Include gemspec and Rakefile
  Include:
    - '**/*.gemspec'
    - '**/*.podspec'
    - '**/*.jbuilder'
    - '**/*.rake'
    - '**/*.opal'
    - '**/Gemfile'
    - '**/Rakefile'
    - '**/Capfile'
    - '**/Guardfile'
    - '**/Podfile'
    - '**/Thorfile'
    - '**/Vagrantfile'
    - '**/Berksfile'
    - '**/Cheffile'
    - '**/Vagabondfile'
  Exclude:
    - 'vendor/**/*'

I have a few ideas on how to fix this, but this issue raises an interesting question on what configuration should be preferred, the configuration to skip hidden files, or the configuration of files to include. I would like the input of @bbatsov and @jonas054 as to what configuration should be preferred.

[rrosenblum]

After thinking about this for a little bit, I am hesitant to call this a bug. RuboCop is doing what it is designed to do by including those files for linting. The typical place, that I know of, to install gems to is vendor/bundle. If the gems were installed there, this would not be a problem. Alternatively, @sometimesfood, you can update your .rubocop.yml file have:

Exclude:
  - '.bundle/**/*'

Again though, I would like to hear back from someone else before making any real calls on this issue.

[sometimesfood]

Thanks for the update, Ryan. I hadn't noticed that only “included” files are checked.

After thinking about this for a little bit, I am hesitant to call this a bug. […] Alternatively, @sometimesfood, you can update your .rubocop.yml file

Thanks, I already did that yesterday. However, even if rubocop's behaviour remains as it currently is, this should be noted in the documentation somehow.

[sometimesfood]

Btw, rubocop's behaviour in such cases seems to have changed between 0.28.0 and 0.29.1. I first encountered this issue after upgrading to 0.29.1. With 0.28.0 hidden directories were ignored completely.

[bquorning]

It looks like this behavior was changed by #1618. Maybe a bug @jonas054?

[rrosenblum]

From what I saw, there are no test in target_finder_spec.rb that handle hidden directories or files.

[jonas054]

Yes it does look like a bug. I'd be grateful for some help, since I am on vacation until March 11 without the means to provide a fix myself.

[bquorning]

There is a test in cli_spec.rb that handles hidden directories, and can be changed to test this scenario:

diff --git a/spec/rubocop/cli_spec.rb b/spec/rubocop/cli_spec.rb
index 38df046..7df42af 100644
--- a/spec/rubocop/cli_spec.rb
+++ b/spec/rubocop/cli_spec.rb
@@ -2212,9 +2212,11 @@ describe RuboCop::CLI, :isolated_environment do
       create_file('regexp', 'x=0')
       create_file('.dot1/file.rb', 'x=0') # Hidden but explicitly included
       create_file('.dot2/file.rb', 'x=0') # Hidden, excluded by default
+      create_file('.dot3/file.rake', 'x=0') # Hidden, not included by wildcard
       create_file('.rubocop.yml', ['AllCops:',
                                    '  Include:',
                                    '    - example',
+                                   '    - "**/*.rake"',
                                    '    - !ruby/regexp /regexp$/',
                                    '    - .dot1/**/*'
                                   ])

I am pretty sure that the bug is found in either Config#file_to_include? or PathUtil#match_path?, but I cannot figure it out at the moment.