From 68e984200a2153c0a94879a9519d7212e9573c9f Mon Sep 17 00:00:00 2001 From: TMA-2 Date: Thu, 13 Mar 2025 12:39:29 -0500 Subject: [PATCH 1/7] Adding code tour and NewTreeItemCommand inline help --- .tours/powershell-pro-tools-for-vs-code.tour | 40 ++++++++++++++++++ HostInjection/NewTreeItemCommand.cs | 43 +++++++++++++------- 2 files changed, 69 insertions(+), 14 deletions(-) create mode 100644 .tours/powershell-pro-tools-for-vs-code.tour diff --git a/.tours/powershell-pro-tools-for-vs-code.tour b/.tours/powershell-pro-tools-for-vs-code.tour new file mode 100644 index 0000000..be1dff5 --- /dev/null +++ b/.tours/powershell-pro-tools-for-vs-code.tour @@ -0,0 +1,40 @@ +{ + "$schema": "https://aka.ms/codetour-schema", + "title": "PowerShell Pro Tools for VS Code", + "steps": [ + { + "title": "Requirements", + "description": "You'll need the following installed:\r\n- [VS Code](https://code.visualstudio.com/)\r\n- [NodeJS](https://nodejs.org/en)\r\n- [.NET](https://dotnet.microsoft.com/en-us/download)\r\n- [Visual Studio 2022](https://visualstudio.microsoft.com/vs/community/)\r\n- [InvokeBuild](https://github.com/nightroman/Invoke-Build)" + }, + { + "title": "Build Process", + "description": "You can use the `./vscode/vscode.build.ps1` build script to build the extension. It will install the necessary NPM\r\npackages, build the .NET libraries and package the VSIX.\r\n```ps1\r\nSet-Location ./vscode\r\nInvoke-Build\r\n```", + "file": "vscode/vscode.build.ps1" + }, + { + "title": "Debugging", + "description": "You will need to run the `./vscode/vscode.build.ps1` script once to ensure all the proper binaries are generated. Once this is done, you can open VS Code in the `./vscode/powershellprotools` directory.\r\n```ps1\r\ncode ./vscode/powershellprotools\r\n```\r\nOnce open, you can begin debugging by pressing `F5`. You can set breakpoints and step through the extension.", + "file": "vscode/vscode.build.ps1" + }, + { + "directory": "vscode/powershellprotools", + "description": "### VS Code Extension\r\nThe Typescript project that integrates with Visual Studio Code. " + }, + { + "directory": "HostInjection", + "description": "### VS Code Module\r\nThe .NET DLL that is loaded into the PowerShell Extension terminal. This includes the bulk of the functionality and the Named Pipe Server that accepts commands from the VS Code extension. This includes the implementation for features such as:\r\n\r\n- Refactoring\r\n- Profiling\r\n- Code Decompilation\r\n- VS Code Automation Cmdlets" + }, + { + "directory": "PowerShellToolsPro.Cmdlets", + "description": "### PowerShell Pro Tools Module\r\nThis module is included with the extension and used for packaging PowerShell scripts into executables." + }, + { + "directory": "WinFormDesigner", + "description": "### Windows Form Designer\r\nThe Windows Form Designer executable." + }, + { + "directory": "FormDesigner", + "description": "### Windows Form Designer Library\r\nThe bulk of the form designer parsing and generation logic." + } + ] +} \ No newline at end of file diff --git a/HostInjection/NewTreeItemCommand.cs b/HostInjection/NewTreeItemCommand.cs index 1ca2889..5a81bf3 100644 --- a/HostInjection/NewTreeItemCommand.cs +++ b/HostInjection/NewTreeItemCommand.cs @@ -3,23 +3,38 @@ namespace PowerShellToolsPro.Cmdlets.VSCode { - [Cmdlet(VerbsCommon.New, "VSCodeTreeItem")] + /// + /// Creates a new VSCode custom tree item. + /// This cmdlet creates a new VSCode custom tree item underneath a parent tree view or another tree item. + /// It's meant to be used in conjunction with the Register-VSCodeTreeView -LoadChildren cmdlet parameter. + /// + /// + /// New-VSCodeTreeItem -Label "Item1" -Description "This is item 1" -Icon "account" -Tooltip "Hovering over Item1" + /// Creates a new treeview item with a label (which doubles as the treeViewId), description, and tooltip. + /// + /// + /// New-VSCodeTreeItem -Label "Item2" -HasChildren -DisableInvoke + /// Creates a new treeview item with the label "Item2" that has children but no invoke button. + /// + /// + [Cmdlet(VerbsCommon.New, "VSCodeTreeItem")] public class NewTreeItemCommand : PSCmdlet { - [Parameter(Mandatory = true)] - public string Label { get; set; } - [Parameter()] - public string Description { get; set; } - [Parameter()] - public string Tooltip { get; set; } - [Parameter()] - public string Icon { get; set; } - [Parameter()] - public SwitchParameter HasChildren { get; set; } - [Parameter()] - public SwitchParameter DisableInvoke { get; set; } + [Parameter(Mandatory = true, HelpMessage = "The label of the tree item.")] + public string Label { get; set; } + [Parameter(HelpMessage = "The description of the tree item. Appears to the right of the label.")] + public string Description { get; set; } + [Parameter(HelpMessage = "The tooltip for the tree item.")] + public string Tooltip { get; set; } + [Parameter(HelpMessage = "The icon for the tree item, taken from codicons.")] + public string Icon { get; set; } + [Parameter(HelpMessage = "Indicates that the tree item can contain children.")] + public SwitchParameter HasChildren { get; set; } - protected override void BeginProcessing() + [Parameter(HelpMessage = "Indicates that the tree item is not invokable.")] + public SwitchParameter DisableInvoke { get; set; } + + protected override void BeginProcessing() { WriteObject(new TreeItem { Description = Description, From 3a1061e9bb1b989264813a133851c1c86036e17a Mon Sep 17 00:00:00 2001 From: "Jon D." Date: Thu, 13 Mar 2025 13:15:44 -0500 Subject: [PATCH 2/7] Added Markdown help files for 20 VSCode automation commands, with 8 remaining --- .../Help/Add-VSCodeTextDocumentText.md | 122 +++++ HostInjection/Help/Clear-VSCodeDecoration.md | 100 ++++ HostInjection/Help/Get-VSCodeTerminal.md | 76 +++ HostInjection/Help/Get-VSCodeTextDocument.md | 86 ++++ .../Help/Get-VSCodeTextDocumentText.md | 114 +++++ HostInjection/Help/Get-VSCodeTextEditor.md | 79 ++++ HostInjection/Help/New-VSCodePosition.md | 117 +++++ HostInjection/Help/New-VSCodeRange.md | 147 ++++++ HostInjection/Help/New-VSCodeTreeItem.md | 155 ++++++ HostInjection/Help/Open-VSCodeTextDocument.md | 93 ++++ HostInjection/Help/Out-VSCodeGridView.md | 167 +++++++ HostInjection/Help/Register-VSCodeTreeView.md | 156 ++++++ .../Help/Remove-VSCodeTextDocumentText.md | 109 +++++ HostInjection/Help/Remove-VSCodeTextEditor.md | 93 ++++ HostInjection/Help/Send-VSCodeTerminalText.md | 148 ++++++ .../Help/Set-VSCodeStatusBarMessage.md | 108 +++++ .../Help/Set-VSCodeTextEditorDecoration.md | 445 ++++++++++++++++++ HostInjection/Help/Show-VSCodeInputBox.md | 183 +++++++ HostInjection/Help/Show-VSCodeMessage.md | 139 ++++++ HostInjection/Help/Show-VSCodeQuickPick.md | 138 ++++++ HostInjection/Help/Todo/Get-CompletionItem.md | 240 ++++++++++ .../Help/Todo/Get-PoshToolsVariable.md | 90 ++++ HostInjection/Help/Todo/Measure-Block.md | 173 +++++++ HostInjection/Help/Todo/Measure-Script.md | 96 ++++ .../Todo/New-VSCodeDecorationAttachment.md | 228 +++++++++ .../Help/Todo/Out-PoshToolsVariable.md | 106 +++++ .../Help/Todo/PowerShellProTools.VSCode.md | 94 ++++ .../Help/Todo/Start-PoshToolsServer.md | 75 +++ 28 files changed, 3877 insertions(+) create mode 100644 HostInjection/Help/Add-VSCodeTextDocumentText.md create mode 100644 HostInjection/Help/Clear-VSCodeDecoration.md create mode 100644 HostInjection/Help/Get-VSCodeTerminal.md create mode 100644 HostInjection/Help/Get-VSCodeTextDocument.md create mode 100644 HostInjection/Help/Get-VSCodeTextDocumentText.md create mode 100644 HostInjection/Help/Get-VSCodeTextEditor.md create mode 100644 HostInjection/Help/New-VSCodePosition.md create mode 100644 HostInjection/Help/New-VSCodeRange.md create mode 100644 HostInjection/Help/New-VSCodeTreeItem.md create mode 100644 HostInjection/Help/Open-VSCodeTextDocument.md create mode 100644 HostInjection/Help/Out-VSCodeGridView.md create mode 100644 HostInjection/Help/Register-VSCodeTreeView.md create mode 100644 HostInjection/Help/Remove-VSCodeTextDocumentText.md create mode 100644 HostInjection/Help/Remove-VSCodeTextEditor.md create mode 100644 HostInjection/Help/Send-VSCodeTerminalText.md create mode 100644 HostInjection/Help/Set-VSCodeStatusBarMessage.md create mode 100644 HostInjection/Help/Set-VSCodeTextEditorDecoration.md create mode 100644 HostInjection/Help/Show-VSCodeInputBox.md create mode 100644 HostInjection/Help/Show-VSCodeMessage.md create mode 100644 HostInjection/Help/Show-VSCodeQuickPick.md create mode 100644 HostInjection/Help/Todo/Get-CompletionItem.md create mode 100644 HostInjection/Help/Todo/Get-PoshToolsVariable.md create mode 100644 HostInjection/Help/Todo/Measure-Block.md create mode 100644 HostInjection/Help/Todo/Measure-Script.md create mode 100644 HostInjection/Help/Todo/New-VSCodeDecorationAttachment.md create mode 100644 HostInjection/Help/Todo/Out-PoshToolsVariable.md create mode 100644 HostInjection/Help/Todo/PowerShellProTools.VSCode.md create mode 100644 HostInjection/Help/Todo/Start-PoshToolsServer.md diff --git a/HostInjection/Help/Add-VSCodeTextDocumentText.md b/HostInjection/Help/Add-VSCodeTextDocumentText.md new file mode 100644 index 0000000..dabf6f1 --- /dev/null +++ b/HostInjection/Help/Add-VSCodeTextDocumentText.md @@ -0,0 +1,122 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Add-VSCodeTextDocumentText + +## SYNOPSIS +Inserts text into a particular position in the selected document. This creates an edit but does not save the file. + +## SYNTAX + +``` +Add-VSCodeTextDocumentText -TextDocument -Position -Text [-Wait] + [-ResponseTimeout ] [-ProgressAction ] [] +``` + +## DESCRIPTION +Given a TextDocument and Position, this cmdlet inserts text into the selected document. This creates an edit but does not save the file. + +## EXAMPLES + +### Example 1 +```powershell +Get-VSCodeTextDocument | Add-VSCodeTextDocumentText -Position (New-VSCodePosition -Line 0 -Character 0) -Text '# I came from Add-VSCodeTextDocumentText!' +``` + +This inserts a comment at the start of the current file. + +## PARAMETERS + +### -Position +A position (line and column) in the document, created with New-VSCodePosition. + +```yaml +Type: VsCodePosition +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseTimeout +How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Text +The text to insert. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextDocument +An object representing the document to interact with. Retrieve with Get-VSCodeTextDocument. + +```yaml +Type: VsCodeTextDocument +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Wait +Whether to wait for the cmdlet to finish or return immediately. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -ProgressAction, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS +https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Clear-VSCodeDecoration.md b/HostInjection/Help/Clear-VSCodeDecoration.md new file mode 100644 index 0000000..c81d548 --- /dev/null +++ b/HostInjection/Help/Clear-VSCodeDecoration.md @@ -0,0 +1,100 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Clear-VSCodeDecoration + +## SYNOPSIS +Clear decorations created by Set-VSCodeTextEditorDecoration. + +## SYNTAX + +``` +Clear-VSCodeDecoration [-Key ] [-Wait] [-ResponseTimeout ] [-ProgressAction ] + [] +``` + +## DESCRIPTION +This cmdlet clears all decorations, or just one if `-Key` is specified. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Clear-VSCodeDecoration +``` + +Clears all decorations. + +### Example 2 +```powershell +PS C:\> Clear-VSCodeDecoration -Key 12321 +``` + +Clears the decoration associated with key `12321`. + +## PARAMETERS + +### -Key +The specific decoration to clear when it was set with `-Key`, instead of all. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseTimeout +How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Whether to wait for the cmdlet to finish or return immediately. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Get-VSCodeTerminal.md b/HostInjection/Help/Get-VSCodeTerminal.md new file mode 100644 index 0000000..10be35d --- /dev/null +++ b/HostInjection/Help/Get-VSCodeTerminal.md @@ -0,0 +1,76 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Get-VSCodeTerminal + +## SYNOPSIS +Retrieves a list of open terminals. + +## SYNTAX + +``` +Get-VSCodeTerminal [-Wait] [-ResponseTimeout ] [-ProgressAction ] [] +``` + +## DESCRIPTION +This cmdlet gets the currently opened terminals, returning their names, IDs, columns, rows, and creation options. + +## EXAMPLES + +### Example 1 +```powershell +(Get-VSCodeTerminal -Wait)[-1] +``` + +This returns the last terminal in the list. + +## PARAMETERS + +### -ResponseTimeout +How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Whether to wait for the cmdlet to finish or return immediately. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS +https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Get-VSCodeTextDocument.md b/HostInjection/Help/Get-VSCodeTextDocument.md new file mode 100644 index 0000000..872b930 --- /dev/null +++ b/HostInjection/Help/Get-VSCodeTextDocument.md @@ -0,0 +1,86 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Get-VSCodeTextDocument + +## SYNOPSIS +Returns a list of currently open documents. + +## SYNTAX + +``` +Get-VSCodeTextDocument [-Wait] [-ResponseTimeout ] [-ProgressAction ] + [] +``` + +## DESCRIPTION +This cmdlet returns a list of open document paths. It can be piped into other cmdlets to make changes, i.e. `Add-VSCodeTextDocumentText`. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-VSCodeTextDocument | Get-VSCodeTextDocumentText +``` + +Retrieves the full text of the current document. + +### Example 2 +```powershell +PS C:\> Get-VSCodeTextDocument | Get-VSCodeTextDocumentText -Range (New-VSCodeRange -StartLine 10 -EndLine 20 -StartCharacter 0 -EndCharacter 16) +``` + +Retrieves lines 10 through 20 (up to column 16) of the current document. + +## PARAMETERS + +### -ResponseTimeout +How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Whether to wait for the cmdlet to finish or return immediately. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +Returns all open document paths, containing one FileName property. + +## RELATED LINKS +https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Get-VSCodeTextDocumentText.md b/HostInjection/Help/Get-VSCodeTextDocumentText.md new file mode 100644 index 0000000..be78d41 --- /dev/null +++ b/HostInjection/Help/Get-VSCodeTextDocumentText.md @@ -0,0 +1,114 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Get-VSCodeTextDocumentText + +## SYNOPSIS +Gets the text of a document. + +## SYNTAX + +``` +Get-VSCodeTextDocumentText -TextDocument [-Range ] [-Wait] + [-ResponseTimeout ] [-ProgressAction ] [] +``` + +## DESCRIPTION +This cmdlet gets the text of a document. You can also pass in a range to select only a partial section of the text. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-VSCodeTextDocument | Get-VSCodeTextDocumentText +``` + +Retrieves the full text of the current document. + +### Example 2 +```powershell +PS C:\> Get-VSCodeTextDocument | Get-VSCodeTextDocumentText -Range (New-VSCodeRange -StartLine 10 -EndLine 20 -StartCharacter 0 -EndCharacter 16) +``` + +Retrieves lines 10 through 20 (up to column 16) of the current document. + +## PARAMETERS + +### -Range +A range between a given start and end line and character/column. See: New-VSCodeRange. + +```yaml +Type: VsCodeRange +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseTimeout +How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextDocument +The text document to interact with. See: Get-VSCodeTextDocument. + +```yaml +Type: VsCodeTextDocument +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Wait +Whether to wait for the cmdlet to finish or return immediately. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument + +## OUTPUTS + +### System.Object +## NOTES +The lines and characters used in -Range are 0-index (like an array), so for instance, to get line 10 in the editor, you'd actually specify line 9. +## RELATED LINKS +https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Get-VSCodeTextEditor.md b/HostInjection/Help/Get-VSCodeTextEditor.md new file mode 100644 index 0000000..96ff5b4 --- /dev/null +++ b/HostInjection/Help/Get-VSCodeTextEditor.md @@ -0,0 +1,79 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Get-VSCodeTextEditor + +## SYNOPSIS +Retrieves the currently visible text editor. + +## SYNTAX + +``` +Get-VSCodeTextEditor [-Wait] [-ResponseTimeout ] [-ProgressAction ] + [] +``` + +## DESCRIPTION +This cmdlet returns a list of the currently visible editors along with their language ID. So, if you have two groups open, it will return the visible file paths in each group. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> (Get-VSCodeTextEditor)[0] +``` + +Returns the first visible text editor. + +## PARAMETERS + +### -ResponseTimeout +How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Whether to wait for the cmdlet to finish or return immediately. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES +Unlike Get-VSCodeTextDocument, this only returns the open editors that are currently visible. + +Each item has a Document and LanguageId property. The Document property is actually VSCodeTextDocument, which can be piped to any cmdlet that accepts Get-VSCodeTextDocument. +## RELATED LINKS +https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/New-VSCodePosition.md b/HostInjection/Help/New-VSCodePosition.md new file mode 100644 index 0000000..fc2257d --- /dev/null +++ b/HostInjection/Help/New-VSCodePosition.md @@ -0,0 +1,117 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# New-VSCodePosition + +## SYNOPSIS +Returns a position in a given document. + +## SYNTAX + +``` +New-VSCodePosition -Line -Character [-Wait] [-ResponseTimeout ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +This cmdlet returns a position in a given document. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-VSCodePosition -Line 0 -Character 0 +``` + +Gets a position at the start. + +### Example 2 +```powershell +PS C:\> $position = New-VSCodePosition -Line 10 -Character 2 +PS C:\> Get-VSCodeTextDocument | Add-VSCodeTextDocumentText -Position $position -Text NewText +``` + +Adds text at position 10, 2 to the current document. + +## PARAMETERS + +### -Character +The 0-index character number. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Line +The 0-index line number. One less than the visible line number in the document. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseTimeout +How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Whether to wait for the cmdlet to finish or return immediately. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +Both lines and character positions are 0-index. + +## RELATED LINKS +https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/New-VSCodeRange.md b/HostInjection/Help/New-VSCodeRange.md new file mode 100644 index 0000000..a870348 --- /dev/null +++ b/HostInjection/Help/New-VSCodeRange.md @@ -0,0 +1,147 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# New-VSCodeRange + +## SYNOPSIS +Returns a range between start and end positions. + +## SYNTAX + +``` +New-VSCodeRange -StartLine -EndLine -StartCharacter -EndCharacter [-Wait] + [-ResponseTimeout ] [-ProgressAction ] [] +``` + +## DESCRIPTION +This cmdlet returns an object representing the range between two positions in a given document. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-VSCodeRange -StartLine 0 -EndLine 10 -StartCharacter 0 -EndCharacter 80 +``` + +Gets the range between the start of the document to line 10, character 80. + +### Example 2 +```powershell +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 +``` + +Sets the text decoration in a given range. + +## PARAMETERS + +### -EndCharacter +The 0-index end character. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndLine +The 0-index end line. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseTimeout +How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartCharacter +The 0-index beginning character. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartLine +The 0-index beginning line. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Whether to wait for the cmdlet to finish or return immediately. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The four required parameters are 0-index, meaning they're 1 less than the visible editor lines and columns. + +## RELATED LINKS +https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/New-VSCodeTreeItem.md b/HostInjection/Help/New-VSCodeTreeItem.md new file mode 100644 index 0000000..c468983 --- /dev/null +++ b/HostInjection/Help/New-VSCodeTreeItem.md @@ -0,0 +1,155 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# New-VSCodeTreeItem + +## SYNOPSIS +Creates a child tree item under a custom TreeView. + +## SYNTAX + +``` +New-VSCodeTreeItem -Label [-Description ] [-Tooltip ] [-Icon ] [-HasChildren] + [-DisableInvoke] [-ProgressAction ] [] +``` + +## DESCRIPTION +Given a TreeView item, creates a child TreeItem which can optionally have an action invoked when clicked. + +## EXAMPLES + +### Example 1 +```powershell +Register-VSCodeTreeView -Label 'Test' -LoadChildren { + 1..10 | % { New-VSCodeTreeItem -Label "Test$_" -Icon 'archive' -HasChildren } +} -Icon 'account' -InvokeChild { + Show-VSCodeMessage -Message $args[0].Path +} +``` + +Creates a tree view named Test that creates nested tree items. When each item is clicked, it will display a VS Code message. + +### Example 2 +```powershell +Register-VSCodeTreeView -Label 'GitHub' -LoadChildren { + New-VSCodeTreeItem -Label 'PowerShell Universal' -Description 'https://github.com/ironmansoftware/powershell-universal' -Icon 'github-inverted' + New-VSCodeTreeItem -Label 'Issues' -Description 'https://github.com/ironmansoftware/issues' -Icon 'github-inverted' + New-VSCodeTreeItem -Label 'PowerShell' -Description 'https://github.com/powershell/powershell' -Icon 'github-inverted' +} -Icon 'github' -InvokeChild { + Start-Process $args[0].Description +} +``` + +This example creates a tree view of GitHub repositories and opens each when clicked. + +## PARAMETERS + +### -Description +The item description, displayed to the right of the label / name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableInvoke +Indicate the item should not have a button to invoke an action. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasChildren +Indicates the item has further children, i.e. it can be folded and unfolded to display child items. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Icon +A codicon icon name to display. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Label +The main name of the item to display and reference it with. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tooltip +The text to display on hover. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/powershell-explorer#custom-tree-view \ No newline at end of file diff --git a/HostInjection/Help/Open-VSCodeTextDocument.md b/HostInjection/Help/Open-VSCodeTextDocument.md new file mode 100644 index 0000000..e0ec0cf --- /dev/null +++ b/HostInjection/Help/Open-VSCodeTextDocument.md @@ -0,0 +1,93 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Open-VSCodeTextDocument + +## SYNOPSIS +Opens documents by file name. + +## SYNTAX + +``` +Open-VSCodeTextDocument -FileName [-Wait] [-ResponseTimeout ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +Given a file path, the cmdlet opens the document to edit. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Open-VSCodeTextDocument -FileName .\form.designer.ps1 +``` + +Opens the file 'form.designer.ps1' to edit. + +## PARAMETERS + +### -FileName +The file path to open, whether relative or absolute. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseTimeout +How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Whether to wait for the cmdlet to finish or return immediately. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Out-VSCodeGridView.md b/HostInjection/Help/Out-VSCodeGridView.md new file mode 100644 index 0000000..fdd94ad --- /dev/null +++ b/HostInjection/Help/Out-VSCodeGridView.md @@ -0,0 +1,167 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Out-VSCodeGridView + +## SYNOPSIS +Displays data in a grid view similar to Out-GridView, except in a VS Code web view. + +## SYNTAX + +### PassThru (Default) +``` +Out-VSCodeGridView [-InputObject ] [-Title ] [-PassThru] [-Wait] [-ResponseTimeout ] + [-ProgressAction ] [] +``` + +### OutputMode +``` +Out-VSCodeGridView [-InputObject ] [-Title ] [-OutputMode ] [-Wait] + [-ResponseTimeout ] [-ProgressAction ] [] +``` + +## DESCRIPTION +Works the same as `Out-GridView`, except in a VS Code document. Uses the same parameters, allowing for pipeline-enabled passthru with optional item selection. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-Process | Out-VSCodeGridView +``` + +Shows all running processes. + +### Example 2 +```powershell +PS C:\> Get-History | Out-VSCodeGridView -OutputMode Multiple +``` + +Shows all commands run in the current session, returning selected items. + +## PARAMETERS + +### -InputObject +The object(s) to display. + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OutputMode +Works similarly to `Out-GridView -OutputMode `. + +Specifies the items that the interactive window sends down the pipeline as input to other commands. By default, this cmdlet does not generate any output. To send items from the interactive window down the pipeline, click to select the items and then click OK. + +The values of this parameter determine how many items you can send down the pipeline. + +```yaml +Type: OutputModeOption +Parameter Sets: OutputMode +Aliases: +Accepted values: None, Single, Multiple + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Works similar to `Out-GridView -PassThru`. + +Indicates that the cmdlet sends items from the interactive window down the pipeline as input to other commands. By default, this cmdlet does not generate any output. This parameter is equivalent to using the Multiple value of the `-OutputMode` parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: PassThru +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseTimeout +How long to wait before returning. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Title +Similar to `Out-GridView -Title "Window Title"`, the text to show in the document title. + +Specifies the text that appears in the title bar of the `Out-VSCodeGridView` document. By default, the title bar displays nothing. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Similar to `Out-GridView -Wait`, specifies that the cmdlet should halt processing until the window is closed. + +Indicates that the cmdlet suppresses the command prompt and prevents Windows PowerShell from closing until the `Out-VSCodeGridView` window is closed. By default, the command prompt returns when the `Out-VSCodeGridView` window opens. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### None +By default, the cmdlet generates no output. + +### System.Object +If `-PassThru` or `-OutputMode ` is used, sends the selected items through the pipeline. + +## NOTES + +## RELATED LINKS +https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/out-gridview?view=powershell-7.4&viewFallbackFrom=powershell-7.3&WT.mc_id=ps-gethelp \ No newline at end of file diff --git a/HostInjection/Help/Register-VSCodeTreeView.md b/HostInjection/Help/Register-VSCodeTreeView.md new file mode 100644 index 0000000..bdd74f0 --- /dev/null +++ b/HostInjection/Help/Register-VSCodeTreeView.md @@ -0,0 +1,156 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Register-VSCodeTreeView + +## SYNOPSIS +Creates a TreeView entry in the Custom view. + +## SYNTAX + +``` +Register-VSCodeTreeView -Label [-Description ] [-Tooltip ] [-Icon ] + [-LoadChildren ] [-InvokeChild ] [-ProgressAction ] + [] +``` + +## DESCRIPTION +This cmdlet creates a TreeView entry, which can contain multiple recursive levels of TreeItem entries, whether invokable or not. + +## EXAMPLES + +### Example 1 +```powershell +Register-VSCodeTreeView -Label 'Test' -LoadChildren { + 1..10 | % { New-VSCodeTreeItem -Label "Test$_" -Icon 'archive' -HasChildren } +} -Icon 'account' -InvokeChild { + Show-VSCodeMessage -Message $args[0].Path +} +``` + +Creates a tree view named Test that creates nested tree items. When each item is clicked, it will display a VS Code message. + +### Example 2 +```powershell +Register-VSCodeTreeView -Label 'GitHub' -LoadChildren { + New-VSCodeTreeItem -Label 'PowerShell Universal' -Description 'https://github.com/ironmansoftware/powershell-universal' -Icon 'github-inverted' + New-VSCodeTreeItem -Label 'Issues' -Description 'https://github.com/ironmansoftware/issues' -Icon 'github-inverted' + New-VSCodeTreeItem -Label 'PowerShell' -Description 'https://github.com/powershell/powershell' -Icon 'github-inverted' +} -Icon 'github' -InvokeChild { + Start-Process $args[0].Description +} +``` + +This example creates a tree view of GitHub repositories and opens each when clicked. + +## PARAMETERS + +### -Description +The item description, displayed to the right of the label / name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Icon +A codicon icon name to display. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InvokeChild +The action to perform on child TreeItems. + +```yaml +Type: ScriptBlock +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Label +The main name displayed on the item which doubles as its ID. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadChildren +A script block containing one or more TreeItem creation actions using New-VSCodeTreeItem. + +```yaml +Type: ScriptBlock +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tooltip +The text to display on hover. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/powershell-explorer#custom-tree-view \ No newline at end of file diff --git a/HostInjection/Help/Remove-VSCodeTextDocumentText.md b/HostInjection/Help/Remove-VSCodeTextDocumentText.md new file mode 100644 index 0000000..6b3fee2 --- /dev/null +++ b/HostInjection/Help/Remove-VSCodeTextDocumentText.md @@ -0,0 +1,109 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Remove-VSCodeTextDocumentText + +## SYNOPSIS +Removes a range of text from a document. + +## SYNTAX + +``` +Remove-VSCodeTextDocumentText -TextDocument -Range [-Wait] + [-ResponseTimeout ] [-ProgressAction ] [] +``` + +## DESCRIPTION +Given a document object, removes a range of text. This creates an edit but does not save the file. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> $Range = New-VSCodeRange -StartLine 0 -EndLine 0 -StartCharacter 0 -EndCharacter 10 +PS C:\> Get-VSCodeTextDocument | Remove-VSCodeTextDocumentText -Range $Range +``` + +Removes 10 characters from the first line of a document. + +## PARAMETERS + +### -Range +A file range retrieved with New-VSCodeRange. + +```yaml +Type: VsCodeRange +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseTimeout +How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextDocument +The text document to act on, retrieved with Get-VSCodeTextDocument. + +```yaml +Type: VsCodeTextDocument +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Wait +Whether to wait for the cmdlet to finish or return immediately. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Remove-VSCodeTextEditor.md b/HostInjection/Help/Remove-VSCodeTextEditor.md new file mode 100644 index 0000000..d1263a2 --- /dev/null +++ b/HostInjection/Help/Remove-VSCodeTextEditor.md @@ -0,0 +1,93 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Remove-VSCodeTextEditor + +## SYNOPSIS +Close editors that are already open. + +## SYNTAX + +``` +Remove-VSCodeTextEditor -TextEditor [-Wait] [-ResponseTimeout ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +This cmdlet closes editors that are already open, given TextEditor object(s). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-VSCodeTextEditor | Remove-VSCodeTextEditor +``` + +Closes open editors. + +## PARAMETERS + +### -ResponseTimeout +How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextEditor +The text editor to act on, retrieved with Get-VSCodeTextEditor. + +```yaml +Type: VsCodeTextEditor +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Wait +Whether to wait for the cmdlet to finish or return immediately. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextEditor + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Send-VSCodeTerminalText.md b/HostInjection/Help/Send-VSCodeTerminalText.md new file mode 100644 index 0000000..89da467 --- /dev/null +++ b/HostInjection/Help/Send-VSCodeTerminalText.md @@ -0,0 +1,148 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Send-VSCodeTerminalText + +## SYNOPSIS +Sends text to the specified terminal. + +## SYNTAX + +### name +``` +Send-VSCodeTerminalText -Name -Text [-AddNewLine] [-Wait] [-ResponseTimeout ] + [-ProgressAction ] [] +``` + +### terminal +``` +Send-VSCodeTerminalText -Terminal -Text [-AddNewLine] [-Wait] + [-ResponseTimeout ] [-ProgressAction ] [] +``` + +## DESCRIPTION +The cmdlet sends text to the specified terminal, whether from a terminal name or object. You can commit this text by including the -AddNewLine parameter. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-VSCodeTerminal | Where-Object Name -eq 'PowerShell Integrated Console' | Send-VSCodeTerminalText -Text 'Write-Host "Hello World!"' +``` + +Sends the line `Write-Host "Hello World!"` to the PowerShell Integrated Console. + +## PARAMETERS + +### -AddNewLine +Whether to send a newline at the end of the text, effectively running it immediately. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the terminal to interact with. + +```yaml +Type: String +Parameter Sets: name +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResponseTimeout +How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Terminal +The terminal object to interact with. See: Get-VSCodeTerminal + +```yaml +Type: VsCodeTerminal +Parameter Sets: terminal +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Text +The text string to send to the terminal. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Whether to wait for the cmdlet to finish or return immediately. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### PowerShellToolsPro.Cmdlets.VSCode.VsCodeTerminal + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Set-VSCodeStatusBarMessage.md b/HostInjection/Help/Set-VSCodeStatusBarMessage.md new file mode 100644 index 0000000..76fe29e --- /dev/null +++ b/HostInjection/Help/Set-VSCodeStatusBarMessage.md @@ -0,0 +1,108 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Set-VSCodeStatusBarMessage + +## SYNOPSIS +Sets a status bar message. + +## SYNTAX + +``` +Set-VSCodeStatusBarMessage -Message [-Timeout ] [-Wait] [-ResponseTimeout ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +This cmdlet sets the text on the extension 'extension status' status bar item. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-VSCodeStatusBarMessage -Message 'Hellllloooo' +``` + +Sets the status bar to `Hellllloooo`. + +## PARAMETERS + +### -Message +The text to send to the status bar. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseTimeout +How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timeout +How long the status bar message should display in milliseconds. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Whether to wait for the cmdlet to finish or return immediately. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Set-VSCodeTextEditorDecoration.md b/HostInjection/Help/Set-VSCodeTextEditorDecoration.md new file mode 100644 index 0000000..2f66f47 --- /dev/null +++ b/HostInjection/Help/Set-VSCodeTextEditorDecoration.md @@ -0,0 +1,445 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Set-VSCodeTextEditorDecoration + +## SYNOPSIS +Decorates a range of text with an optional set of colors, outlines, borders, and text. + +## SYNTAX + +``` +Set-VSCodeTextEditorDecoration -TextEditor -Range -Key + [-BackgroundColor ] [-Border ] [-BorderColor ] [-BorderRadius ] + [-BorderStyle ] [-BorderWidth ] [-Color ] [-Cursor ] [-FontStyle ] + [-FontWeight ] [-IsWholeLine] [-LetterSpacing ] [-Opacity ] [-Outline ] + [-OutlineColor ] [-OutlineStyle ] [-OutlineWidth ] [-RangeBehavior ] + [-TextDecoration ] [-After ] [-Before ] [-Wait] + [-ResponseTimeout ] [-ProgressAction ] [] +``` + +## DESCRIPTION +The cmdlet decorates a range of text with an optional set of colors, outlines, borders, and text. + +## EXAMPLES + +### Example 1 +```powershell +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 +``` + +Sets a document range's background color to the 'descriptionForeground' element, and the text to bold. + +## PARAMETERS + +### -After +Ignored. Commented out in vscodeService.ts: `//after = After`. + +```yaml +Type: DecorationAttachment +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackgroundColor +The background color. This is passed directly to `vscode.TextEditor.setDecoration` in the extension. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Before +Ignored. Commented out in vscodeService.ts: `//before = Before`. + +```yaml +Type: DecorationAttachment +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Border +This is passed directly to `vscode.TextEditor.setDecoration` in the extension. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BorderColor +This is passed directly to `vscode.TextEditor.setDecoration` in the extension. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BorderRadius +This is passed directly to `vscode.TextEditor.setDecoration` in the extension. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BorderStyle +This is passed directly to `vscode.TextEditor.setDecoration` in the extension. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BorderWidth +This is passed directly to `vscode.TextEditor.setDecoration` in the extension. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Color +This is passed directly to `vscode.TextEditor.setDecoration` in the extension. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Cursor +This is passed directly to `vscode.TextEditor.setDecoration` in the extension. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FontStyle +This is passed directly to `vscode.TextEditor.setDecoration` in the extension. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FontWeight +This is passed directly to `vscode.TextEditor.setDecoration` in the extension. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsWholeLine +This is passed directly to `vscode.TextEditor.setDecoration` in the extension. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Key +This is passed directly to `vscode.TextEditor.setDecoration` in the extension. See: `this.decorations[msg.args.key] = decorationType;` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LetterSpacing +This is passed directly to `vscode.TextEditor.setDecoration` in the extension. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Opacity +This is passed directly to `vscode.TextEditor.setDecoration` in the extension. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Outline +This is passed directly to `vscode.TextEditor.setDecoration` in the extension. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutlineColor +This is passed directly to `vscode.TextEditor.setDecoration` in the extension. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutlineStyle +This is passed directly to `vscode.TextEditor.setDecoration` in the extension. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutlineWidth +This is passed directly to `vscode.TextEditor.setDecoration` in the extension. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Range +The document range to set decoration on. + +```yaml +Type: VsCodeRange +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RangeBehavior +Passed to `vscode.DecorationRangeBehavior`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: ClosedClosed, ClosedOpen, OpenClosed, OpenOpen + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseTimeout +How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextDecoration +This is passed directly to `vscode.TextEditor.setDecoration` in the extension. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextEditor +The text editor object to set the decoration on. + +```yaml +Type: VsCodeTextEditor +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Wait +Whether to wait for the cmdlet to finish or return immediately. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextEditor + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Show-VSCodeInputBox.md b/HostInjection/Help/Show-VSCodeInputBox.md new file mode 100644 index 0000000..44798f6 --- /dev/null +++ b/HostInjection/Help/Show-VSCodeInputBox.md @@ -0,0 +1,183 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Show-VSCodeInputBox + +## SYNOPSIS +Shows an input box for the user to enter arbitrary text. + +## SYNTAX + +``` +Show-VSCodeInputBox [-IgnoreFocusOut] [-Password] [-PlaceHolder ] [-Prompt ] [-Value ] + [-StartValueSelection ] [-EndValueSelection ] [-Wait] [-ResponseTimeout ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +This cmdlet shows an input box for the user to enter arbitrary text, which is returned to PowerShell. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Show-VSCodeInputBox -PlaceHolder 'Enter some text' +``` + +Requests input with the default value `Enter some text` + +## PARAMETERS + +### -EndValueSelection +Don't know. A tuplet is created from this and StartValueSelection. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreFocusOut +Don't close the input if it loses focus. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Specifies the input should be masked. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceHolder +The default value to fill the input box with. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Prompt +The user prompt for the input. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseTimeout +How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartValueSelection +Don't know. A tuplet is created from this and EndValueSelection. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The value to fill the input with, I guess? + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Whether to wait for the cmdlet to finish or return immediately. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS +https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Show-VSCodeMessage.md b/HostInjection/Help/Show-VSCodeMessage.md new file mode 100644 index 0000000..fe71117 --- /dev/null +++ b/HostInjection/Help/Show-VSCodeMessage.md @@ -0,0 +1,139 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Show-VSCodeMessage + +## SYNOPSIS +Show a message to the user and provide an option for them to select. + +## SYNTAX + +``` +Show-VSCodeMessage -Message [-Items ] [-Modal] [-Type ] [-Wait] + [-ResponseTimeout ] [-ProgressAction ] [] +``` + +## DESCRIPTION +Show a message to the user and provide an option for them to select. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Show-VSCodeMessage -Message 'What should we do?' -Items @('Party', 'Sleep') +``` + +Shows a prompt with two selectable buttons. + +## PARAMETERS + +### -Items +An array of strings that will be shown as buttons, with the first as the default. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Message +The prompt text. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Modal +Specify that the prompt should be a system modal dialogue (takes focus until closed) instead of a styled application message. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseTimeout +How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The type of message to show. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: Error, Warning, Information + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Whether to wait for the cmdlet to finish or return immediately. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Show-VSCodeQuickPick.md b/HostInjection/Help/Show-VSCodeQuickPick.md new file mode 100644 index 0000000..e09e1ad --- /dev/null +++ b/HostInjection/Help/Show-VSCodeQuickPick.md @@ -0,0 +1,138 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Show-VSCodeQuickPick + +## SYNOPSIS +Shows a quick pick list for a user to select items from. + +## SYNTAX + +``` +Show-VSCodeQuickPick [-PlaceHolder ] -Items [-CanPickMany] [-IgnoreFocusOut] [-Wait] + [-ResponseTimeout ] [-ProgressAction ] [] +``` + +## DESCRIPTION +Shows a quick pick list for a user to select items from. This cmdlet will return the user's selection to PowerShell. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Show-VSCodeQuickPick -PlaceHolder 'What should we do?' -Items @('Party', 'Sleep') +``` + +Shows a dropdown prompt at the command bar with a list of selectable items. + +## PARAMETERS + +### -CanPickMany +Specify that multiple items can be checked. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreFocusOut +Don't close if focus is lost. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Items +An array of selectable items to display. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceHolder +The default item to select in the prompt. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseTimeout +How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Whether to wait for the cmdlet to finish or return immediately. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Todo/Get-CompletionItem.md b/HostInjection/Help/Todo/Get-CompletionItem.md new file mode 100644 index 0000000..9a7a604 --- /dev/null +++ b/HostInjection/Help/Todo/Get-CompletionItem.md @@ -0,0 +1,240 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Get-CompletionItem + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Types +``` +Get-CompletionItem [-Types] [-IgnoredTypes ] [-IgnoredAssemblies ] + [-ProgressAction ] [] +``` + +### Commands +``` +Get-CompletionItem -Command [-IgnoredModules ] [-IgnoredCommands ] + [-ProgressAction ] [] +``` + +### Variable +``` +Get-CompletionItem -Variable [-IgnoredVariables ] [-ProgressAction ] + [] +``` + +### File +``` +Get-CompletionItem -File [-ProgressAction ] [] +``` + +### Directory +``` +Get-CompletionItem -Directory [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Command +{{ Fill Command Description }} + +```yaml +Type: CommandInfo +Parameter Sets: Commands +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Directory +{{ Fill Directory Description }} + +```yaml +Type: DirectoryInfo +Parameter Sets: Directory +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -File +{{ Fill File Description }} + +```yaml +Type: FileInfo +Parameter Sets: File +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IgnoredAssemblies +{{ Fill IgnoredAssemblies Description }} + +```yaml +Type: String +Parameter Sets: Types +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoredCommands +{{ Fill IgnoredCommands Description }} + +```yaml +Type: String +Parameter Sets: Commands +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoredModules +{{ Fill IgnoredModules Description }} + +```yaml +Type: String +Parameter Sets: Commands +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoredTypes +{{ Fill IgnoredTypes Description }} + +```yaml +Type: String +Parameter Sets: Types +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoredVariables +{{ Fill IgnoredVariables Description }} + +```yaml +Type: String +Parameter Sets: Variable +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Types +{{ Fill Types Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Types +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Variable +{{ Fill Variable Description }} + +```yaml +Type: Variable +Parameter Sets: Variable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.CommandInfo + +### PowerShellTools.Common.ServiceManagement.DebuggingContract.Variable + +### System.IO.FileInfo + +### System.IO.DirectoryInfo + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/HostInjection/Help/Todo/Get-PoshToolsVariable.md b/HostInjection/Help/Todo/Get-PoshToolsVariable.md new file mode 100644 index 0000000..d82323a --- /dev/null +++ b/HostInjection/Help/Todo/Get-PoshToolsVariable.md @@ -0,0 +1,90 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Get-PoshToolsVariable + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PoshToolsVariable -Path [-ValueOnly] [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValueOnly +{{ Fill ValueOnly Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/HostInjection/Help/Todo/Measure-Block.md b/HostInjection/Help/Todo/Measure-Block.md new file mode 100644 index 0000000..1765cc2 --- /dev/null +++ b/HostInjection/Help/Todo/Measure-Block.md @@ -0,0 +1,173 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Measure-Block + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### file +``` +Measure-Block [-ScriptBlock ] [-FileName ] -StartOffset -EndOffset + [-ProgressAction ] [] +``` + +### module +``` +Measure-Block [-ScriptBlock ] -ModuleName -CommandName -PipelineMethod + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -CommandName +{{ Fill CommandName Description }} + +```yaml +Type: String +Parameter Sets: module +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndOffset +{{ Fill EndOffset Description }} + +```yaml +Type: Int32 +Parameter Sets: file +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileName +{{ Fill FileName Description }} + +```yaml +Type: String +Parameter Sets: file +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleName +{{ Fill ModuleName Description }} + +```yaml +Type: String +Parameter Sets: module +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PipelineMethod +{{ Fill PipelineMethod Description }} + +```yaml +Type: String +Parameter Sets: module +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptBlock +{{ Fill ScriptBlock Description }} + +```yaml +Type: ScriptBlock +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartOffset +{{ Fill StartOffset Description }} + +```yaml +Type: Int32 +Parameter Sets: file +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/HostInjection/Help/Todo/Measure-Script.md b/HostInjection/Help/Todo/Measure-Script.md new file mode 100644 index 0000000..0762277 --- /dev/null +++ b/HostInjection/Help/Todo/Measure-Script.md @@ -0,0 +1,96 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Measure-Script + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### ScriptBlock +``` +Measure-Script [-ScriptBlock] [-ProgressAction ] [] +``` + +### FilePath +``` +Measure-Script [-FilePath] [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -FilePath +{{ Fill FilePath Description }} + +```yaml +Type: String +Parameter Sets: FilePath +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptBlock +{{ Fill ScriptBlock Description }} + +```yaml +Type: ScriptBlock +Parameter Sets: ScriptBlock +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/HostInjection/Help/Todo/New-VSCodeDecorationAttachment.md b/HostInjection/Help/Todo/New-VSCodeDecorationAttachment.md new file mode 100644 index 0000000..73aa581 --- /dev/null +++ b/HostInjection/Help/Todo/New-VSCodeDecorationAttachment.md @@ -0,0 +1,228 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# New-VSCodeDecorationAttachment + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-VSCodeDecorationAttachment [-BackgroundColor ] [-Border ] [-BorderColor ] + [-Color ] [-ContentText ] [-FontStyle ] [-FontWeight ] [-Height ] + [-Margin ] [-TextDecoration ] [-Width ] [-ProgressAction ] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -BackgroundColor +{{ Fill BackgroundColor Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Border +{{ Fill Border Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BorderColor +{{ Fill BorderColor Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Color +{{ Fill Color Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentText +{{ Fill ContentText Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FontStyle +{{ Fill FontStyle Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FontWeight +{{ Fill FontWeight Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Height +{{ Fill Height Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Margin +{{ Fill Margin Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextDecoration +{{ Fill TextDecoration Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Width +{{ Fill Width Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/HostInjection/Help/Todo/Out-PoshToolsVariable.md b/HostInjection/Help/Todo/Out-PoshToolsVariable.md new file mode 100644 index 0000000..5f5c8bd --- /dev/null +++ b/HostInjection/Help/Todo/Out-PoshToolsVariable.md @@ -0,0 +1,106 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Out-PoshToolsVariable + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Out-PoshToolsVariable [-InputObject ] [-PassThru] [-ExcludeAutomatic ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ExcludeAutomatic +{{ Fill ExcludeAutomatic Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +{{ Fill InputObject Description }} + +```yaml +Type: PSVariable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSVariable + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/HostInjection/Help/Todo/PowerShellProTools.VSCode.md b/HostInjection/Help/Todo/PowerShellProTools.VSCode.md new file mode 100644 index 0000000..5a0c7a5 --- /dev/null +++ b/HostInjection/Help/Todo/PowerShellProTools.VSCode.md @@ -0,0 +1,94 @@ +--- +Module Name: PowerShellProTools.VSCode +Module Guid: 6445e5c3-d794-4af8-82a4-7ee94e0d4f1b +Download Help Link: {{ Update Download Link }} +Help Version: {{ Please enter version of help manually (X.X.X.X) format }} +Locale: en-US +--- + +# PowerShellProTools.VSCode Module +## Description +{{ Fill in the Description }} + +## PowerShellProTools.VSCode Cmdlets +### [Add-VSCodeTextDocumentText](Add-VSCodeTextDocumentText.md) +{{ Fill in the Description }} + +### [Clear-VSCodeDecoration](Clear-VSCodeDecoration.md) +{{ Fill in the Description }} + +### [Get-CompletionItem](Get-CompletionItem.md) +{{ Fill in the Description }} + +### [Get-PoshToolsVariable](Get-PoshToolsVariable.md) +{{ Fill in the Description }} + +### [Get-VSCodeTerminal](Get-VSCodeTerminal.md) +{{ Fill in the Description }} + +### [Get-VSCodeTextDocument](Get-VSCodeTextDocument.md) +{{ Fill in the Description }} + +### [Get-VSCodeTextDocumentText](Get-VSCodeTextDocumentText.md) +{{ Fill in the Description }} + +### [Get-VSCodeTextEditor](Get-VSCodeTextEditor.md) +{{ Fill in the Description }} + +### [Measure-Block](Measure-Block.md) +{{ Fill in the Description }} + +### [Measure-Script](Measure-Script.md) +{{ Fill in the Description }} + +### [New-VSCodeDecorationAttachment](New-VSCodeDecorationAttachment.md) +{{ Fill in the Description }} + +### [New-VSCodePosition](New-VSCodePosition.md) +{{ Fill in the Description }} + +### [New-VSCodeRange](New-VSCodeRange.md) +{{ Fill in the Description }} + +### [New-VSCodeTreeItem](New-VSCodeTreeItem.md) +{{ Fill in the Description }} + +### [Open-VSCodeTextDocument](Open-VSCodeTextDocument.md) +{{ Fill in the Description }} + +### [Out-PoshToolsVariable](Out-PoshToolsVariable.md) +{{ Fill in the Description }} + +### [Out-VSCodeGridView](Out-VSCodeGridView.md) +{{ Fill in the Description }} + +### [Register-VSCodeTreeView](Register-VSCodeTreeView.md) +{{ Fill in the Description }} + +### [Remove-VSCodeTextDocumentText](Remove-VSCodeTextDocumentText.md) +{{ Fill in the Description }} + +### [Remove-VSCodeTextEditor](Remove-VSCodeTextEditor.md) +{{ Fill in the Description }} + +### [Send-VSCodeTerminalText](Send-VSCodeTerminalText.md) +{{ Fill in the Description }} + +### [Set-VSCodeStatusBarMessage](Set-VSCodeStatusBarMessage.md) +{{ Fill in the Description }} + +### [Set-VSCodeTextEditorDecoration](Set-VSCodeTextEditorDecoration.md) +{{ Fill in the Description }} + +### [Show-VSCodeInputBox](Show-VSCodeInputBox.md) +{{ Fill in the Description }} + +### [Show-VSCodeMessage](Show-VSCodeMessage.md) +{{ Fill in the Description }} + +### [Show-VSCodeQuickPick](Show-VSCodeQuickPick.md) +{{ Fill in the Description }} + +### [Start-PoshToolsServer](Start-PoshToolsServer.md) +{{ Fill in the Description }} + diff --git a/HostInjection/Help/Todo/Start-PoshToolsServer.md b/HostInjection/Help/Todo/Start-PoshToolsServer.md new file mode 100644 index 0000000..d7c5100 --- /dev/null +++ b/HostInjection/Help/Todo/Start-PoshToolsServer.md @@ -0,0 +1,75 @@ +--- +external help file: PowerShellProTools.VSCode.dll-Help.xml +Module Name: PowerShellProTools.VSCode +online version: +schema: 2.0.0 +--- + +# Start-PoshToolsServer + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Start-PoshToolsServer [[-PipeName] ] [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PipeName +{{ Fill PipeName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS From 2fde35766216a5ea0902a51f696ffc8fa2ad2459 Mon Sep 17 00:00:00 2001 From: TMA-2 Date: Thu, 13 Mar 2025 23:12:46 -0500 Subject: [PATCH 3/7] Added tours for building the VSCode and VS extensions based on the Wiki. --- ...owershell-pro-tools-for-visual-studio.tour | 63 +++++++++++++++++++ .tours/powershell-pro-tools-for-vs-code.tour | 4 ++ PowerShellProTools.code-workspace | 53 ++++++++++++++++ 3 files changed, 120 insertions(+) create mode 100644 .tours/powershell-pro-tools-for-visual-studio.tour create mode 100644 PowerShellProTools.code-workspace diff --git a/.tours/powershell-pro-tools-for-visual-studio.tour b/.tours/powershell-pro-tools-for-visual-studio.tour new file mode 100644 index 0000000..e5c4957 --- /dev/null +++ b/.tours/powershell-pro-tools-for-visual-studio.tour @@ -0,0 +1,63 @@ +{ + "$schema": "https://aka.ms/codetour-schema", + "title": "PowerShell Pro Tools for Visual Studio", + "steps": [ + { + "title": "Overview", + "description": "PowerShell Pro Tools is a collection of extensions for Visual Studio and Visual Studio Code to enhance the PowerShell editing experience.\r\n\r\nIt includes tools that do the following:\r\n\r\n- Windows Form Designer for PowerShell\r\n- PowerShell Script Executable Packaging\r\n- Refactoring\r\n- Variable Window\r\n- Module Window" + }, + { + "title": "Requirements", + "description": "### Requirements\r\n- [.NET](https://dotnet.microsoft.com/en-us/download)\r\n- [Visual Studio 2022](https://visualstudio.microsoft.com/vs/community/)\r\n - .NET Desktop Development Workload\r\n - Visual Studio Extensibility Workload\r\n- [InvokeBuild](https://github.com/nightroman/Invoke-Build)" + }, + { + "title": "Build Process", + "description": "Start Visual Studio as Administrator. Administrator access is required because the PowerShell Pro Tools build copies files into the Visual Studio directory for debugging purposes.\r\n\r\nBuild the `PowerShellTools` project to build the *Visual Studio 2019* extension and the `PowerShellTools.2022` to build the *Visual Studio 2022* and later extension." + }, + { + "title": "Debugging", + "description": "Debugging can be accomplished through Visual Studio. Set the startup project to `PowerShellTools.2022` and press `F5` to launch the experimental instance and debug the extension.\r\n\r\nIf you launch Visual Studio and the extension fails to load, you may need to remove the `VS 2019` extension. If you\r\nbuilt the entire solution of the `PowerShellTools` project in *Visual Studio 2022*, then the older version of the\r\nextension was also installed in the experimental instance. This results in the extension failing to load and duplicate\r\nproject and item templates.\r\n1. Remove the 2019 extension by clicking `Extensions > Manage Extensions`.\r\n2. Uninstall `PowerShell Tools for Visual Studio`. You will need to restart the experimental instance.\r\n3. You do not need to remove `PowerShell Tools for Visual Studio 2022`." + }, + { + "directory": "Build", + "description": "Contains MSBuild settings and targets files that are used in the PoshTools projects." + }, + { + "directory": "Common", + "description": "Common models, interfaces and helpers for PoshTools." + }, + { + "directory": "HostInjection", + "description": "Refactoring used in both the VS and VS Code extensions." + }, + { + "directory": "PowerShellTools.Shared", + "description": "Contains the bulk of the Visual Studio extension. Includes the Project system, IntelliSense, debugging system and more. Shared between the VS2019 and VS2022+ extensions." + }, + { + "directory": "PowerShellTools", + "description": "The base project for the VS2019 extension. Mainly references the Shared project." + }, + { + "directory": "PowerShellTools.2022", + "description": "The base project for the VS2022+ extension. Mainly references the Shared project." + }, + { + "directory": "PowerShellTools.MSBuild", + "description": "MSBuild targets for packaging." + }, + { + "directory": "PowerShellTools.Templates.Data", + "description": "Project and file templates like modules, scripts and form projects.\r\n- PowerShellTools.Templates.Data\r\n- PowerShellTools.Templates.FormProject\r\n- PowerShellTools.Templates.Module\r\n- PowerShellTools.Templates.ModuleProject\r\n- PowerShellTools.Templates.Script\r\n- PowerShellTools.Templates.ScriptProject\r\n- PowerShellTools.Templates.Test" + }, + { + "directory": "PowerShellToolsPro.Packager", + "description": "Packager library used to turn PowerShell scripts into executables." + }, + { + "directory": "FormDesigner", + "description": "Form designer parsing and generation logic." + } + ], + "ref": "main" +} \ No newline at end of file diff --git a/.tours/powershell-pro-tools-for-vs-code.tour b/.tours/powershell-pro-tools-for-vs-code.tour index be1dff5..2440f59 100644 --- a/.tours/powershell-pro-tools-for-vs-code.tour +++ b/.tours/powershell-pro-tools-for-vs-code.tour @@ -2,6 +2,10 @@ "$schema": "https://aka.ms/codetour-schema", "title": "PowerShell Pro Tools for VS Code", "steps": [ + { + "title": "Overview", + "description": "PowerShell Pro Tools is a collection of extensions for Visual Studio and Visual Studio Code to enhance the PowerShell editing experience.\r\n\r\nIt includes tools that do the following:\r\n\r\n- Windows Form Designer for PowerShell\r\n- PowerShell Script Executable Packaging\r\n- Refactoring\r\n- Variable Window\r\n- Module Window" + }, { "title": "Requirements", "description": "You'll need the following installed:\r\n- [VS Code](https://code.visualstudio.com/)\r\n- [NodeJS](https://nodejs.org/en)\r\n- [.NET](https://dotnet.microsoft.com/en-us/download)\r\n- [Visual Studio 2022](https://visualstudio.microsoft.com/vs/community/)\r\n- [InvokeBuild](https://github.com/nightroman/Invoke-Build)" diff --git a/PowerShellProTools.code-workspace b/PowerShellProTools.code-workspace new file mode 100644 index 0000000..40ca368 --- /dev/null +++ b/PowerShellProTools.code-workspace @@ -0,0 +1,53 @@ +{ + "folders": [ + { + "name": "PS Pro Tools", + "path": "..\\powershell-pro-tools" + }, + ], + "settings": { + "files.exclude": { + "**/*.rpyc": true, + "**/*.rpa": true, + "**/*.rpymc": true, + "**/cache/": true + }, + "[csharp]": { + "editor.maxTokenizationLineLength": 2500 + }, + "powershell.sideBar.CommandExplorerVisibility": false, + "powershell.buttons.showPanelMovementButtons": false, + "powershell.pester.codeLens": true, + "powershell.enableProfileLoading": true, + "powershell.cwd": "Source", + "powershell.developer.editorServicesLogLevel": "Information", + "powershell.trace.server": "messages", + "dotnet.defaultSolution": "Source/powershell-pro-tools", + "dotnet.preferCSharpExtension": false, + "xml.fileAssociations": [ + { + "pattern": "**/*.csproj", + "systemId": "C:\\Windows\\Microsoft.NET\\Framework64\\v4.0.30319\\Microsoft.Build.xsd", + // "systemId": "https://github.com/dotnet/msbuild/raw/refs/heads/main/src/MSBuild/Microsoft.Build.xsd" + } + ], + "xml.codeLens.enabled": true, + "xml.format.joinContentLines": true, + "xml.trace.server": "messages", + "xml.validation.namespaces.enabled": "onNamespaceEncountered", + "xml.colors": [ + { + "expressions": [ + { + "xpath": "/Project/PropertyGroup/TargetFramework", + // goldenrod + "color": "#DAA520" + } + ], + "pattern": "**/*.csproj" + } + ], + // "xml.format.xsiSchemaLocationSplit": "none", + "todo-tree.tree.scanMode": "open files" + } +} \ No newline at end of file From eaf7857fdb32847b88426201c6301551e8beea4b Mon Sep 17 00:00:00 2001 From: "Jon D." Date: Fri, 14 Mar 2025 14:02:03 -0500 Subject: [PATCH 4/7] Minor change to workspace --- PowerShellProTools.code-workspace | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/PowerShellProTools.code-workspace b/PowerShellProTools.code-workspace index 40ca368..b4389dd 100644 --- a/PowerShellProTools.code-workspace +++ b/PowerShellProTools.code-workspace @@ -17,7 +17,7 @@ }, "powershell.sideBar.CommandExplorerVisibility": false, "powershell.buttons.showPanelMovementButtons": false, - "powershell.pester.codeLens": true, + "powershell.pester.codeLens": false, "powershell.enableProfileLoading": true, "powershell.cwd": "Source", "powershell.developer.editorServicesLogLevel": "Information", From d9ebcce56385d475d5b8cce5782bdb439eb797cd Mon Sep 17 00:00:00 2001 From: TMA-2 Date: Fri, 14 Mar 2025 22:55:55 -0500 Subject: [PATCH 5/7] Restoring original NewTreeItemCommand.cs --- HostInjection/NewTreeItemCommand.cs | 43 ++++++++++------------------- 1 file changed, 14 insertions(+), 29 deletions(-) diff --git a/HostInjection/NewTreeItemCommand.cs b/HostInjection/NewTreeItemCommand.cs index 5a81bf3..1ca2889 100644 --- a/HostInjection/NewTreeItemCommand.cs +++ b/HostInjection/NewTreeItemCommand.cs @@ -3,38 +3,23 @@ namespace PowerShellToolsPro.Cmdlets.VSCode { - /// - /// Creates a new VSCode custom tree item. - /// This cmdlet creates a new VSCode custom tree item underneath a parent tree view or another tree item. - /// It's meant to be used in conjunction with the Register-VSCodeTreeView -LoadChildren cmdlet parameter. - /// - /// - /// New-VSCodeTreeItem -Label "Item1" -Description "This is item 1" -Icon "account" -Tooltip "Hovering over Item1" - /// Creates a new treeview item with a label (which doubles as the treeViewId), description, and tooltip. - /// - /// - /// New-VSCodeTreeItem -Label "Item2" -HasChildren -DisableInvoke - /// Creates a new treeview item with the label "Item2" that has children but no invoke button. - /// - /// - [Cmdlet(VerbsCommon.New, "VSCodeTreeItem")] + [Cmdlet(VerbsCommon.New, "VSCodeTreeItem")] public class NewTreeItemCommand : PSCmdlet { - [Parameter(Mandatory = true, HelpMessage = "The label of the tree item.")] - public string Label { get; set; } - [Parameter(HelpMessage = "The description of the tree item. Appears to the right of the label.")] - public string Description { get; set; } - [Parameter(HelpMessage = "The tooltip for the tree item.")] - public string Tooltip { get; set; } - [Parameter(HelpMessage = "The icon for the tree item, taken from codicons.")] - public string Icon { get; set; } - [Parameter(HelpMessage = "Indicates that the tree item can contain children.")] - public SwitchParameter HasChildren { get; set; } + [Parameter(Mandatory = true)] + public string Label { get; set; } + [Parameter()] + public string Description { get; set; } + [Parameter()] + public string Tooltip { get; set; } + [Parameter()] + public string Icon { get; set; } + [Parameter()] + public SwitchParameter HasChildren { get; set; } + [Parameter()] + public SwitchParameter DisableInvoke { get; set; } - [Parameter(HelpMessage = "Indicates that the tree item is not invokable.")] - public SwitchParameter DisableInvoke { get; set; } - - protected override void BeginProcessing() + protected override void BeginProcessing() { WriteObject(new TreeItem { Description = Description, From 73a1b40422fecd826578ffba608e01619a6888d0 Mon Sep 17 00:00:00 2001 From: TMA-2 Date: Fri, 14 Mar 2025 23:03:29 -0500 Subject: [PATCH 6/7] Removing VSCode module help files for a separate branch --- .../Help/Add-VSCodeTextDocumentText.md | 122 ----- HostInjection/Help/Clear-VSCodeDecoration.md | 100 ---- HostInjection/Help/Get-VSCodeTerminal.md | 76 --- HostInjection/Help/Get-VSCodeTextDocument.md | 86 ---- .../Help/Get-VSCodeTextDocumentText.md | 114 ----- HostInjection/Help/Get-VSCodeTextEditor.md | 79 ---- HostInjection/Help/New-VSCodePosition.md | 117 ----- HostInjection/Help/New-VSCodeRange.md | 147 ------ HostInjection/Help/New-VSCodeTreeItem.md | 155 ------ HostInjection/Help/Open-VSCodeTextDocument.md | 93 ---- HostInjection/Help/Out-VSCodeGridView.md | 167 ------- HostInjection/Help/Register-VSCodeTreeView.md | 156 ------ .../Help/Remove-VSCodeTextDocumentText.md | 109 ----- HostInjection/Help/Remove-VSCodeTextEditor.md | 93 ---- HostInjection/Help/Send-VSCodeTerminalText.md | 148 ------ .../Help/Set-VSCodeStatusBarMessage.md | 108 ----- .../Help/Set-VSCodeTextEditorDecoration.md | 445 ------------------ HostInjection/Help/Show-VSCodeInputBox.md | 183 ------- HostInjection/Help/Show-VSCodeMessage.md | 139 ------ HostInjection/Help/Show-VSCodeQuickPick.md | 138 ------ HostInjection/Help/Todo/Get-CompletionItem.md | 240 ---------- .../Help/Todo/Get-PoshToolsVariable.md | 90 ---- HostInjection/Help/Todo/Measure-Block.md | 173 ------- HostInjection/Help/Todo/Measure-Script.md | 96 ---- .../Todo/New-VSCodeDecorationAttachment.md | 228 --------- .../Help/Todo/Out-PoshToolsVariable.md | 106 ----- .../Help/Todo/PowerShellProTools.VSCode.md | 94 ---- .../Help/Todo/Start-PoshToolsServer.md | 75 --- 28 files changed, 3877 deletions(-) delete mode 100644 HostInjection/Help/Add-VSCodeTextDocumentText.md delete mode 100644 HostInjection/Help/Clear-VSCodeDecoration.md delete mode 100644 HostInjection/Help/Get-VSCodeTerminal.md delete mode 100644 HostInjection/Help/Get-VSCodeTextDocument.md delete mode 100644 HostInjection/Help/Get-VSCodeTextDocumentText.md delete mode 100644 HostInjection/Help/Get-VSCodeTextEditor.md delete mode 100644 HostInjection/Help/New-VSCodePosition.md delete mode 100644 HostInjection/Help/New-VSCodeRange.md delete mode 100644 HostInjection/Help/New-VSCodeTreeItem.md delete mode 100644 HostInjection/Help/Open-VSCodeTextDocument.md delete mode 100644 HostInjection/Help/Out-VSCodeGridView.md delete mode 100644 HostInjection/Help/Register-VSCodeTreeView.md delete mode 100644 HostInjection/Help/Remove-VSCodeTextDocumentText.md delete mode 100644 HostInjection/Help/Remove-VSCodeTextEditor.md delete mode 100644 HostInjection/Help/Send-VSCodeTerminalText.md delete mode 100644 HostInjection/Help/Set-VSCodeStatusBarMessage.md delete mode 100644 HostInjection/Help/Set-VSCodeTextEditorDecoration.md delete mode 100644 HostInjection/Help/Show-VSCodeInputBox.md delete mode 100644 HostInjection/Help/Show-VSCodeMessage.md delete mode 100644 HostInjection/Help/Show-VSCodeQuickPick.md delete mode 100644 HostInjection/Help/Todo/Get-CompletionItem.md delete mode 100644 HostInjection/Help/Todo/Get-PoshToolsVariable.md delete mode 100644 HostInjection/Help/Todo/Measure-Block.md delete mode 100644 HostInjection/Help/Todo/Measure-Script.md delete mode 100644 HostInjection/Help/Todo/New-VSCodeDecorationAttachment.md delete mode 100644 HostInjection/Help/Todo/Out-PoshToolsVariable.md delete mode 100644 HostInjection/Help/Todo/PowerShellProTools.VSCode.md delete mode 100644 HostInjection/Help/Todo/Start-PoshToolsServer.md diff --git a/HostInjection/Help/Add-VSCodeTextDocumentText.md b/HostInjection/Help/Add-VSCodeTextDocumentText.md deleted file mode 100644 index dabf6f1..0000000 --- a/HostInjection/Help/Add-VSCodeTextDocumentText.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Add-VSCodeTextDocumentText - -## SYNOPSIS -Inserts text into a particular position in the selected document. This creates an edit but does not save the file. - -## SYNTAX - -``` -Add-VSCodeTextDocumentText -TextDocument -Position -Text [-Wait] - [-ResponseTimeout ] [-ProgressAction ] [] -``` - -## DESCRIPTION -Given a TextDocument and Position, this cmdlet inserts text into the selected document. This creates an edit but does not save the file. - -## EXAMPLES - -### Example 1 -```powershell -Get-VSCodeTextDocument | Add-VSCodeTextDocumentText -Position (New-VSCodePosition -Line 0 -Character 0) -Text '# I came from Add-VSCodeTextDocumentText!' -``` - -This inserts a comment at the start of the current file. - -## PARAMETERS - -### -Position -A position (line and column) in the document, created with New-VSCodePosition. - -```yaml -Type: VsCodePosition -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResponseTimeout -How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Text -The text to insert. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TextDocument -An object representing the document to interact with. Retrieve with Get-VSCodeTextDocument. - -```yaml -Type: VsCodeTextDocument -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Wait -Whether to wait for the cmdlet to finish or return immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -ProgressAction, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS -https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Clear-VSCodeDecoration.md b/HostInjection/Help/Clear-VSCodeDecoration.md deleted file mode 100644 index c81d548..0000000 --- a/HostInjection/Help/Clear-VSCodeDecoration.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Clear-VSCodeDecoration - -## SYNOPSIS -Clear decorations created by Set-VSCodeTextEditorDecoration. - -## SYNTAX - -``` -Clear-VSCodeDecoration [-Key ] [-Wait] [-ResponseTimeout ] [-ProgressAction ] - [] -``` - -## DESCRIPTION -This cmdlet clears all decorations, or just one if `-Key` is specified. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Clear-VSCodeDecoration -``` - -Clears all decorations. - -### Example 2 -```powershell -PS C:\> Clear-VSCodeDecoration -Key 12321 -``` - -Clears the decoration associated with key `12321`. - -## PARAMETERS - -### -Key -The specific decoration to clear when it was set with `-Key`, instead of all. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResponseTimeout -How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Whether to wait for the cmdlet to finish or return immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Get-VSCodeTerminal.md b/HostInjection/Help/Get-VSCodeTerminal.md deleted file mode 100644 index 10be35d..0000000 --- a/HostInjection/Help/Get-VSCodeTerminal.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Get-VSCodeTerminal - -## SYNOPSIS -Retrieves a list of open terminals. - -## SYNTAX - -``` -Get-VSCodeTerminal [-Wait] [-ResponseTimeout ] [-ProgressAction ] [] -``` - -## DESCRIPTION -This cmdlet gets the currently opened terminals, returning their names, IDs, columns, rows, and creation options. - -## EXAMPLES - -### Example 1 -```powershell -(Get-VSCodeTerminal -Wait)[-1] -``` - -This returns the last terminal in the list. - -## PARAMETERS - -### -ResponseTimeout -How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Whether to wait for the cmdlet to finish or return immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS -https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Get-VSCodeTextDocument.md b/HostInjection/Help/Get-VSCodeTextDocument.md deleted file mode 100644 index 872b930..0000000 --- a/HostInjection/Help/Get-VSCodeTextDocument.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Get-VSCodeTextDocument - -## SYNOPSIS -Returns a list of currently open documents. - -## SYNTAX - -``` -Get-VSCodeTextDocument [-Wait] [-ResponseTimeout ] [-ProgressAction ] - [] -``` - -## DESCRIPTION -This cmdlet returns a list of open document paths. It can be piped into other cmdlets to make changes, i.e. `Add-VSCodeTextDocumentText`. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-VSCodeTextDocument | Get-VSCodeTextDocumentText -``` - -Retrieves the full text of the current document. - -### Example 2 -```powershell -PS C:\> Get-VSCodeTextDocument | Get-VSCodeTextDocumentText -Range (New-VSCodeRange -StartLine 10 -EndLine 20 -StartCharacter 0 -EndCharacter 16) -``` - -Retrieves lines 10 through 20 (up to column 16) of the current document. - -## PARAMETERS - -### -ResponseTimeout -How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Whether to wait for the cmdlet to finish or return immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -Returns all open document paths, containing one FileName property. - -## RELATED LINKS -https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Get-VSCodeTextDocumentText.md b/HostInjection/Help/Get-VSCodeTextDocumentText.md deleted file mode 100644 index be78d41..0000000 --- a/HostInjection/Help/Get-VSCodeTextDocumentText.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Get-VSCodeTextDocumentText - -## SYNOPSIS -Gets the text of a document. - -## SYNTAX - -``` -Get-VSCodeTextDocumentText -TextDocument [-Range ] [-Wait] - [-ResponseTimeout ] [-ProgressAction ] [] -``` - -## DESCRIPTION -This cmdlet gets the text of a document. You can also pass in a range to select only a partial section of the text. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-VSCodeTextDocument | Get-VSCodeTextDocumentText -``` - -Retrieves the full text of the current document. - -### Example 2 -```powershell -PS C:\> Get-VSCodeTextDocument | Get-VSCodeTextDocumentText -Range (New-VSCodeRange -StartLine 10 -EndLine 20 -StartCharacter 0 -EndCharacter 16) -``` - -Retrieves lines 10 through 20 (up to column 16) of the current document. - -## PARAMETERS - -### -Range -A range between a given start and end line and character/column. See: New-VSCodeRange. - -```yaml -Type: VsCodeRange -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResponseTimeout -How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TextDocument -The text document to interact with. See: Get-VSCodeTextDocument. - -```yaml -Type: VsCodeTextDocument -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Wait -Whether to wait for the cmdlet to finish or return immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument - -## OUTPUTS - -### System.Object -## NOTES -The lines and characters used in -Range are 0-index (like an array), so for instance, to get line 10 in the editor, you'd actually specify line 9. -## RELATED LINKS -https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Get-VSCodeTextEditor.md b/HostInjection/Help/Get-VSCodeTextEditor.md deleted file mode 100644 index 96ff5b4..0000000 --- a/HostInjection/Help/Get-VSCodeTextEditor.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Get-VSCodeTextEditor - -## SYNOPSIS -Retrieves the currently visible text editor. - -## SYNTAX - -``` -Get-VSCodeTextEditor [-Wait] [-ResponseTimeout ] [-ProgressAction ] - [] -``` - -## DESCRIPTION -This cmdlet returns a list of the currently visible editors along with their language ID. So, if you have two groups open, it will return the visible file paths in each group. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> (Get-VSCodeTextEditor)[0] -``` - -Returns the first visible text editor. - -## PARAMETERS - -### -ResponseTimeout -How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Whether to wait for the cmdlet to finish or return immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object -## NOTES -Unlike Get-VSCodeTextDocument, this only returns the open editors that are currently visible. - -Each item has a Document and LanguageId property. The Document property is actually VSCodeTextDocument, which can be piped to any cmdlet that accepts Get-VSCodeTextDocument. -## RELATED LINKS -https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/New-VSCodePosition.md b/HostInjection/Help/New-VSCodePosition.md deleted file mode 100644 index fc2257d..0000000 --- a/HostInjection/Help/New-VSCodePosition.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# New-VSCodePosition - -## SYNOPSIS -Returns a position in a given document. - -## SYNTAX - -``` -New-VSCodePosition -Line -Character [-Wait] [-ResponseTimeout ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This cmdlet returns a position in a given document. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-VSCodePosition -Line 0 -Character 0 -``` - -Gets a position at the start. - -### Example 2 -```powershell -PS C:\> $position = New-VSCodePosition -Line 10 -Character 2 -PS C:\> Get-VSCodeTextDocument | Add-VSCodeTextDocumentText -Position $position -Text NewText -``` - -Adds text at position 10, 2 to the current document. - -## PARAMETERS - -### -Character -The 0-index character number. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Line -The 0-index line number. One less than the visible line number in the document. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResponseTimeout -How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Whether to wait for the cmdlet to finish or return immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -Both lines and character positions are 0-index. - -## RELATED LINKS -https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/New-VSCodeRange.md b/HostInjection/Help/New-VSCodeRange.md deleted file mode 100644 index a870348..0000000 --- a/HostInjection/Help/New-VSCodeRange.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# New-VSCodeRange - -## SYNOPSIS -Returns a range between start and end positions. - -## SYNTAX - -``` -New-VSCodeRange -StartLine -EndLine -StartCharacter -EndCharacter [-Wait] - [-ResponseTimeout ] [-ProgressAction ] [] -``` - -## DESCRIPTION -This cmdlet returns an object representing the range between two positions in a given document. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-VSCodeRange -StartLine 0 -EndLine 10 -StartCharacter 0 -EndCharacter 80 -``` - -Gets the range between the start of the document to line 10, character 80. - -### Example 2 -```powershell -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 -``` - -Sets the text decoration in a given range. - -## PARAMETERS - -### -EndCharacter -The 0-index end character. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndLine -The 0-index end line. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResponseTimeout -How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartCharacter -The 0-index beginning character. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartLine -The 0-index beginning line. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Whether to wait for the cmdlet to finish or return immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The four required parameters are 0-index, meaning they're 1 less than the visible editor lines and columns. - -## RELATED LINKS -https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/New-VSCodeTreeItem.md b/HostInjection/Help/New-VSCodeTreeItem.md deleted file mode 100644 index c468983..0000000 --- a/HostInjection/Help/New-VSCodeTreeItem.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# New-VSCodeTreeItem - -## SYNOPSIS -Creates a child tree item under a custom TreeView. - -## SYNTAX - -``` -New-VSCodeTreeItem -Label [-Description ] [-Tooltip ] [-Icon ] [-HasChildren] - [-DisableInvoke] [-ProgressAction ] [] -``` - -## DESCRIPTION -Given a TreeView item, creates a child TreeItem which can optionally have an action invoked when clicked. - -## EXAMPLES - -### Example 1 -```powershell -Register-VSCodeTreeView -Label 'Test' -LoadChildren { - 1..10 | % { New-VSCodeTreeItem -Label "Test$_" -Icon 'archive' -HasChildren } -} -Icon 'account' -InvokeChild { - Show-VSCodeMessage -Message $args[0].Path -} -``` - -Creates a tree view named Test that creates nested tree items. When each item is clicked, it will display a VS Code message. - -### Example 2 -```powershell -Register-VSCodeTreeView -Label 'GitHub' -LoadChildren { - New-VSCodeTreeItem -Label 'PowerShell Universal' -Description 'https://github.com/ironmansoftware/powershell-universal' -Icon 'github-inverted' - New-VSCodeTreeItem -Label 'Issues' -Description 'https://github.com/ironmansoftware/issues' -Icon 'github-inverted' - New-VSCodeTreeItem -Label 'PowerShell' -Description 'https://github.com/powershell/powershell' -Icon 'github-inverted' -} -Icon 'github' -InvokeChild { - Start-Process $args[0].Description -} -``` - -This example creates a tree view of GitHub repositories and opens each when clicked. - -## PARAMETERS - -### -Description -The item description, displayed to the right of the label / name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableInvoke -Indicate the item should not have a button to invoke an action. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HasChildren -Indicates the item has further children, i.e. it can be folded and unfolded to display child items. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Icon -A codicon icon name to display. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Label -The main name of the item to display and reference it with. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tooltip -The text to display on hover. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/powershell-explorer#custom-tree-view \ No newline at end of file diff --git a/HostInjection/Help/Open-VSCodeTextDocument.md b/HostInjection/Help/Open-VSCodeTextDocument.md deleted file mode 100644 index e0ec0cf..0000000 --- a/HostInjection/Help/Open-VSCodeTextDocument.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Open-VSCodeTextDocument - -## SYNOPSIS -Opens documents by file name. - -## SYNTAX - -``` -Open-VSCodeTextDocument -FileName [-Wait] [-ResponseTimeout ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -Given a file path, the cmdlet opens the document to edit. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Open-VSCodeTextDocument -FileName .\form.designer.ps1 -``` - -Opens the file 'form.designer.ps1' to edit. - -## PARAMETERS - -### -FileName -The file path to open, whether relative or absolute. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResponseTimeout -How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Whether to wait for the cmdlet to finish or return immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Out-VSCodeGridView.md b/HostInjection/Help/Out-VSCodeGridView.md deleted file mode 100644 index fdd94ad..0000000 --- a/HostInjection/Help/Out-VSCodeGridView.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Out-VSCodeGridView - -## SYNOPSIS -Displays data in a grid view similar to Out-GridView, except in a VS Code web view. - -## SYNTAX - -### PassThru (Default) -``` -Out-VSCodeGridView [-InputObject ] [-Title ] [-PassThru] [-Wait] [-ResponseTimeout ] - [-ProgressAction ] [] -``` - -### OutputMode -``` -Out-VSCodeGridView [-InputObject ] [-Title ] [-OutputMode ] [-Wait] - [-ResponseTimeout ] [-ProgressAction ] [] -``` - -## DESCRIPTION -Works the same as `Out-GridView`, except in a VS Code document. Uses the same parameters, allowing for pipeline-enabled passthru with optional item selection. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-Process | Out-VSCodeGridView -``` - -Shows all running processes. - -### Example 2 -```powershell -PS C:\> Get-History | Out-VSCodeGridView -OutputMode Multiple -``` - -Shows all commands run in the current session, returning selected items. - -## PARAMETERS - -### -InputObject -The object(s) to display. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -OutputMode -Works similarly to `Out-GridView -OutputMode `. - -Specifies the items that the interactive window sends down the pipeline as input to other commands. By default, this cmdlet does not generate any output. To send items from the interactive window down the pipeline, click to select the items and then click OK. - -The values of this parameter determine how many items you can send down the pipeline. - -```yaml -Type: OutputModeOption -Parameter Sets: OutputMode -Aliases: -Accepted values: None, Single, Multiple - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Works similar to `Out-GridView -PassThru`. - -Indicates that the cmdlet sends items from the interactive window down the pipeline as input to other commands. By default, this cmdlet does not generate any output. This parameter is equivalent to using the Multiple value of the `-OutputMode` parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: PassThru -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResponseTimeout -How long to wait before returning. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title -Similar to `Out-GridView -Title "Window Title"`, the text to show in the document title. - -Specifies the text that appears in the title bar of the `Out-VSCodeGridView` document. By default, the title bar displays nothing. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Similar to `Out-GridView -Wait`, specifies that the cmdlet should halt processing until the window is closed. - -Indicates that the cmdlet suppresses the command prompt and prevents Windows PowerShell from closing until the `Out-VSCodeGridView` window is closed. By default, the command prompt returns when the `Out-VSCodeGridView` window opens. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSObject - -## OUTPUTS - -### None -By default, the cmdlet generates no output. - -### System.Object -If `-PassThru` or `-OutputMode ` is used, sends the selected items through the pipeline. - -## NOTES - -## RELATED LINKS -https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/out-gridview?view=powershell-7.4&viewFallbackFrom=powershell-7.3&WT.mc_id=ps-gethelp \ No newline at end of file diff --git a/HostInjection/Help/Register-VSCodeTreeView.md b/HostInjection/Help/Register-VSCodeTreeView.md deleted file mode 100644 index bdd74f0..0000000 --- a/HostInjection/Help/Register-VSCodeTreeView.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Register-VSCodeTreeView - -## SYNOPSIS -Creates a TreeView entry in the Custom view. - -## SYNTAX - -``` -Register-VSCodeTreeView -Label [-Description ] [-Tooltip ] [-Icon ] - [-LoadChildren ] [-InvokeChild ] [-ProgressAction ] - [] -``` - -## DESCRIPTION -This cmdlet creates a TreeView entry, which can contain multiple recursive levels of TreeItem entries, whether invokable or not. - -## EXAMPLES - -### Example 1 -```powershell -Register-VSCodeTreeView -Label 'Test' -LoadChildren { - 1..10 | % { New-VSCodeTreeItem -Label "Test$_" -Icon 'archive' -HasChildren } -} -Icon 'account' -InvokeChild { - Show-VSCodeMessage -Message $args[0].Path -} -``` - -Creates a tree view named Test that creates nested tree items. When each item is clicked, it will display a VS Code message. - -### Example 2 -```powershell -Register-VSCodeTreeView -Label 'GitHub' -LoadChildren { - New-VSCodeTreeItem -Label 'PowerShell Universal' -Description 'https://github.com/ironmansoftware/powershell-universal' -Icon 'github-inverted' - New-VSCodeTreeItem -Label 'Issues' -Description 'https://github.com/ironmansoftware/issues' -Icon 'github-inverted' - New-VSCodeTreeItem -Label 'PowerShell' -Description 'https://github.com/powershell/powershell' -Icon 'github-inverted' -} -Icon 'github' -InvokeChild { - Start-Process $args[0].Description -} -``` - -This example creates a tree view of GitHub repositories and opens each when clicked. - -## PARAMETERS - -### -Description -The item description, displayed to the right of the label / name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Icon -A codicon icon name to display. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InvokeChild -The action to perform on child TreeItems. - -```yaml -Type: ScriptBlock -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Label -The main name displayed on the item which doubles as its ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadChildren -A script block containing one or more TreeItem creation actions using New-VSCodeTreeItem. - -```yaml -Type: ScriptBlock -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tooltip -The text to display on hover. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/powershell-explorer#custom-tree-view \ No newline at end of file diff --git a/HostInjection/Help/Remove-VSCodeTextDocumentText.md b/HostInjection/Help/Remove-VSCodeTextDocumentText.md deleted file mode 100644 index 6b3fee2..0000000 --- a/HostInjection/Help/Remove-VSCodeTextDocumentText.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Remove-VSCodeTextDocumentText - -## SYNOPSIS -Removes a range of text from a document. - -## SYNTAX - -``` -Remove-VSCodeTextDocumentText -TextDocument -Range [-Wait] - [-ResponseTimeout ] [-ProgressAction ] [] -``` - -## DESCRIPTION -Given a document object, removes a range of text. This creates an edit but does not save the file. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $Range = New-VSCodeRange -StartLine 0 -EndLine 0 -StartCharacter 0 -EndCharacter 10 -PS C:\> Get-VSCodeTextDocument | Remove-VSCodeTextDocumentText -Range $Range -``` - -Removes 10 characters from the first line of a document. - -## PARAMETERS - -### -Range -A file range retrieved with New-VSCodeRange. - -```yaml -Type: VsCodeRange -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResponseTimeout -How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TextDocument -The text document to act on, retrieved with Get-VSCodeTextDocument. - -```yaml -Type: VsCodeTextDocument -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Wait -Whether to wait for the cmdlet to finish or return immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Remove-VSCodeTextEditor.md b/HostInjection/Help/Remove-VSCodeTextEditor.md deleted file mode 100644 index d1263a2..0000000 --- a/HostInjection/Help/Remove-VSCodeTextEditor.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Remove-VSCodeTextEditor - -## SYNOPSIS -Close editors that are already open. - -## SYNTAX - -``` -Remove-VSCodeTextEditor -TextEditor [-Wait] [-ResponseTimeout ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This cmdlet closes editors that are already open, given TextEditor object(s). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-VSCodeTextEditor | Remove-VSCodeTextEditor -``` - -Closes open editors. - -## PARAMETERS - -### -ResponseTimeout -How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TextEditor -The text editor to act on, retrieved with Get-VSCodeTextEditor. - -```yaml -Type: VsCodeTextEditor -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Wait -Whether to wait for the cmdlet to finish or return immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextEditor - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Send-VSCodeTerminalText.md b/HostInjection/Help/Send-VSCodeTerminalText.md deleted file mode 100644 index 89da467..0000000 --- a/HostInjection/Help/Send-VSCodeTerminalText.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Send-VSCodeTerminalText - -## SYNOPSIS -Sends text to the specified terminal. - -## SYNTAX - -### name -``` -Send-VSCodeTerminalText -Name -Text [-AddNewLine] [-Wait] [-ResponseTimeout ] - [-ProgressAction ] [] -``` - -### terminal -``` -Send-VSCodeTerminalText -Terminal -Text [-AddNewLine] [-Wait] - [-ResponseTimeout ] [-ProgressAction ] [] -``` - -## DESCRIPTION -The cmdlet sends text to the specified terminal, whether from a terminal name or object. You can commit this text by including the -AddNewLine parameter. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-VSCodeTerminal | Where-Object Name -eq 'PowerShell Integrated Console' | Send-VSCodeTerminalText -Text 'Write-Host "Hello World!"' -``` - -Sends the line `Write-Host "Hello World!"` to the PowerShell Integrated Console. - -## PARAMETERS - -### -AddNewLine -Whether to send a newline at the end of the text, effectively running it immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the terminal to interact with. - -```yaml -Type: String -Parameter Sets: name -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResponseTimeout -How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Terminal -The terminal object to interact with. See: Get-VSCodeTerminal - -```yaml -Type: VsCodeTerminal -Parameter Sets: terminal -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Text -The text string to send to the terminal. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Whether to wait for the cmdlet to finish or return immediately. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### PowerShellToolsPro.Cmdlets.VSCode.VsCodeTerminal - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Set-VSCodeStatusBarMessage.md b/HostInjection/Help/Set-VSCodeStatusBarMessage.md deleted file mode 100644 index 76fe29e..0000000 --- a/HostInjection/Help/Set-VSCodeStatusBarMessage.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Set-VSCodeStatusBarMessage - -## SYNOPSIS -Sets a status bar message. - -## SYNTAX - -``` -Set-VSCodeStatusBarMessage -Message [-Timeout ] [-Wait] [-ResponseTimeout ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This cmdlet sets the text on the extension 'extension status' status bar item. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-VSCodeStatusBarMessage -Message 'Hellllloooo' -``` - -Sets the status bar to `Hellllloooo`. - -## PARAMETERS - -### -Message -The text to send to the status bar. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResponseTimeout -How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timeout -How long the status bar message should display in milliseconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Whether to wait for the cmdlet to finish or return immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Set-VSCodeTextEditorDecoration.md b/HostInjection/Help/Set-VSCodeTextEditorDecoration.md deleted file mode 100644 index 2f66f47..0000000 --- a/HostInjection/Help/Set-VSCodeTextEditorDecoration.md +++ /dev/null @@ -1,445 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Set-VSCodeTextEditorDecoration - -## SYNOPSIS -Decorates a range of text with an optional set of colors, outlines, borders, and text. - -## SYNTAX - -``` -Set-VSCodeTextEditorDecoration -TextEditor -Range -Key - [-BackgroundColor ] [-Border ] [-BorderColor ] [-BorderRadius ] - [-BorderStyle ] [-BorderWidth ] [-Color ] [-Cursor ] [-FontStyle ] - [-FontWeight ] [-IsWholeLine] [-LetterSpacing ] [-Opacity ] [-Outline ] - [-OutlineColor ] [-OutlineStyle ] [-OutlineWidth ] [-RangeBehavior ] - [-TextDecoration ] [-After ] [-Before ] [-Wait] - [-ResponseTimeout ] [-ProgressAction ] [] -``` - -## DESCRIPTION -The cmdlet decorates a range of text with an optional set of colors, outlines, borders, and text. - -## EXAMPLES - -### Example 1 -```powershell -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 -``` - -Sets a document range's background color to the 'descriptionForeground' element, and the text to bold. - -## PARAMETERS - -### -After -Ignored. Commented out in vscodeService.ts: `//after = After`. - -```yaml -Type: DecorationAttachment -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackgroundColor -The background color. This is passed directly to `vscode.TextEditor.setDecoration` in the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Before -Ignored. Commented out in vscodeService.ts: `//before = Before`. - -```yaml -Type: DecorationAttachment -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Border -This is passed directly to `vscode.TextEditor.setDecoration` in the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BorderColor -This is passed directly to `vscode.TextEditor.setDecoration` in the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BorderRadius -This is passed directly to `vscode.TextEditor.setDecoration` in the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BorderStyle -This is passed directly to `vscode.TextEditor.setDecoration` in the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BorderWidth -This is passed directly to `vscode.TextEditor.setDecoration` in the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Color -This is passed directly to `vscode.TextEditor.setDecoration` in the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Cursor -This is passed directly to `vscode.TextEditor.setDecoration` in the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FontStyle -This is passed directly to `vscode.TextEditor.setDecoration` in the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FontWeight -This is passed directly to `vscode.TextEditor.setDecoration` in the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsWholeLine -This is passed directly to `vscode.TextEditor.setDecoration` in the extension. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Key -This is passed directly to `vscode.TextEditor.setDecoration` in the extension. See: `this.decorations[msg.args.key] = decorationType;` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LetterSpacing -This is passed directly to `vscode.TextEditor.setDecoration` in the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Opacity -This is passed directly to `vscode.TextEditor.setDecoration` in the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Outline -This is passed directly to `vscode.TextEditor.setDecoration` in the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutlineColor -This is passed directly to `vscode.TextEditor.setDecoration` in the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutlineStyle -This is passed directly to `vscode.TextEditor.setDecoration` in the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutlineWidth -This is passed directly to `vscode.TextEditor.setDecoration` in the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Range -The document range to set decoration on. - -```yaml -Type: VsCodeRange -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RangeBehavior -Passed to `vscode.DecorationRangeBehavior`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: ClosedClosed, ClosedOpen, OpenClosed, OpenOpen - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResponseTimeout -How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TextDecoration -This is passed directly to `vscode.TextEditor.setDecoration` in the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TextEditor -The text editor object to set the decoration on. - -```yaml -Type: VsCodeTextEditor -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Wait -Whether to wait for the cmdlet to finish or return immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextEditor - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Show-VSCodeInputBox.md b/HostInjection/Help/Show-VSCodeInputBox.md deleted file mode 100644 index 44798f6..0000000 --- a/HostInjection/Help/Show-VSCodeInputBox.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Show-VSCodeInputBox - -## SYNOPSIS -Shows an input box for the user to enter arbitrary text. - -## SYNTAX - -``` -Show-VSCodeInputBox [-IgnoreFocusOut] [-Password] [-PlaceHolder ] [-Prompt ] [-Value ] - [-StartValueSelection ] [-EndValueSelection ] [-Wait] [-ResponseTimeout ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This cmdlet shows an input box for the user to enter arbitrary text, which is returned to PowerShell. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Show-VSCodeInputBox -PlaceHolder 'Enter some text' -``` - -Requests input with the default value `Enter some text` - -## PARAMETERS - -### -EndValueSelection -Don't know. A tuplet is created from this and StartValueSelection. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreFocusOut -Don't close the input if it loses focus. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -Specifies the input should be masked. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlaceHolder -The default value to fill the input box with. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prompt -The user prompt for the input. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResponseTimeout -How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartValueSelection -Don't know. A tuplet is created from this and EndValueSelection. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Value -The value to fill the input with, I guess? - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Whether to wait for the cmdlet to finish or return immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS -https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Show-VSCodeMessage.md b/HostInjection/Help/Show-VSCodeMessage.md deleted file mode 100644 index fe71117..0000000 --- a/HostInjection/Help/Show-VSCodeMessage.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Show-VSCodeMessage - -## SYNOPSIS -Show a message to the user and provide an option for them to select. - -## SYNTAX - -``` -Show-VSCodeMessage -Message [-Items ] [-Modal] [-Type ] [-Wait] - [-ResponseTimeout ] [-ProgressAction ] [] -``` - -## DESCRIPTION -Show a message to the user and provide an option for them to select. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Show-VSCodeMessage -Message 'What should we do?' -Items @('Party', 'Sleep') -``` - -Shows a prompt with two selectable buttons. - -## PARAMETERS - -### -Items -An array of strings that will be shown as buttons, with the first as the default. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Message -The prompt text. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Modal -Specify that the prompt should be a system modal dialogue (takes focus until closed) instead of a styled application message. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResponseTimeout -How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The type of message to show. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Error, Warning, Information - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Whether to wait for the cmdlet to finish or return immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Show-VSCodeQuickPick.md b/HostInjection/Help/Show-VSCodeQuickPick.md deleted file mode 100644 index e09e1ad..0000000 --- a/HostInjection/Help/Show-VSCodeQuickPick.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Show-VSCodeQuickPick - -## SYNOPSIS -Shows a quick pick list for a user to select items from. - -## SYNTAX - -``` -Show-VSCodeQuickPick [-PlaceHolder ] -Items [-CanPickMany] [-IgnoreFocusOut] [-Wait] - [-ResponseTimeout ] [-ProgressAction ] [] -``` - -## DESCRIPTION -Shows a quick pick list for a user to select items from. This cmdlet will return the user's selection to PowerShell. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Show-VSCodeQuickPick -PlaceHolder 'What should we do?' -Items @('Party', 'Sleep') -``` - -Shows a dropdown prompt at the command bar with a list of selectable items. - -## PARAMETERS - -### -CanPickMany -Specify that multiple items can be checked. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreFocusOut -Don't close if focus is lost. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Items -An array of selectable items to display. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlaceHolder -The default item to select in the prompt. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResponseTimeout -How long to wait for the cmdlet to return in milliseconds. Defaults to 5 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Whether to wait for the cmdlet to finish or return immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -https://docs.poshtools.com/powershell-pro-tools-documentation/visual-studio-code/automating-visual-studio-code \ No newline at end of file diff --git a/HostInjection/Help/Todo/Get-CompletionItem.md b/HostInjection/Help/Todo/Get-CompletionItem.md deleted file mode 100644 index 9a7a604..0000000 --- a/HostInjection/Help/Todo/Get-CompletionItem.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Get-CompletionItem - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -### Types -``` -Get-CompletionItem [-Types] [-IgnoredTypes ] [-IgnoredAssemblies ] - [-ProgressAction ] [] -``` - -### Commands -``` -Get-CompletionItem -Command [-IgnoredModules ] [-IgnoredCommands ] - [-ProgressAction ] [] -``` - -### Variable -``` -Get-CompletionItem -Variable [-IgnoredVariables ] [-ProgressAction ] - [] -``` - -### File -``` -Get-CompletionItem -File [-ProgressAction ] [] -``` - -### Directory -``` -Get-CompletionItem -Directory [-ProgressAction ] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -Command -{{ Fill Command Description }} - -```yaml -Type: CommandInfo -Parameter Sets: Commands -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Directory -{{ Fill Directory Description }} - -```yaml -Type: DirectoryInfo -Parameter Sets: Directory -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -File -{{ Fill File Description }} - -```yaml -Type: FileInfo -Parameter Sets: File -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IgnoredAssemblies -{{ Fill IgnoredAssemblies Description }} - -```yaml -Type: String -Parameter Sets: Types -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoredCommands -{{ Fill IgnoredCommands Description }} - -```yaml -Type: String -Parameter Sets: Commands -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoredModules -{{ Fill IgnoredModules Description }} - -```yaml -Type: String -Parameter Sets: Commands -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoredTypes -{{ Fill IgnoredTypes Description }} - -```yaml -Type: String -Parameter Sets: Types -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoredVariables -{{ Fill IgnoredVariables Description }} - -```yaml -Type: String -Parameter Sets: Variable -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Types -{{ Fill Types Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: Types -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Variable -{{ Fill Variable Description }} - -```yaml -Type: Variable -Parameter Sets: Variable -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.CommandInfo - -### PowerShellTools.Common.ServiceManagement.DebuggingContract.Variable - -### System.IO.FileInfo - -### System.IO.DirectoryInfo - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/HostInjection/Help/Todo/Get-PoshToolsVariable.md b/HostInjection/Help/Todo/Get-PoshToolsVariable.md deleted file mode 100644 index d82323a..0000000 --- a/HostInjection/Help/Todo/Get-PoshToolsVariable.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Get-PoshToolsVariable - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Get-PoshToolsVariable -Path [-ValueOnly] [-ProgressAction ] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -Path -{{ Fill Path Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValueOnly -{{ Fill ValueOnly Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/HostInjection/Help/Todo/Measure-Block.md b/HostInjection/Help/Todo/Measure-Block.md deleted file mode 100644 index 1765cc2..0000000 --- a/HostInjection/Help/Todo/Measure-Block.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Measure-Block - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -### file -``` -Measure-Block [-ScriptBlock ] [-FileName ] -StartOffset -EndOffset - [-ProgressAction ] [] -``` - -### module -``` -Measure-Block [-ScriptBlock ] -ModuleName -CommandName -PipelineMethod - [-ProgressAction ] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -CommandName -{{ Fill CommandName Description }} - -```yaml -Type: String -Parameter Sets: module -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndOffset -{{ Fill EndOffset Description }} - -```yaml -Type: Int32 -Parameter Sets: file -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileName -{{ Fill FileName Description }} - -```yaml -Type: String -Parameter Sets: file -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModuleName -{{ Fill ModuleName Description }} - -```yaml -Type: String -Parameter Sets: module -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PipelineMethod -{{ Fill PipelineMethod Description }} - -```yaml -Type: String -Parameter Sets: module -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScriptBlock -{{ Fill ScriptBlock Description }} - -```yaml -Type: ScriptBlock -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartOffset -{{ Fill StartOffset Description }} - -```yaml -Type: Int32 -Parameter Sets: file -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/HostInjection/Help/Todo/Measure-Script.md b/HostInjection/Help/Todo/Measure-Script.md deleted file mode 100644 index 0762277..0000000 --- a/HostInjection/Help/Todo/Measure-Script.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Measure-Script - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -### ScriptBlock -``` -Measure-Script [-ScriptBlock] [-ProgressAction ] [] -``` - -### FilePath -``` -Measure-Script [-FilePath] [-ProgressAction ] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -FilePath -{{ Fill FilePath Description }} - -```yaml -Type: String -Parameter Sets: FilePath -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScriptBlock -{{ Fill ScriptBlock Description }} - -```yaml -Type: ScriptBlock -Parameter Sets: ScriptBlock -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/HostInjection/Help/Todo/New-VSCodeDecorationAttachment.md b/HostInjection/Help/Todo/New-VSCodeDecorationAttachment.md deleted file mode 100644 index 73aa581..0000000 --- a/HostInjection/Help/Todo/New-VSCodeDecorationAttachment.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# New-VSCodeDecorationAttachment - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -New-VSCodeDecorationAttachment [-BackgroundColor ] [-Border ] [-BorderColor ] - [-Color ] [-ContentText ] [-FontStyle ] [-FontWeight ] [-Height ] - [-Margin ] [-TextDecoration ] [-Width ] [-ProgressAction ] - [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -BackgroundColor -{{ Fill BackgroundColor Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Border -{{ Fill Border Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BorderColor -{{ Fill BorderColor Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Color -{{ Fill Color Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentText -{{ Fill ContentText Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FontStyle -{{ Fill FontStyle Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FontWeight -{{ Fill FontWeight Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Height -{{ Fill Height Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Margin -{{ Fill Margin Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TextDecoration -{{ Fill TextDecoration Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Width -{{ Fill Width Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/HostInjection/Help/Todo/Out-PoshToolsVariable.md b/HostInjection/Help/Todo/Out-PoshToolsVariable.md deleted file mode 100644 index 5f5c8bd..0000000 --- a/HostInjection/Help/Todo/Out-PoshToolsVariable.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Out-PoshToolsVariable - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Out-PoshToolsVariable [-InputObject ] [-PassThru] [-ExcludeAutomatic ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -ExcludeAutomatic -{{ Fill ExcludeAutomatic Description }} - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -{{ Fill InputObject Description }} - -```yaml -Type: PSVariable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -{{ Fill PassThru Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSVariable - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/HostInjection/Help/Todo/PowerShellProTools.VSCode.md b/HostInjection/Help/Todo/PowerShellProTools.VSCode.md deleted file mode 100644 index 5a0c7a5..0000000 --- a/HostInjection/Help/Todo/PowerShellProTools.VSCode.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -Module Name: PowerShellProTools.VSCode -Module Guid: 6445e5c3-d794-4af8-82a4-7ee94e0d4f1b -Download Help Link: {{ Update Download Link }} -Help Version: {{ Please enter version of help manually (X.X.X.X) format }} -Locale: en-US ---- - -# PowerShellProTools.VSCode Module -## Description -{{ Fill in the Description }} - -## PowerShellProTools.VSCode Cmdlets -### [Add-VSCodeTextDocumentText](Add-VSCodeTextDocumentText.md) -{{ Fill in the Description }} - -### [Clear-VSCodeDecoration](Clear-VSCodeDecoration.md) -{{ Fill in the Description }} - -### [Get-CompletionItem](Get-CompletionItem.md) -{{ Fill in the Description }} - -### [Get-PoshToolsVariable](Get-PoshToolsVariable.md) -{{ Fill in the Description }} - -### [Get-VSCodeTerminal](Get-VSCodeTerminal.md) -{{ Fill in the Description }} - -### [Get-VSCodeTextDocument](Get-VSCodeTextDocument.md) -{{ Fill in the Description }} - -### [Get-VSCodeTextDocumentText](Get-VSCodeTextDocumentText.md) -{{ Fill in the Description }} - -### [Get-VSCodeTextEditor](Get-VSCodeTextEditor.md) -{{ Fill in the Description }} - -### [Measure-Block](Measure-Block.md) -{{ Fill in the Description }} - -### [Measure-Script](Measure-Script.md) -{{ Fill in the Description }} - -### [New-VSCodeDecorationAttachment](New-VSCodeDecorationAttachment.md) -{{ Fill in the Description }} - -### [New-VSCodePosition](New-VSCodePosition.md) -{{ Fill in the Description }} - -### [New-VSCodeRange](New-VSCodeRange.md) -{{ Fill in the Description }} - -### [New-VSCodeTreeItem](New-VSCodeTreeItem.md) -{{ Fill in the Description }} - -### [Open-VSCodeTextDocument](Open-VSCodeTextDocument.md) -{{ Fill in the Description }} - -### [Out-PoshToolsVariable](Out-PoshToolsVariable.md) -{{ Fill in the Description }} - -### [Out-VSCodeGridView](Out-VSCodeGridView.md) -{{ Fill in the Description }} - -### [Register-VSCodeTreeView](Register-VSCodeTreeView.md) -{{ Fill in the Description }} - -### [Remove-VSCodeTextDocumentText](Remove-VSCodeTextDocumentText.md) -{{ Fill in the Description }} - -### [Remove-VSCodeTextEditor](Remove-VSCodeTextEditor.md) -{{ Fill in the Description }} - -### [Send-VSCodeTerminalText](Send-VSCodeTerminalText.md) -{{ Fill in the Description }} - -### [Set-VSCodeStatusBarMessage](Set-VSCodeStatusBarMessage.md) -{{ Fill in the Description }} - -### [Set-VSCodeTextEditorDecoration](Set-VSCodeTextEditorDecoration.md) -{{ Fill in the Description }} - -### [Show-VSCodeInputBox](Show-VSCodeInputBox.md) -{{ Fill in the Description }} - -### [Show-VSCodeMessage](Show-VSCodeMessage.md) -{{ Fill in the Description }} - -### [Show-VSCodeQuickPick](Show-VSCodeQuickPick.md) -{{ Fill in the Description }} - -### [Start-PoshToolsServer](Start-PoshToolsServer.md) -{{ Fill in the Description }} - diff --git a/HostInjection/Help/Todo/Start-PoshToolsServer.md b/HostInjection/Help/Todo/Start-PoshToolsServer.md deleted file mode 100644 index d7c5100..0000000 --- a/HostInjection/Help/Todo/Start-PoshToolsServer.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: PowerShellProTools.VSCode.dll-Help.xml -Module Name: PowerShellProTools.VSCode -online version: -schema: 2.0.0 ---- - -# Start-PoshToolsServer - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Start-PoshToolsServer [[-PipeName] ] [-ProgressAction ] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -PipeName -{{ Fill PipeName Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS From 50e7ba476acbe0e3efbd6563854c4eef84560615 Mon Sep 17 00:00:00 2001 From: TMA-2 Date: Fri, 14 Mar 2025 23:47:51 -0500 Subject: [PATCH 7/7] Pared down the code-workspace --- PowerShellProTools.code-workspace | 32 +++++-------------------------- 1 file changed, 5 insertions(+), 27 deletions(-) diff --git a/PowerShellProTools.code-workspace b/PowerShellProTools.code-workspace index b4389dd..0bf4e77 100644 --- a/PowerShellProTools.code-workspace +++ b/PowerShellProTools.code-workspace @@ -7,19 +7,12 @@ ], "settings": { "files.exclude": { - "**/*.rpyc": true, - "**/*.rpa": true, - "**/*.rpymc": true, - "**/cache/": true + ".vs/": true, + "bin/": true, + "obj/": true, + "node_modules/": false, }, - "[csharp]": { - "editor.maxTokenizationLineLength": 2500 - }, - "powershell.sideBar.CommandExplorerVisibility": false, - "powershell.buttons.showPanelMovementButtons": false, - "powershell.pester.codeLens": false, - "powershell.enableProfileLoading": true, - "powershell.cwd": "Source", + "powershell.cwd": "PS Pro Tools", "powershell.developer.editorServicesLogLevel": "Information", "powershell.trace.server": "messages", "dotnet.defaultSolution": "Source/powershell-pro-tools", @@ -34,20 +27,5 @@ "xml.codeLens.enabled": true, "xml.format.joinContentLines": true, "xml.trace.server": "messages", - "xml.validation.namespaces.enabled": "onNamespaceEncountered", - "xml.colors": [ - { - "expressions": [ - { - "xpath": "/Project/PropertyGroup/TargetFramework", - // goldenrod - "color": "#DAA520" - } - ], - "pattern": "**/*.csproj" - } - ], - // "xml.format.xsiSchemaLocationSplit": "none", - "todo-tree.tree.scanMode": "open files" } } \ No newline at end of file