-
Notifications
You must be signed in to change notification settings - Fork 513
Add first steps to ISE compatibility doc #1632
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
Merged
Merged
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
8e17de7
Add ISE compatibility doc
rjmholt e4b3af6
Add more keybindings, in table form
rjmholt dd272e4
Add command explorer
rjmholt dd37587
Fix unmatched <kbd>
rjmholt 2d67652
Add ISE F8
rjmholt 7878158
Add more bits
rjmholt 2e37998
Update docs/ise_compatibility.md
SeeminglyScience 002f3a1
Update docs/ise_compatibility.md
SeeminglyScience 51038c7
Update docs/ise_compatibility.md
SeeminglyScience c5a1cb0
Tab completion
rjmholt fce17ac
Add ISE keybinding for snippets
3359591
Change command explorer wording
7c45e96
Add UI remark to troubleshooting doc
f24529c
Add custom keybinding note
8efca90
Minor edit
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,123 @@ | ||
# ISE Compatibility | ||
|
||
While the PowerShell extension for VSCode does not seek | ||
complete feature parity with the PowerShell ISE, | ||
there are features in place to make the VSCode experience more natural | ||
for users of the ISE. | ||
|
||
This document tries to list settings you can configure in VSCode | ||
to make the user experience a bit more familiar compared to the ISE. | ||
|
||
## Key bindings | ||
|
||
| Function | ISE Binding | VSCode Binding | | ||
| ---------------- | ----------- | -------------- | | ||
| Interrupt and break debugger | <kbd>Ctrl</kbd>+<kbd>B</kbd> | <kbd>F6</kbd> | | ||
| Execute current line/highlighted text | <kbd>F8</kbd> | <kbd>F8</kbd> | | ||
| List available snippets | <kbd>Ctrl</kbd>+<kbd>J</kbd> | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>J</kbd> | | ||
|
||
### Custom Keybindings | ||
|
||
You can [configure your own keybindings](https://code.visualstudio.com/docs/getstarted/keybindings#_custom-keybindings-for-refactorings) | ||
in VSCode as well. | ||
|
||
## Tab completion | ||
|
||
To enable more ISE-like tab completion, add this setting: | ||
|
||
```json | ||
"editor.tabCompletion": "on" | ||
``` | ||
|
||
This is a setting added directly to VSCode (rather than in the extension), | ||
so its behavior is determined by VSCode directly and cannot be changed by the extension. | ||
|
||
## No focus on console when executing | ||
|
||
To keep the focus in the editor when you execute with <kbd>F8</kbd>: | ||
|
||
```json | ||
"powershell.integratedConsole.focusConsoleOnExecute": false | ||
``` | ||
|
||
The default is `true` for accessibility purposes. | ||
|
||
## Do not start integrated console on startup | ||
|
||
To stop the integrated console on startup, set: | ||
|
||
```json | ||
"powershell.integratedConsole.showOnStartup": false | ||
``` | ||
|
||
**Note:** The background PowerShell process will still start, | ||
since that provides intellisense, script analysis, symbol navigation, etc. | ||
But the console will not be shown. | ||
|
||
## Assume files are PowerShell by default | ||
|
||
To make new/untitled files register as PowerShell by default: | ||
|
||
```json | ||
"files.defaultLanguage": "powershell" | ||
``` | ||
|
||
## Color scheme | ||
|
||
There are a number of ISE themes available for VSCode | ||
to make the editor look much more like the ISE. | ||
|
||
In the [Command Palette] | ||
type `theme` to get `Preferences: Color Theme` and press <kbd>Enter</kbd>. | ||
In the drop down list, select `PowerShell ISE`. | ||
|
||
You can set this in the settings with: | ||
|
||
```json | ||
"workbench.colorTheme": "PowerShell ISE" | ||
``` | ||
|
||
## PowerShell Command Explorer | ||
|
||
Thanks to the work of [@corbob](https://github.com/corbob), | ||
the PowerShell extension has the beginnings of its own command explorer. | ||
|
||
In the [Command Palette] | ||
enter `PowerShell Command Explorer` and press <kbd>Enter</kbd>. | ||
|
||
## Open in the ISE | ||
|
||
If you end up wanting to open a file in the ISE anyway, | ||
you can use <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>P</kbd>. | ||
|
||
## Other resources | ||
|
||
- 4sysops has [a great article](https://4sysops.com/archives/make-visual-studio-code-look-and-behave-like-powershell-ise/) | ||
on configuring VSCode to be more like the ISE. | ||
- Mike F Robbins has [a really good post](https://mikefrobbins.com/2017/08/24/how-to-install-visual-studio-code-and-configure-it-as-a-replacement-for-the-powershell-ise/) on setting up VSCode. | ||
- Learn PowerShell has [an excellent write up](https://www.learnpwsh.com/setup-vs-code-for-powershell/) | ||
on getting VSCode setup for PowerShell. | ||
|
||
## More settings | ||
|
||
If you know of more ways to make VSCode feel more familiar | ||
for ISE users, please contribute to this doc. | ||
If there's a compatibility configuration you're looking for, | ||
but you can't find any way to enable it, | ||
please [open an issue](https://github.com/PowerShell/vscode-powershell/issues/new/choose) | ||
and ask away! | ||
|
||
We are always happy to accept PRs and contributions as well! | ||
|
||
## VSCode Tips | ||
|
||
### Command Palette | ||
|
||
<kbd>F1</kbd> OR <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> | ||
(<kbd>Cmd</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> on macOS) | ||
|
||
A handy way of executing commands in VSCode. | ||
See [the VSCode docs](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) | ||
for more details. | ||
|
||
[Command Palette]: #command-palette |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.