Automating Visual Studio Code

Automate Visual Studio Code with PowerShell

Overview

Using PowerShell Pro Tools for Visual Studio Code you can automate the editor itself. This allows you to script repetitive actions you may take within Visual Studio Code. You can edit documents, show information and more.

Getting Started

To automate Visual Studio Code, you will need to first import the PowerShell Pro Tools VS Code module .

PS C:\> Import-Module PowerSHellProTools.VSCode

Once the module is loaded, you can begin running commands.

PS C:\> Get-VSCodeTerminal
Name : pwsh
Id : 1
Columns : 0
Rows : 0
CreationOptions : - C:\Program Files\PowerShell\7\pwsh.exe
Name : PowerShell Integrated Console
Id : 2
Columns : 140
Rows : 13
CreationOptions : PowerShell Integrated Console - C:\Program Files\PowerShell\7\pwsh.exe

Available Commands

Opening Documents

Open documents by file name.

PS C:\> Open-VSCodeTextDocument -FileName .\form.designer.ps1

Closing Text Editors

Close editors that are already open.

PS C:\> Get-VSCodeTextEditor | Remove-VSCodeTextEditor

Getting Document Text

Get the text of a document. You can also pass in a range to select only a partial section of the text.

PS C:\> Get-VSCodeTextDocument | Get-VSCodeTextDocumentText

Inserting Text

Inserts text into a particular position in the selected document. This creates an edit but does not save the file.

PS C:\> $position = New-VSCodePosition -Line 0 -Character 2
PS C:\> Get-VSCodeTextDocument | Add-VSCodeTextDocumentText -Position $position -Text NewText

Removing Text

Removes a range of text from a document. This creates an edit but does not save the file.

PS C:\> $Range = New-VSCodeRange -StartLine 0 -EndLine 0 -StartCharacter 0 -EndCharacter 10
PS C:\> Get-VSCodeTextDocument | Remove-VSCodeTextDocumentText -Range $Range

Setting Text Decorations

Decorates a range of text with an optional set of colors, outlines, borders, and text.

PS C:\> $Range = New-VSCodeRange -StartLine 0 -EndLine 0 -StartCharacter 0 -EndCharacter 55
PS C:\> Get-VSCodeTextEditor | Set-VSCodeTextEditorDecoration -BackgroundColor 'descriptionForeground' -Range $Range -Key 12321 -FontWeight bold

You can clear decorations by using the Clear-VSCodeTextEditorDecoration cmdlet. If you want to only clear a single decoration, you can specify the key.

Sending Text to a Terminal

Sends text to the specified terminal. You can commit this text by including the -AddNewLine parameter.

PS C:\> Get-VSCodeTerminal | Where-Object Name -eq 'PowerShell Integrated Console' | Send-VSCodeTerminalText -Text 'Write-Host "Hello World!"'

Showing Messages

Show a message to the user. You can show information, warning, and error messages.

PS C:\> Show-VSCodeMessage -Message 'Error!!!' -Type Error

Showing a Message with a Response

Show a message to the user and provide an option for them to select.

PS C:\> Show-VSCodeMessage -Message 'What should we do?' -Items @('Party', 'Sleep')

Showing a Quick Pick List

Shows a quick pick list for a user to select items from. This cmdlet will return the user’s selection to PowerShell.

PS C:\> Show-VSCodeQuickPick -PlaceHolder 'What should we do?' -Items @('Party', 'Sleep')

Showing an Input Box

Shows an input box for the user to enter arbitrary text. This cmdlet will return the result to PowerShell.

PS C:\> Show-VSCodeInputBox -PlaceHolder 'Enter some text'

Set Status Bar Message

Sets the status bar message.

PS C:\> Set-VSCodeStatusBarMessage -Message 'Hellllloooo'