Add description of recommended settings for VS Code #4054

iSazonov · 2017-06-20T14:28:35Z

No description provided.

iSazonov · 2017-06-20T15:41:17Z

CI OSX temporary failed

SteveL-MSFT · 2017-06-20T16:40:13Z

docs/learning-powershell/using-vscode.md

+
+By using the steps in the previous paragraph you can add onfiguration settings in `settings.json`.
+
+We recommend the following  configuration settings for Visual Studio Code:


Looks like a double space between following and configuration

SteveL-MSFT · 2017-06-20T16:40:51Z

docs/learning-powershell/using-vscode.md

+    "editor.renderWhitespace": "all",
+    "editor.renderControlCharacters": true,
+    "omnisharp.projectLoadTimeout": 120,
+    "files.trimTrailingWhitespace": true


should we just limit this to resx and powershell script files for now or are all the c# files clean?

C# files was fixed in #3001 by lzybkr.

But we stiil have about 350 files with tabs.

SteveL-MSFT · 2017-06-20T16:41:54Z

.github/CONTRIBUTING.md

@@ -61,6 +61,10 @@ To run the spellchecker, follow the steps as follows:

 ## Contributing to Code

+### Code Editors
+
+[You can use multiplatform Visual Studio Code (VS Code)][use-vscode-editor]


I think it should say: You should use the multi-platform ...

And make just the Visual Studio Code (VSCode) the hyperlink instead of the whole line

SteveL-MSFT

LGTM

iSazonov · 2017-06-21T06:23:05Z

@rkeithhill Any thoughts?

rkeithhill · 2017-06-21T15:48:31Z

@iSazonov The problem with putting this in the docs is that few people read the docs. That said, it's better to have in the docs than nowhere. :-) But at some point, I suggest we either add a .vscode\settting.json for this project or perhaps even better, add a .editorconfig file in the root dir. This is a config file that supports multiple editors. VS 2017 supports this file and VSCode does if you install the EditorConfig extension.

This brings me to my next suggestion. Consider adding a .vscode\extensions.json file which will prompt VSCode users to install the "recommended" extensions for this project. Perhaps with contents like this:

{
    // See http://go.microsoft.com/fwlink/?LinkId=827846
    // for the documentation about the extensions.json format
    "recommendations": [
        "ms-vscode.csharp",
        "ms-vscode.powershell",
        "EditorConfig.editorconfig"
    ]
}

iSazonov · 2017-06-21T16:04:51Z

@rkeithhill Thanks for great feedback!

I think we should be more conservative - other developers might have their preferences and we shouldn't overwrite them.

rkeithhill · 2017-06-21T16:07:54Z

Keep in mind that the use of a "workspace" specific settings file only overrides "user" specific settings for that workspace. And that is typically what you want. That is, a user might prefer tabs to spaces but this project uses spaces. So adding that setting to an editor config file will ensure that spaces are used for this user in only this workspace. In his own projects, tabs will still be used.

iSazonov · 2017-06-21T16:13:29Z

@rkeithhill The PR is for docs only. I believe your suggestions is great for new PR. Could you please open it?

This reverts commit 84d458b.

msftclas added the cla-already-signed label Jun 20, 2017

Add link to VS Code docs

bc5d3da

iSazonov force-pushed the contrib-vscode branch from 8f2e798 to bc5d3da Compare June 20, 2017 15:04

iSazonov mentioned this pull request Jun 20, 2017

Resx - remove trailing white spaces and extra Newline at EOF #4047

Merged

iSazonov requested a review from SteveL-MSFT June 20, 2017 15:41

SteveL-MSFT requested changes Jun 20, 2017

View reviewed changes

iSazonov added 2 commits June 20, 2017 23:59

Update using-vscode.md

49f019c

Update CONTRIBUTING.md

5e5ccd6

SteveL-MSFT approved these changes Jun 20, 2017

View reviewed changes

Fix a typo

6154587

daxian-dbw approved these changes Jun 21, 2017

View reviewed changes

Minor updates to 'Contributing.md'

0b787fe

daxian-dbw self-assigned this Jun 21, 2017

daxian-dbw merged commit 84d458b into PowerShell:master Jun 23, 2017

mirichmo added a commit that referenced this pull request Jun 23, 2017

Revert "Add description of recommended settings for VS Code (#4054)"

ca541cd

This reverts commit 84d458b.

iSazonov deleted the contrib-vscode branch July 20, 2017 11:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add description of recommended settings for VS Code #4054

Add description of recommended settings for VS Code #4054


		By using the steps in the previous paragraph you can add onfiguration settings in `settings.json`.

		We recommend the following configuration settings for Visual Studio Code:

Add description of recommended settings for VS Code #4054

Add description of recommended settings for VS Code #4054

Conversation

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment