29

Environments

  • vscode Version 1.19.1 (1.19.1)
  • rubocop (0.52.1)
  • Darwin mbp 16.7.0 Darwin Kernel Version 16.7.0: Wed Oct 4 00:17:00 PDT 2017; root:xnu-3789.71.6~1/RELEASE_X86_64 x86_64
  • ruby 2.3.5p376 (2017-09-14 revision 59905) [x86_64-darwin16]

followed https://github.com/rubyide/vscode-ruby#linters and installed all gems and edited the settings.json like this.

{

  "ruby.rubocop.executePath": "/Users/ac/.rbenv/shims/",
  "ruby.rubocop.onSave": true,
  "ruby.lint": {
    "ruby": {
      "unicode": true //Runs ruby -wc -Ku
    },
    "reek": true,
    "rubocop": {
      "lint": true,
      "rails": true
    },
    "fasterer": true,
    "debride": {
      "rails": true //Add some rails call conversions.
    },
    "ruby-lint": true
  },
  "ruby.locate": {
    "include": "**/*.rb",
    "exclude": "{**/@(test|spec|tmp|.*),**/@(test|spec|tmp|.*)/**,**/*_spec.rb}"
  }

}

On vscode, code highlighting is working fine.
*just to note, you see the extensions installed, and warnings in the problem tab.

rubocop is working ok

Question

I was under the inpression that vscode-ruby and rubocop would auto-correct indentations and cop rules on file save, but apparently it doesn't.
If I want it to format my code like prettier, how should I set this up?

kukrt
  • 2,117
  • 3
  • 21
  • 32

8 Answers8

26

Per this comment on the vscode-ruby-rubocop GitHub, you can use the following settings:

{
    "editor.formatOnSave": true,
    "editor.formatOnSaveTimeout": 5000,
    "ruby.rubocop.executePath": "path/where/rubocop/is/located",
    "ruby.format": "rubocop",
}

Just applied them to my user settings on my local box and it appears to work. VS Code was throwing an error for my ruby.rubocop.executePath setting saying it wasn't executable, and removing the line appears to not cause that error to show, and still formats my code accordingly. Setting a lower timeout (I tried 2500) also seems to break auto format on saving, so I'd suggest leaving it at 5000.

MattD
  • 4,220
  • 2
  • 34
  • 44
  • 4
    For my environment setting `"editor.formatOnSaveTimeout": 5000` did the trick, I had it set to 1500 and it wasn't working. Also `"ruby.rubocop.executePath"` seems to be unrecognised, perhaps it's since been removed? – Simon L. Brazell Jun 19 '19 at 04:10
  • 2
    This is the magic setting that fixes everything and should be the default when you install Visual Studio: `"editor.formatOnSave": true` – Andrew Koster Jul 31 '19 at 04:05
  • `"editor.formatOnSaveTimeout": 5000` has solved my problem too. cheers – Raj Nov 13 '19 at 07:08
  • This, unfortunately, doesn't work with the `-A` argument. You still need to manually run the Rubocop CLI with `-A`. – dimiguel Oct 12 '22 at 15:26
  • @dimiguel Not sure if there's a setting to enable it by default, but there's a command palate option of "Rubocop: autocorrect by rubocop" that may be of use here? https://github.com/misogi/vscode-ruby-rubocop#features – MattD Oct 12 '22 at 20:04
9

I've tried all the options other people shared and it fixed linking for me (so I would get warnings when my code wasn't formatted correctly) but it didn't fix indentation or other formatting on save.

What seemed to work for me is adding a default formatter option. If you look at the bottom right corner in vscode you should see a notification icon which might throw in a few warnings that can help with your config. For me it was adding:

"[ruby]": {
  "editor.defaultFormatter": "misogi.ruby-rubocop"
}
James van Dyke
  • 4,790
  • 3
  • 28
  • 25
user17263304
  • 91
  • 1
  • 1
8

Now, it's enough just adding these lines:

{
  "ruby.rubocop.onSave": true,
  "editor.formatOnSave": true,
}
sjdonado
  • 390
  • 6
  • 8
4

I had this problem for a while and none of the other solutions worked for me.
According to a github comment, what solved was:

I Replace bin in the PATH with wrappers and solved the issue: vscode setting: ruby.rubocop.executePath": "/Users/USER_NAME/.rvm/gems/ruby-2.6.5/wrappers/

Note: Another useful thing you could check if none of the above worked for you is to check your home folder for a .rubocop.yml file (~/.rubocop.yml) and delete it so you only have your project's .rubocop.yml working on.

nabais
  • 1,981
  • 1
  • 12
  • 18
1

To make sure autocorrection works with ruby-rubocop add below settings make sure "ruby.rubocop.executePath": "path/where/rubocop/is/located", is set to default "ruby.rubocop.executePath": "",

Add the following to your json file in vscode 

"editor.formatOnSave": true,
"editor.formatOnSaveTimeout": 5000,
"ruby.rubocop.executePath": "",
"ruby.format": "rubocop",
Samuel Kiroko N
  • 31
  • 2
1

I struggled with the extension ruby-rubocop, last updated in Dec 2021. It seems it's still using the auto-correct command --autocorrect while Rubocop now uses --auto-correct. I switched to another extension, ruby-rubocop-revived, which fixed my auto-correct issue.

It also introduces the useServer option that speeds up the execution.

Here are the settings I used:

# .vscode/settings.json

  "ruby.format": "rubocop",
  "ruby.rubocop.onSave": true,
  "ruby.rubocop.useServer": true,
  "[ruby]": {
    "editor.defaultFormatter": "rebornix.ruby"
  },
jibai31
  • 1,663
  • 18
  • 22
0

This comment is now thankfully outdated

-- Unfortunately this cannot be done with the current rubocop extension. The primary use case is to lint your ruby and show visual cues in the IDE.

It is currently an open issue/feature request on github. View this issue to see progress until it is resolved.

https://github.com/misogi/vscode-ruby-rubocop/issues/49

gdxn96
  • 369
  • 5
  • 16
0

May 2023 update:

The extension you refer in the question under vscode-ruby (which is in fact rebornix.Ruby) is deprecated and no longer maintained.

A modern way is to use Ruby LSP extension from Shopify (Shopify.ruby-lsp) and add "editor.formatOnSave": true. See more detailed answer on setting up autocorrection.

Artur INTECH
  • 6,024
  • 2
  • 37
  • 34