Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add description of recommended settings for VS Code #4054

Merged
merged 5 commits into from
Jun 23, 2017

Conversation

iSazonov
Copy link
Collaborator

No description provided.

@iSazonov
Copy link
Collaborator Author

CI OSX temporary failed


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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like a double space between following and configuration

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

"editor.renderWhitespace": "all",
"editor.renderControlCharacters": true,
"omnisharp.projectLoadTimeout": 120,
"files.trimTrailingWhitespace": true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator Author

@iSazonov iSazonov Jun 20, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

C# files was fixed in #3001 by lzybkr.

But we stiil have about 350 files with tabs.

@@ -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]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

Copy link
Member

@SteveL-MSFT SteveL-MSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@iSazonov
Copy link
Collaborator Author

@rkeithhill Any thoughts?

@rkeithhill
Copy link
Collaborator

rkeithhill commented Jun 21, 2017

@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
Copy link
Collaborator Author

@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
Copy link
Collaborator

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
Copy link
Collaborator Author

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

@daxian-dbw daxian-dbw self-assigned this Jun 21, 2017
@daxian-dbw daxian-dbw merged commit 84d458b into PowerShell:master Jun 23, 2017
mirichmo added a commit that referenced this pull request Jun 23, 2017
@iSazonov iSazonov deleted the contrib-vscode branch July 20, 2017 11:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants