admin/PowerShell-PowerShell
1
0
Fork 0
mirror of https://github.com/PowerShell/PowerShell synced 2026-06-08 12:12:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update using-vscode.md documentation

Browse Source 
This change updates the "Using Visual Studio Code" documentation to give
guidance on how to configure VS Code on to use a specific installation
of PowerShell.
This commit is contained in:
David Wilson
2016-08-18 09:01:18 -07:00
parent 3b6fd89730
commit a8efa49dbf
4 changed files with 45 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/learning-powershell/README.md
-5
View File
@@ -61,13 +61,8 @@ Click on the link below to learn more about debugging:
- [Using Visual Studio Code (VS Code)][use-vscode-debugger]
- [PowerShell Command-line Debugging][cli-debugging]
On Windows, you can also use [PowerShell Integrated Scripting Environment (ISE)][use-ise-editor] to edit or debug PowerShell scripts.
However it is not supported if you are using PowerShell installed from the [PowerShell package][get-powershell] or directly [built][build-powershell] from GitHub.
[use-vscode-editor]:./using-vscode.md#editing-with-vs-code
[use-ise-editor]:./using-ise.md#editing-with-ise
[use-vscode-debugger]:./using-vscode.md#debugging-with-vs-code
[use-ise-debugger]:./using-ise.md#debugging-with-ise
[cli-debugging]:./debugging-from-commandline.md
[get-powershell]:../../README.md#get-powershell
[build-powershell]:../../README.md#building-the-repository
docs/learning-powershell/debugging-from-commandline.md
+1 -1
View File
@@ -1,7 +1,7 @@
Debugging in PowerShell Command-line
=====
As we know, we can debug PowerShell code via GUI tools like [VS Code](./using-vscode.md#debugging-with-vs-code) or [ISE](./using-ise.md#debugging-with-ise). In addition, we can directly perform debugging within the PowerShell command-line session by using the PowerShell debugger cmdlets. This document demonstrates how to use the cmdlets for the PowerShell command-line debugging. We will cover the following topics: setting a debug breakpoint on a line of code and on a variable.
As we know, we can debug PowerShell code via GUI tools like [Visual Studio Code](./using-vscode.md#debugging-with-vs-code). In addition, we can directly perform debugging within the PowerShell command-line session by using the PowerShell debugger cmdlets. This document demonstrates how to use the cmdlets for the PowerShell command-line debugging. We will cover the following topics: setting a debug breakpoint on a line of code and on a variable.
Let's use the following code snippet as our sample script.
docs/learning-powershell/using-ise.md
-77
View File
@@ -1,77 +0,0 @@
Using PowerShell Integrated Scripting Environment (ISE)
====
The PowerShell ISE only works on Windows. If you are not using Windows, please see [Using Visual Studio Code](./using-vscode.md).
Please note the ISE is not supported if you are using PowerShell installed from the [PowerShell package][get-powershell] or directly [built][build-powershell] from GitHub.
Editing with ISE
---
- Launch PowerShell ISE
* Press Windows Key -> type "PowerShell ISE", click on PowerShell ISE to launch the ISE
- Create a new PowerShell Script
* Click on **File->New**
* Add a few lines of PowerShell code in your newly created file. In this case, we will use the following script snippet.
```PowerShell
# Convert Fahrenheit to Celsius
function ConvertFahrenheitToCelsius([double] $fahrenheit)
{
$celsius = $fahrenheit - 32
$celsius = $celsius / 1.8
$celsius
}
$fahrenheit = Read-Host 'Input a temperature in Fahrenheit'
$result =[int](ConvertFahrenheitToCelsius($fahrenheit))
Write-Host "$result Celsius"
```
* **Note**: You can find more examples [here](http://examples.oreilly.com/9780596528492/).
- To save the script file
* Click on **File->Save As**. Then type "helloworld.ps1"
- To close the helloworld.ps1 file
* **File->Close**
- To reopen the helloworld.ps1 file
* **File->Open**, then choose helloworld.ps1
- For more details, go to [How to Write and Run Scripts in the Windows PowerShell ISE](https://msdn.microsoft.com/en-us/powershell/scripting/core-powershell/ise/how-to-write-and-run-scripts-in-the-windows-powershell-ise).
Debugging with ISE
----
To execute the entire script file, you can press **F5**. To execute several lines of your scripts, simply select them and press **F8**. If you would like to stop the execution on a particular line in order to examine some variables to check if the program runs as expected. In that case, you may follow the steps below. Let's take the helloworld.ps1 as an example and assume line 17 is the place where you want to stop.
- Set a break point: Move mouse over on the line 17, and press **F9**. You will see the line 17 is highlighted, which means a breakpoint is set.
- Press **F5** to run the script
- Enter 80 (or any number in Fahrenheit) from the command line prompt
- Notice that the ISE output pane becomes “[DBG]: PS C:\Test>>” prompt. This means the program is in the debugging mode. It stops at Line 17:
```PowerShell
PS C:\test> C:\test\helloword.ps1
Input a temperature in Fahrenheit: 80
Hit Line breakpoint on 'C:\test\helloword.ps1:17'
''[DBG]: PS C:\test>>'
```
- From the output pane, you can type $celsius and $fahrenheit to examine the values of these variables to see if they are correct.
```PowerShell
[DBG]: PS C:\Test>> $celsius
26.6666666666667
[DBG]: PS C:\Tset>> $fahrenheit
80
```
- Press **F5** to let the program continue running
```PowerShell
[DBG]: PS C:\test>>
27 Celsius
PS C:\test>
```
See [How to Debug in ISE][debug] for more information.
[debug]:https://msdn.microsoft.com/en-us/powershell/scripting/core-powershell/ise/how-to-debug-scripts-in-windows-powershell-ise#bkmk_2
[get-powershell]:../../README.md#get-powershell
[build-powershell]:../../README.md#building-the-repository
docs/learning-powershell/using-vscode.md
+44 -30
View File
@@ -1,25 +1,24 @@
Using Visual Studio Code (VS Code)
Using Visual Studio Code for PowerShell Development
====
If you are working on Linux and OS X, you cannot use ISE because it is not supported on these platforms.
If you are working on Linux and OS X, you cannot use the PowerShell ISE because it is not supported on these platforms.
In this case, you can choose your favorite editor to write PowerShell scripts.
Here we choose VS Code as a PowerShell editor as an example.
Here we choose Visual Studio Code as a PowerShell editor.
You can use VS Code on Windows with PowerShell V5 by using Windows 10 or by installing [Windows Management Framework 5.0 RTM](https://www.microsoft.com/en-us/download/details.aspx?id=50395) for down-level Windows OSs (e.g. Windows 8.1, etc.).
You can use Visual Studio Code on Windows with PowerShell version 5 by using Windows 10 or by installing [Windows Management Framework 5.0 RTM](https://www.microsoft.com/en-us/download/details.aspx?id=50395) for down-level Windows OSs (e.g. Windows 8.1, etc.).
Before starting it, please make sure PowerShell exists on your system.
By following the [Installing PowerShell](./README.md#installing-powershell) instructions you can install PowerShell and launch a PowerShell session.
Editing with VS Code
Editing with Visual Studio Code
----
[**1. Installing VS Code**](https://code.visualstudio.com/Docs/setup/setup-overview)
[**1. Installing Visual Studio Code**](https://code.visualstudio.com/Docs/setup/setup-overview)
* **Linux**: follow the Installation instructions in the [Running VS Code on Linux](https://code.visualstudio.com/docs/setup/linux) to setup VS Code application
* **Linux**: follow the installation instructions on the [Running VS Code on Linux](https://code.visualstudio.com/docs/setup/linux) page
* **OS X**: follow the installation instructions on the [Running VS Code on OS X](https://code.visualstudio.com/docs/setup/osx) page
* **OS X**: follow the Installation instructions in the [Running VS Code on OS X](https://code.visualstudio.com/docs/setup/osx) to setup VS Code application
* **Windows**: download and install VS Code for your OS from [Visual Studio Code website](https://code.visualstudio.com/docs/setup/windows).
* **Windows**: follow the installation instructions on the [Running VS Code on Windows](https://code.visualstudio.com/docs/setup/windows) page
**2. Installing PowerShell Extension**
@@ -30,8 +29,8 @@ Editing with VS Code
* **OS X**: typing **code** in your terminal
- Press **F1** (or **Ctrl+Shift+P**) which opens up the “Command Palette” inside the VS Code app.
- In the command palette, type **ext install** and hit **Enter**. It will show all VS Code extensions available on your system.
- Press **F1** (or **Ctrl+Shift+P**) which opens up the "Command Palette" inside the Visual Studio Code app.
- In the command palette, type **ext install** and hit **Enter**. It will show all Visual Studio Code extensions available on your system.
- Choose PowerShell and click on **Install**, you will see something like below
![VSCode](vscode.png)
@@ -42,15 +41,38 @@ Editing with VS Code
For example, to create a new file, click **File->New**.
To save it, click **File->Save** and then provide a file name, let's say "helloworld.ps1".
To close the file, click on "x" next to the file name.
To exit VS Code, **File->Exit**.
To exit Visual Studio Code, **File->Exit**.
#### Using a specific installed version of PowerShell
Debugging with VS Code
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.
1. Click **File -> Preferences -> User Settings**
2. Two editor panes will appear. 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:
```json
// On Windows:
"powershell.developer.powerShellExePath": "c:/Program Files/PowerShell/<version>/powershell.exe"
// On Linux:
"powershell.developer.powerShellExePath": "/opt/microsoft/powershell/<version>/powershell"
// On OS X:
"powershell.developer.powerShellExePath": "/usr/local/microsoft/powershell/<version>/powershell"
```
3. Replace the setting with the path to the desired PowerShell executable
4. Save the settings file and restart Visual Studio Code
Debugging with Visual Studio Code
----
- Open a file folder (**File->Open Folder**) that contains the PowerShell modules or scripts you have written already and want to debug.
In this example, we saved the helloworld.ps1 under a directory called "demo".
Thus we select the "demo" folder and open it in VS Code.
Thus we select the "demo" folder and open it in Visual Studio Code.
- Creating the Debug Configuration (launch.json)
@@ -60,9 +82,9 @@ Thus we select the "demo" folder and open it in VS Code.
* Click on the **Debug** icon (or **Ctrl+Shift+D**)
* Click on the **Settings** icon that looks like a gear.
VS Code will prompt you to **Select Environment**.
Visual Studio Code will prompt you to **Select Environment**.
Choose **PowerShell**.
Then VS code will auto create a debug configuration settings file in the same folder.
Then Visual Studio Code will auto create a debug configuration settings file in the same folder.
It looks like the following:
```json
{
@@ -75,14 +97,6 @@ It looks like the following:
"program": "${file}",
"args": [],
"cwd": "${file}"
},
{
"name": "PowerShell x86",
"type": "PowerShell x86",
"request": "launch",
"program": "${file}",
"args": [],
"cwd": "${file}"
}
]
}
@@ -93,12 +107,12 @@ It looks like the following:
The execution should stop on the line you put the breakpoint on.
- Press **F5** to continue running the script.
There are a few blogs that may be helpful to get you started using PowerShell extension for VS Code
There are a few blogs that may be helpful to get you started using PowerShell extension for Visual Studio Code
- Visual Studio Code: [PowerShell Extension][ps-extension]
- [Write and debug PowerShell scripts in Visual Studio Code][debug]
- [Debugging VS Code Guidance][vscode-guide]
- [Debugging PowerShell in VS Code][ps-vscode]
- [Debugging Visual Studio Code Guidance][vscode-guide]
- [Debugging PowerShell in Visual Studio Code][ps-vscode]
[ps-extension]:https://blogs.msdn.microsoft.com/cdndevs/2015/12/11/visual-studio-code-powershell-extension/
@@ -106,7 +120,7 @@ There are a few blogs that may be helpful to get you started using PowerShell ex
[vscode-guide]:https://johnpapa.net/debugging-with-visual-studio-code/
[ps-vscode]:https://github.com/PowerShell/vscode-powershell-ops/tree/master/vscode-powershell/examples
PowerShell Extension for VS Code
PowerShell Extension for Visual Studio Code
----
PowerShell extension source code can be found [GitHub](https://github.com/PowerShell/vscode-powershell-ops).
The PowerShell extension's source code can be found on [GitHub](https://github.com/PowerShell/vscode-powershell-ops).