Add recommended VS Code settings and extensions

[Nick-Mazuk]

Because of the ongoing efforts to resolve#5, I decided to add my current VS Code settings and extensions to the .vscode folder.

In theory, this does two things:

1. New users will get notified to install the recommended extensions
2. All users will be working with the same VS Code settings (e.g., code formatting, linting, etc.)

That means we can help make everyone's development environment consistent. And aside from pressing the button to "download recommended extensions", developers won't need to do anything to setup VS Code.

To be honest, I've never done this before so it may not work as expected. But it's potentially worth a shot. At the very least, it might resolve the existing VS Code code formatting issue since we'll share the same settings and extensions.

The may drawback is that if anyone has a .vscode folder in their local version of the repo, their settings may also get unintentionally added.

[rpatters1]

Your .vscode settings are considerably different than mine, so yes I am hoping it can (finally) resolve #5. My settings currently include these that aren't in yours:

 "editor.formatOnType": true,
"editor.formatOnSave": true,
"lualinter.warnOnSave": true

This brings up another issue, though. Is it wise to force everyone to have the same .vscode settings?

[Nick-Mazuk]

This brings up another issue, though. Is it wise to force everyone to have the same .vscode settings?

These settings will only affect this current repository. You can still have your own settings in the "User" scope. However, any settings included in this .vscode/settings.json will override user settings. So if this PR is merged, I'd recommend keeping the settings as minimal as possible.

https://code.visualstudio.com/docs/getstarted/settings

[Nick-Mazuk]

Your .vscode settings are considerably different than mine, so yes I am hoping it can (finally) resolve #5. My settings currently include these that aren't in yours:

 "editor.formatOnType": true,
"editor.formatOnSave": true,
"lualinter.warnOnSave": true

I do have "editor.formatOnSave": true,, but the other two I don't. I don't think they affect whether or not code formatting works?

Unless they do, I'd recommend not adding them to this settings.json for the same reasons in my previous comment.

[rpatters1]

I guess my discomfort with this PR stems from the fact that it will be very easy to modify the .vscode directory without intending to. Also, just as an example, I currently actually point VS Code directly at the src subdirectory, so that's where my .vscode directory is. With this PR, that directory would be added into the repo as well.

Of course, I can easily change to not do that, but every user of this repo is likely to have slightly different work habits and preferences. It could become difficult to manage them all. I am wondering if instead of including .vscode in the repo we should instead put the recommended json files in a recommended_vscode directory. Then users would be free to user them or not. I realize this adds room for error in updating them. Maybe there is some other way I haven't thought of.

[Nick-Mazuk]

Hmm, that does make sense. The recommended_vscode might be the best option, then.

Also, just as an example, I currently actually point VS Code directly at the src subdirectory, so that's where my .vscode directory is. With this PR, that directory would be added into the repo as well.

I can update the .gitignore to only track the .vscode folder in the root directory, but then you wouldn't get the automatic updates.

I guess my discomfort with this PR stems from the fact that it will be very easy to modify the .vscode directory without intending to.

This is true, but I feel like we can easily catch this in code review.

[rpatters1]

Should we add this line to settings.json?

"lua.targetVersion": "5.2",

[Nick-Mazuk]

Should we add this line to settings.json?

"lua.targetVersion": "5.2",

That would be a good idea.

[Nick-Mazuk]

@rpatters1

I'm not seeing a setting named lua.targetVersion. I do see:

"Lua.runtime.version": "Lua 5.2"

[Nick-Mazuk]

I've updated the settings to hopefully resolve your hesitations.

• All .vscode folders not in the root will be git ignored.
• The settings file is not called recommended_settings.json
• I've kept the extensions.json as is since it only recommends extensions, and a user can easily ignore this message (and tell VS Code to not bother them again about it).

[rpatters1]

lua.targetVersion

Some extension somewhere added it to my settings.json. Maybe it was that debugger. BTW I have a whole launch.json file that may need to be added at some point, if I can ever get debugging to work.

At any rate, I suppose "Lua.runtime.version": "Lua 5.2" is fine for now.

Also, feel free to go ahead and merge this one.

[rpatters1]

Looks good/