Add default ruby configuration for visual studio code

[jenenliu]

Motivation

I am trying to fix this issue #1619. Add recommand default configurations for Visual Studio code.

Implementation

Add [ruby] configuration to ConfigurationDefault in vscode/package.json

Automated Tests

Not yet

Manual Tests

Not yet

[jenenliu]

Hi @vinistock , I am trying to fix issue #1619, could you please help to guide how can I test ? I try to run Ruby-LSP: restart, but seems new configuration is not working. formatOnSave is not working at least. Thanks a lot.

[jenenliu]

I have signed the CLA!

[brunoprietog]

Sorry, but it doesn't seem to me that this should be the default value. When saving, I want to save what I am seeing now, unless I have explicitly defined it that way. This can be problematic especially when Rubocop is very aggressive in its corrections.

[jenenliu]

@brunoprietog Yep, I've updated the code, thx.

[andyw8]

We do want this to be formatOnSave, as it is the current recommendation. We believe this is the best approach for the vast majority of developers. Saving only runs the autocorrects that RuboCop treats as safe, so it's very unlikely that this would result in incorrect code.

[jenenliu]

So may I know do we have final decision for this ?

[vinistock]

Yeah, we do want this value to be true. The idea of the recommended defaults is for a user of the Ruby LSP to get all features out of the box, even the ones that might be turned off by default by VS Code.

For example, formatOnSave and formatOnType are both turned off by default, which leads to many people not realizing that the Ruby LSP can auto-complete end tokens for you as you type without the need to add any other extensions.

And remember, this is just a default recommendation. You can very easily turn this off.

[brunoprietog]

formatOnType I understand, but formatOnSave I still think is dangerous. When you do the save action you expect a result. If you have manually included that feature, you know that there is a chance that it will be formatted on save, which is understandable. But if you have never enabled this option, what is expected is simply to save, without doing anything. Entering this option by default means that. Most people will not know that it is enabled and could run into unpleasant surprises when saving without knowing that this option is enabled. It is very different when you activate the option manually, because you really know what is going to happen.

[brunoprietog]

Personally, I had this feature enabled at first, but I disabled it, as it happened to me several times that when applying a replace on several files at once, more than one file was left empty, and it took me quite some time to find out the reason. It has never happened again with formatOnSave disabled.

[andyw8]

@brunoprietog if you can reproduce, then please create an issue for this so that we can address.

[brunoprietog]

It wasn't a problem with Ruby LSP, it was a problem with VS Code in general that happened to me with several file types, not just Ruby.

[vinistock]

could you please help to guide how can I test ?

@jenenliu yes, absolutely. Here are the steps to test this:

1. Before starting, ensure you don't have any of the recommended settings already configured in your VS Code. We want to verify that you get the recommended defaults automatically. If you have those settings, comment them out temporarily
2. Now, we need to run the development version of the extension, so that you can verify the changes. First, ensure node dependencies are installed: cd vscode && yarn install
3. In the run and debug panel, select the Run extension task and click start/run. This will open a second VS Code window, where the development version of the extension is running. It's in that window that you will be able to verify the changes
4. In that second window, open a Ruby project
5. Now test to see if the changes are taking effect. Are you seeing auto-formatting? When you type code, is the indentation level 2? If you are seeing those, then the changes work as expected

[jenenliu]

could you please help to guide how can I test ?

@jenenliu yes, absolutely. Here are the steps to test this:

1. Before starting, ensure you don't have any of the recommended settings already configured in your VS Code. We want to verify that you get the recommended defaults automatically. If you have those settings, comment them out temporarily
2. Now, we need to run the development version of the extension, so that you can verify the changes. First, ensure node dependencies are installed: cd vscode && yarn install
3. In the run and debug panel, select the Run extension task and click start/run. This will open a second VS Code window, where the development version of the extension is running. It's in that window that you will be able to verify the changes
4. In that second window, open a Ruby project
5. Now test to see if the changes are taking effect. Are you seeing auto-formatting? When you type code, is the indentation level 2? If you are seeing those, then the changes work as expected

@vinistock I've tested, it works as expected, thanks a lot. Now if formatOnSave should be included, then I'll update the code, and please help to approve.

[github-actions]

This pull request is being marked as stale because there was no activity in the last 2 months

[jenenliu]

@aryan-soni could you please help to review ? thx