Skip to content

Commit 84d458b

Browse files
iSazonovdaxian-dbw
authored andcommitted
Add description of recommended settings for VS Code (PowerShell#4054)
1 parent 5ee4ec1 commit 84d458b

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

.github/CONTRIBUTING.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,10 @@ To run the spellchecker, follow the steps as follows:
6161

6262
## Contributing to Code
6363

64+
### Code Editor
65+
66+
You should use the multi-platform [Visual Studio Code (VS Code)][use-vscode-editor].
67+
6468
### Building and testing
6569

6670
#### Building PowerShell
@@ -302,4 +306,5 @@ Once you sign a CLA, all your existing and future pull requests will be labeled
302306
[open-issue]: https://github.com/PowerShell/PowerShell/issues
303307
[up-for-grabs]: https://github.com/powershell/powershell/issues?q=is%3Aopen+is%3Aissue+label%3AUp-for-Grabs
304308
[semantic linefeeds]: http://rhodesmill.org/brandon/2012/one-sentence-per-line/
305-
[PowerShell-Docs]: https://github.com/powershell/powershell-docs/
309+
[PowerShell-Docs]: https://github.com/powershell/powershell-docs/
310+
[use-vscode-editor]: ../docs/learning-powershell/using-vscode.md#editing-with-visual-studio-code

docs/learning-powershell/using-vscode.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ To exit Visual Studio Code, **File->Exit**.
5353

5454
If you wish to use a specific installation of PowerShell with Visual Studio Code, you will need to add a new variable to your user settings file.
5555

56-
1. Click **File -> Preferences -> User Settings**
56+
1. Click **File -> Preferences -> Settings**
5757
2. Two editor panes will appear.
5858
In the right-most pane (`settings.json`), insert the setting below appropriate for your OS somewhere between the two curly brackets (`{` and `}`) and replace *<version>* with the installed PowerShell version:
5959

@@ -71,6 +71,22 @@ If you wish to use a specific installation of PowerShell with Visual Studio Code
7171
3. Replace the setting with the path to the desired PowerShell executable
7272
4. Save the settings file and restart Visual Studio Code
7373

74+
#### Configuration settings for Visual Studio Code
75+
76+
By using the steps in the previous paragraph you can add configuration settings in `settings.json`.
77+
78+
We recommend the following configuration settings for Visual Studio Code:
79+
80+
```json
81+
{
82+
"csharp.suppressDotnetRestoreNotification": true,
83+
"editor.renderWhitespace": "all",
84+
"editor.renderControlCharacters": true,
85+
"omnisharp.projectLoadTimeout": 120,
86+
"files.trimTrailingWhitespace": true
87+
}
88+
```
89+
7490
Debugging with Visual Studio Code
7591
----
7692
### No-workspace debugging

0 commit comments

Comments
 (0)