.rubocop.yml exclude doesn't work.

Your environment

vscode-ruby version: 0.15.0
Ruby version: ruby 2.4.2p198 (2017-09-14 revision 59899) [x64-mingw32]
VS Code version: 1.18.1 and 1.19.0-insider
Operating System: Windows 10 latest

Expected behavior

.rubocop.yml like this should work:

AllCops:
  Exclude:
    - 'db/**'
    - '**/Gemfile'
  TargetRubyVersion: 2.4

Actual behavior

db/schema.rb and Gemfile being rubocopped.

Via rubocop db it works. So, it's a bug?

I don't have any experience with Windows 10. But, I am guessing the below config (in user settings) will solve your problem.

"ruby.rubocop.configFilePath": "path/to/your/.rubocop.yml",

Hi @johnunclesam

Is this still an issue for you with the latest version of the extension? Some changes were introduced in how Rubocop is run in v0.16.0 so wondering if that fixed it.

I personally still have this problem and I'm using version 0.17.0 on macOS.

Still a problem for me, v0.17.0 with rubocop v0.53.0 on macOS. schema.rb still gets linted by extension.

Closing for issue cleanup. Apologies if this is still an issue. We are working to improve the core extension experience.

Yep still a problem.

I bet rubocop doesn't apply Exclude rules when you run it on a single file. Perhaps this will help - rubocop/rubocop#893

I just ran Rubocop on a single file, and it respected exclusions.

Specifically, certain rules by default in Rubocop, don't apply to files in specs and test folders, yet in this extension, they still run. Like Metrics/ClassLength.

@garyking

@garyking, there are two separate issues:

Things like Metrics/ClassLength are applied when they shouldn't be. Presumably because rubocop isn't getting enough context when linting. Haven't investigated yet.
Files that are listed under Exclude still get linted (like db/schema.rb). I bet adding --force-exclusion will solve this problem.

@garyking

@garyking what's your rubocop config for this extension look like? Both of those issues basically mean Rubocop is either not finding the .rubocop.yml or is ignoring the settings. I'm wondering if one of the extension settings is activating a CLI option that causes things to be ignored.

This ext isn't importing Excludes from inherited rules for some reason.

I have a workspace in VSC. There's a .rubocop.yml in the workspace's root. It just has: inherit_from: /Users/gary/.base-rubocop.yml.

In that inherited file, it has:

Metrics/ClassLength:
  Exclude:
    - 'test/**/*'
  Max: 150

Back in my workspace, in the file test/test_file.rb, if I run Rubocop on the file from Terminal, then I get no errors. But in VSC, this ext gives me the Metrics/ClassLength error, indicating that Exclude is not inherited. But the Max value definitely is, because it says 205/150.

The forceExclusion option combined with "useBundler": true works for me.

I had the same problem but noticed that when it was run in Visual Studio, Rubocop wasn't referencing the same root directory as my project. So I tried making the exclusion root-independent and it then worked fine:

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

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

@peternixey

@peternixey I tried your solution and works in vs code but then it does not work in the command line. When I tried to run in the terminal bundle exec rubocop I got an error like the following:

/path/to/your/project/.rubocop.yml): did not find expected alphabetic or numeric character while scanning an alias at line 5 column 7
/path/to/your/home/.rbenv/versions/2.7.1/lib/ruby/2.7.0/psych.rb:456:in `parse'
/path/to/your/home/.rbenv/versions/2.7.1/lib/ruby/2.7.0/psych.rb:456:in `parse_stream'
/path/to/your/home/.rbenv/versions/2.7.1/lib/ruby/2.7.0/psych.rb:390:in `parse'
...

This helps while developing with VS code but if you have rubocop integrated in your deployment pipeline it is not a final solution.

@heragu

@heragu - it actually doesn’t even work in Vscode any more for me. I find anything to do with Ruby (solargraph etc too) a bit of a black art to get working!

The "forceExclusion": true solution does not work for me. What's the status of this bug? Is anyone working on it?

This behavior is really strange. I created experiment project: https://github.com/shrkw/vscode-ruby-dev-env-sample , and rubocop and "Exclude" settings works very well yesterday.
I opened it today, "Exclude" settings does not work at all!

Debug Output view for "Ruby Language Server" shows rubocop has correct option...

Lint: executing bundle exec rubocop -s '/Users/shirakawa2/Development/sandbox-ruby-vscode/src/apple.rb' -f json --force-exclusion...
Lint: executing bundle exec rubocop -s '/Users/shirakawa2/Development/sandbox-ruby-vscode/src_excl/cherry.rb' -f json --force-exclusion...

and same command returns no offenses.

{"metadata":{"rubocop_version":"1.27.0","ruby_engine":"ruby","ruby_version":"2.6.8","ruby_patchlevel":"205","ruby_platform":"universal.arm64e-darwin21"},"files":[],"summary":{"offense_count":0,"target_file_count":0,"inspected_file_count":0}}%

It's really difficult to understand.

I found what caused the problem, it's this setting:

"ruby.lint": {
   "rubocop": {
      "useBundler": true // enable rubocop via bundler
   }
}

I removed it and it worked! It should be ruby.rubocop.useBundler and NOT ruby.lint.rubocop.useBundler.

VS Code: Fix issue where rubocop `Exclude` wasn't working

Since this is an old issue with lots of comments, it's possible there are multiple bugs being represented here. However, I strongly suspect this issue is a duplicate of #578 and #719, and is fixed by PR #720. However, the fix hasn't made it into a release yet.

fix(language-server-ruby): pass valid filenames to RuboCop

@benzado

Since this is an old issue with lots of comments, it's possible there are multiple bugs being represented here. However, I strongly suspect this issue is a duplicate of #578 and #719, and is fixed by PR #720. However, the fix hasn't made it into a release yet.

@benzado if I am not mistaken PR #720 fixes only language-server-ruby/src/linters/ and this issue is related to language-server-ruby/src/formatters/ (which has exactly the same issue -- extra single quotes). I created PR #825 and appreciate it if you can review it.

Even if PR #825 gets merged and doesn't work, we're no worse off than we are right now with 0.28.1. Could #641 even be reproduced at this point, given the 78 (I counted) releases rubocop has had since August 01, 2020?

Rather than dealing with the fallout of that commit for 2 more years, can PR #647 just be reverted until it can be shown that there actually is a problem in the first place?

@senhalil

#840 (which could supersede #825 - although @senhalil should feel free to merge this and let things continue over there) finishes reverting all of the changes from #647, which hadn't already been reverted elsewhere.

You should really also document the pattern syntax. Whether it's a Dir.glob or fnmatch, or shell glob, explicitly state so. If it's a custom syntax, document it.

Use rubocop as just a ruby formatter in vscode to avoid vscode-ruby b…

Navigation Menu

Repository navigation

.rubocop.yml exclude doesn't work. #227

Your environment

Expected behavior

Actual behavior

29 remaining items

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

.rubocop.yml exclude doesn't work. #227

Description

Your environment

Expected behavior

Actual behavior

Activity

karuppasamy commented on Dec 27, 2017

wingrunr21 commented on Mar 5, 2018

WA9ACE commented on Mar 9, 2018

msokk commented on Mar 10, 2018

wingrunr21 commented on Apr 3, 2018

garyking commented on Apr 10, 2018

gurgeous commented on Apr 10, 2018

garyking commented on Apr 10, 2018

gurgeous commented on Apr 10, 2018

wingrunr21 commented on Apr 10, 2018

garyking commented on Apr 11, 2018

29 remaining items

fedeth commented on Jul 13, 2021

peternixey commented on Sep 14, 2021

heragu commented on Nov 9, 2021

peternixey commented on Nov 9, 2021

evgenyneu commented on Dec 23, 2021

shrkw commented on Apr 19, 2022

evgenyneu commented on Apr 19, 2022

benzado commented on Apr 20, 2022

senhalil commented on Jun 16, 2022

qwell commented on Dec 8, 2022

qwell commented on Dec 8, 2022

celesteking commented on Jan 11, 2023

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions