diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 3198345..ed82a9a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -86,7 +86,7 @@ jobs: shell: pwsh run: | Import-Module .\Build\Modules\InvokeBuild\5.14.23\InvokeBuild.psd1 -Force - Install-Module PlatyPS -Scope CurrentUser -Force + Install-Module Microsoft.PowerShell.PlatyPS -RequiredVersion 1.0.1 -Scope CurrentUser -Force -AllowClobber Invoke-Build -File .\vscode\vscode.build.ps1 env: AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }} diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 37b1ef9..2908d0f 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -84,7 +84,7 @@ jobs: shell: pwsh run: | Import-Module .\Build\Modules\InvokeBuild\5.14.23\InvokeBuild.psd1 -Force - Install-Module PlatyPS -Scope CurrentUser -Force + Install-Module Microsoft.PowerShell.PlatyPS -RequiredVersion 1.0.1 -Scope CurrentUser -Force -AllowClobber Invoke-Build -File .\vscode\vscode.build.ps1 env: AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }} diff --git a/AGENTS.md b/AGENTS.md index 41e5cd1..66e4e85 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -50,7 +50,7 @@ Prefer targeted validation for the component you changed. - Build the VS Code extension as CI does: ```powershell Import-Module .\Build\Modules\InvokeBuild\5.14.23\InvokeBuild.psd1 -Force - Install-Module PlatyPS -Scope CurrentUser -Force + Install-Module Microsoft.PowerShell.PlatyPS -RequiredVersion 1.0.1 -Scope CurrentUser -Force -AllowClobber Invoke-Build -File .\vscode\vscode.build.ps1 ``` - For VS Code-only TypeScript changes, use the lighter commands from `vscode\powershellprotools`: diff --git a/HostInjection/CreateHelp.ps1 b/HostInjection/CreateHelp.ps1 new file mode 100644 index 0000000..3cc1d7d --- /dev/null +++ b/HostInjection/CreateHelp.ps1 @@ -0,0 +1,38 @@ +param( + [string]$HelpPath = (Join-Path $PSScriptRoot "Help"), + [string]$OutputPath = (Join-Path $PSScriptRoot "en-US") +) + +$platyps = Import-Module Microsoft.PowerShell.PlatyPS -RequiredVersion 1.0.1 -PassThru -ErrorAction SilentlyContinue +if ($null -eq $platyps) { + Install-Module Microsoft.PowerShell.PlatyPS -RequiredVersion 1.0.1 -Scope CurrentUser -Force -AllowClobber + Import-Module Microsoft.PowerShell.PlatyPS -RequiredVersion 1.0.1 +} + +$commandHelp = Import-MarkdownCommandHelp -Path (Join-Path $HelpPath "*.md") +$externalHelpFiles = $commandHelp | Select-Object -ExpandProperty ExternalHelpFile -Unique +Export-MamlCommandHelp -CommandHelp $commandHelp -OutputFolder $OutputPath -Force | Out-Null + +Get-ChildItem $OutputPath -Filter "*-Help.xml" -Recurse | + Where-Object { $_.DirectoryName -ne (Resolve-Path $OutputPath).Path } | + Where-Object { $externalHelpFiles -contains $_.Name } | + ForEach-Object { + Copy-Item $_.FullName -Destination (Join-Path $OutputPath $_.Name) -Force + } + +Get-ChildItem $OutputPath -Directory | Remove-Item -Recurse -Force + +$utf8NoBom = New-Object System.Text.UTF8Encoding $false +Get-ChildItem $OutputPath -Filter "*-Help.xml" | ForEach-Object { + if ($externalHelpFiles -notcontains $_.Name) { + return + } + + $content = [System.IO.File]::ReadAllText($_.FullName) + $lines = $content -split "\r?\n" | ForEach-Object { $_ -replace "\s+$", "" } + $content = ($lines | Where-Object { $null -ne $_ }) -join "`n" + if (-not $content.EndsWith("`n")) { + $content += "`n" + } + [System.IO.File]::WriteAllText($_.FullName, $content, $utf8NoBom) +} diff --git a/HostInjection/Help/Add-VSCodeTextDocumentText.md b/HostInjection/Help/Add-VSCodeTextDocumentText.md new file mode 100644 index 0000000..99421ef --- /dev/null +++ b/HostInjection/Help/Add-VSCodeTextDocumentText.md @@ -0,0 +1,178 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Add-VSCodeTextDocumentText +--- + +# Add-VSCodeTextDocumentText + +## SYNOPSIS + +Adds text to a Visual Studio Code text document. + +## SYNTAX + +### __AllParameterSets + +``` +Add-VSCodeTextDocumentText -TextDocument -Position + -Text [-Wait] [-ResponseTimeout ] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Adds text to a Visual Studio Code text document at the specified position. Use this command when automating editor changes from PowerShell running inside the PowerShell Pro Tools host. + +## EXAMPLES + +### Example 1 + +```powershell +$document = Get-VSCodeTextDocument +$position = New-VSCodePosition -Line 0 -Character 0 +Add-VSCodeTextDocumentText -TextDocument $document -Position $position -Text '# Header' +``` +Adds text to the beginning of the active document. + +## PARAMETERS + +### -Position + +The position where text is inserted. + +```yaml +Type: PowerShellToolsPro.Cmdlets.VSCode.VsCodePosition +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ResponseTimeout + +The number of milliseconds to wait for a response from Visual Studio Code. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Text + +The text to insert or send. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -TextDocument + +The text document to read or update. + +```yaml +Type: PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Wait + +Waits for the VS Code command response before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument + +This command returns objects described by the section heading. + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Clear-VSCodeDecoration.md b/HostInjection/Help/Clear-VSCodeDecoration.md new file mode 100644 index 0000000..343fea8 --- /dev/null +++ b/HostInjection/Help/Clear-VSCodeDecoration.md @@ -0,0 +1,129 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Clear-VSCodeDecoration +--- + +# Clear-VSCodeDecoration + +## SYNOPSIS + +Clears a text editor decoration in Visual Studio Code. + +## SYNTAX + +### __AllParameterSets + +``` +Clear-VSCodeDecoration [-Key ] [-Wait] [-ResponseTimeout ] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Clears a decoration that was previously created with Set-VSCodeTextEditorDecoration. The key identifies which decoration registration to remove. + +## EXAMPLES + +### Example 1 + +```powershell +Clear-VSCodeDecoration -Key 'search-highlight' +``` +Clears the decoration identified by the key. + +## PARAMETERS + +### -Key + +The unique key used to identify a decoration. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ResponseTimeout + +The number of milliseconds to wait for a response from Visual Studio Code. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Wait + +Waits for the VS Code command response before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Get-CompletionItem.md b/HostInjection/Help/Get-CompletionItem.md new file mode 100644 index 0000000..47a7907 --- /dev/null +++ b/HostInjection/Help/Get-CompletionItem.md @@ -0,0 +1,318 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Get-CompletionItem +--- + +# Get-CompletionItem + +## SYNOPSIS + +Returns completion items for PowerShell code. + +## SYNTAX + +### Types + +``` +Get-CompletionItem -Types [-IgnoredTypes ] [-IgnoredAssemblies ] + [] +``` + +### Commands + +``` +Get-CompletionItem -Command [-IgnoredModules ] [-IgnoredCommands ] + [] +``` + +### Variable + +``` +Get-CompletionItem -Variable [-IgnoredVariables ] [] +``` + +### File + +``` +Get-CompletionItem -File [] +``` + +### Directory + +``` +Get-CompletionItem -Directory [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Returns completion items for a command, variable, type, or file path based on the supplied PowerShell context. The command is used by RapidSense and editor completion features. + +## EXAMPLES + +### Example 1 + +```powershell +Get-CompletionItem -Command 'Get-Pro' +``` +Returns completion items for a partially typed command. + +## PARAMETERS + +### -Command + +The command text to complete. + +```yaml +Type: System.Management.Automation.CommandInfo +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: Commands + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Directory + +The working directory used when resolving completions. + +```yaml +Type: System.IO.DirectoryInfo +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: Directory + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -File + +The file path used as completion context. + +```yaml +Type: System.IO.FileInfo +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: File + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -IgnoredAssemblies + +Assembly names to exclude from completion results. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: Types + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -IgnoredCommands + +Command names to exclude from completion results. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: Commands + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -IgnoredModules + +Module names to exclude from completion results. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: Commands + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -IgnoredTypes + +Type names to exclude from completion results. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: Types + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -IgnoredVariables + +Variable names to exclude from completion results. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: Variable + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Types + +Type names to include in completion context. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: Types + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Variable + +The variable name to complete. + +```yaml +Type: PowerShellTools.Common.ServiceManagement.DebuggingContract.Variable +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: Variable + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.CommandInfo + +This command returns objects described by the section heading. + +### PowerShellTools.Common.ServiceManagement.DebuggingContract.Variable + +This command returns objects described by the section heading. + +### System.IO.FileInfo + +This command returns objects described by the section heading. + +### System.IO.DirectoryInfo + +This command returns objects described by the section heading. + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Get-PoshToolsVariable.md b/HostInjection/Help/Get-PoshToolsVariable.md new file mode 100644 index 0000000..9bbdb32 --- /dev/null +++ b/HostInjection/Help/Get-PoshToolsVariable.md @@ -0,0 +1,108 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Get-PoshToolsVariable +--- + +# Get-PoshToolsVariable + +## SYNOPSIS + +Gets a variable stored by the PowerShell Pro Tools host. + +## SYNTAX + +### __AllParameterSets + +``` +Get-PoshToolsVariable -Path [-ValueOnly] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Retrieves a variable value stored by the PowerShell Pro Tools host. Use ValueOnly to return only the value rather than the host variable wrapper. + +## EXAMPLES + +### Example 1 + +```powershell +Get-PoshToolsVariable -Path 'Session.Result' -ValueOnly +``` +Returns only the value stored at the specified host variable path. + +## PARAMETERS + +### -Path + +The path to the input file or host variable. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ValueOnly + +Returns only the stored variable value. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Get-VSCodeTerminal.md b/HostInjection/Help/Get-VSCodeTerminal.md new file mode 100644 index 0000000..01ea2f6 --- /dev/null +++ b/HostInjection/Help/Get-VSCodeTerminal.md @@ -0,0 +1,108 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Get-VSCodeTerminal +--- + +# Get-VSCodeTerminal + +## SYNOPSIS + +Gets the active Visual Studio Code terminal. + +## SYNTAX + +### __AllParameterSets + +``` +Get-VSCodeTerminal [-Wait] [-ResponseTimeout ] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Returns the active Visual Studio Code terminal object so it can be used with commands such as Send-VSCodeTerminalText. + +## EXAMPLES + +### Example 1 + +```powershell +$terminal = Get-VSCodeTerminal +``` +Gets the active terminal. + +## PARAMETERS + +### -ResponseTimeout + +The number of milliseconds to wait for a response from Visual Studio Code. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Wait + +Waits for the VS Code command response before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Get-VSCodeTextDocument.md b/HostInjection/Help/Get-VSCodeTextDocument.md new file mode 100644 index 0000000..f1c3680 --- /dev/null +++ b/HostInjection/Help/Get-VSCodeTextDocument.md @@ -0,0 +1,108 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Get-VSCodeTextDocument +--- + +# Get-VSCodeTextDocument + +## SYNOPSIS + +Gets the active Visual Studio Code text document. + +## SYNTAX + +### __AllParameterSets + +``` +Get-VSCodeTextDocument [-Wait] [-ResponseTimeout ] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Returns the active Visual Studio Code text document object for use with commands that read or update editor text. + +## EXAMPLES + +### Example 1 + +```powershell +$document = Get-VSCodeTextDocument +``` +Gets the active text document. + +## PARAMETERS + +### -ResponseTimeout + +The number of milliseconds to wait for a response from Visual Studio Code. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Wait + +Waits for the VS Code command response before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Get-VSCodeTextDocumentText.md b/HostInjection/Help/Get-VSCodeTextDocumentText.md new file mode 100644 index 0000000..949bb4b --- /dev/null +++ b/HostInjection/Help/Get-VSCodeTextDocumentText.md @@ -0,0 +1,156 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Get-VSCodeTextDocumentText +--- + +# Get-VSCodeTextDocumentText + +## SYNOPSIS + +Gets text from a Visual Studio Code text document. + +## SYNTAX + +### __AllParameterSets + +``` +Get-VSCodeTextDocumentText -TextDocument [-Range ] [-Wait] + [-ResponseTimeout ] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Gets text from a Visual Studio Code text document. Provide a range to retrieve only part of the document. + +## EXAMPLES + +### Example 1 + +```powershell +$document = Get-VSCodeTextDocument +Get-VSCodeTextDocumentText -TextDocument $document +``` +Returns all text from the active document. + +## PARAMETERS + +### -Range + +The range of text to read, remove, or decorate. + +```yaml +Type: PowerShellToolsPro.Cmdlets.VSCode.VsCodeRange +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ResponseTimeout + +The number of milliseconds to wait for a response from Visual Studio Code. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -TextDocument + +The text document to read or update. + +```yaml +Type: PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Wait + +Waits for the VS Code command response before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument + +This command returns objects described by the section heading. + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Get-VSCodeTextEditor.md b/HostInjection/Help/Get-VSCodeTextEditor.md new file mode 100644 index 0000000..94e62e7 --- /dev/null +++ b/HostInjection/Help/Get-VSCodeTextEditor.md @@ -0,0 +1,108 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Get-VSCodeTextEditor +--- + +# Get-VSCodeTextEditor + +## SYNOPSIS + +Gets the active Visual Studio Code text editor. + +## SYNTAX + +### __AllParameterSets + +``` +Get-VSCodeTextEditor [-Wait] [-ResponseTimeout ] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Returns the active Visual Studio Code text editor object for use with decoration and editor automation commands. + +## EXAMPLES + +### Example 1 + +```powershell +$editor = Get-VSCodeTextEditor +``` +Gets the active text editor. + +## PARAMETERS + +### -ResponseTimeout + +The number of milliseconds to wait for a response from Visual Studio Code. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Wait + +Waits for the VS Code command response before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Measure-Block.md b/HostInjection/Help/Measure-Block.md new file mode 100644 index 0000000..e66f27a --- /dev/null +++ b/HostInjection/Help/Measure-Block.md @@ -0,0 +1,221 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Measure-Block +--- + +# Measure-Block + +## SYNOPSIS + +Measures execution timing for an instrumented script block. + +## SYNTAX + +### file + +``` +Measure-Block -StartOffset -EndOffset [-ScriptBlock ] [-FileName ] + [] +``` + +### module + +``` +Measure-Block -ModuleName -CommandName -PipelineMethod + [-ScriptBlock ] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Measures timing information for a section of PowerShell code. It can target a script block or a named command or pipeline segment in a script file. + +## EXAMPLES + +### Example 1 + +```powershell +Measure-Block -ScriptBlock { Get-ChildItem } +``` +Measures the supplied script block. + +## PARAMETERS + +### -CommandName + +The command name to measure within the script. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: module + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EndOffset + +The ending offset of the measured block. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: file + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -FileName + +The file name to open or use as context. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: file + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ModuleName + +The module name to measure within the script. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: module + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -PipelineMethod + +The pipeline method to measure. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: module + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ScriptBlock + +The script block to profile or measure. + +```yaml +Type: System.Management.Automation.ScriptBlock +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -StartOffset + +The starting offset of the measured block. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: file + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Measure-Script.md b/HostInjection/Help/Measure-Script.md new file mode 100644 index 0000000..a4a5801 --- /dev/null +++ b/HostInjection/Help/Measure-Script.md @@ -0,0 +1,114 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Measure-Script +--- + +# Measure-Script + +## SYNOPSIS + +Measures execution timing for a script file or script block. + +## SYNTAX + +### ScriptBlock + +``` +Measure-Script [-ScriptBlock] [] +``` + +### FilePath + +``` +Measure-Script [-FilePath] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Runs a PowerShell script file or script block under the PowerShell Pro Tools profiler and returns timing information for the profiled script. + +## EXAMPLES + +### Example 1 + +```powershell +Measure-Script -FilePath .\Build.ps1 +``` +Profiles a PowerShell script file. + +## PARAMETERS + +### -FilePath + +The path to the PowerShell script file. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: FilePath + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ScriptBlock + +The script block to profile or measure. + +```yaml +Type: System.Management.Automation.ScriptBlock +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: ScriptBlock + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/New-VSCodeDecorationAttachment.md b/HostInjection/Help/New-VSCodeDecorationAttachment.md new file mode 100644 index 0000000..c1b727b --- /dev/null +++ b/HostInjection/Help/New-VSCodeDecorationAttachment.md @@ -0,0 +1,300 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: New-VSCodeDecorationAttachment +--- + +# New-VSCodeDecorationAttachment + +## SYNOPSIS + +Creates attachment styling for a Visual Studio Code decoration. + +## SYNTAX + +### __AllParameterSets + +``` +New-VSCodeDecorationAttachment [-BackgroundColor ] [-Border ] + [-BorderColor ] [-Color ] [-ContentText ] [-FontStyle ] + [-FontWeight ] [-Height ] [-Margin ] [-TextDecoration ] + [-Width ] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Creates before or after attachment styling that can be assigned to a Visual Studio Code text editor decoration. + +## EXAMPLES + +### Example 1 + +```powershell +$after = New-VSCodeDecorationAttachment -ContentText ' <- review' -Color '#888888' +``` +Creates attachment styling for text displayed after a decorated range. + +## PARAMETERS + +### -BackgroundColor + +The CSS background color to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Border + +The CSS border value to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -BorderColor + +The CSS border color to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Color + +The CSS foreground color to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ContentText + +The text displayed by a decoration attachment. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -FontStyle + +The CSS font style to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -FontWeight + +The CSS font weight to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Height + +The CSS height for the decoration attachment. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Margin + +The CSS margin for the decoration attachment. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -TextDecoration + +The CSS text-decoration value to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Width + +The CSS width for the decoration attachment. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/New-VSCodePosition.md b/HostInjection/Help/New-VSCodePosition.md new file mode 100644 index 0000000..9328c27 --- /dev/null +++ b/HostInjection/Help/New-VSCodePosition.md @@ -0,0 +1,151 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: New-VSCodePosition +--- + +# New-VSCodePosition + +## SYNOPSIS + +Creates a Visual Studio Code position. + +## SYNTAX + +### __AllParameterSets + +``` +New-VSCodePosition -Line -Character [-Wait] [-ResponseTimeout ] + [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Creates a Visual Studio Code position object from zero-based line and character values. + +## EXAMPLES + +### Example 1 + +```powershell +New-VSCodePosition -Line 10 -Character 4 +``` +Creates a position at line 10, character 4. + +## PARAMETERS + +### -Character + +The zero-based character offset within the line. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Line + +The zero-based line number. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ResponseTimeout + +The number of milliseconds to wait for a response from Visual Studio Code. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Wait + +Waits for the VS Code command response before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/New-VSCodeRange.md b/HostInjection/Help/New-VSCodeRange.md new file mode 100644 index 0000000..f47b20a --- /dev/null +++ b/HostInjection/Help/New-VSCodeRange.md @@ -0,0 +1,193 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: New-VSCodeRange +--- + +# New-VSCodeRange + +## SYNOPSIS + +Creates a Visual Studio Code range. + +## SYNTAX + +### __AllParameterSets + +``` +New-VSCodeRange -StartLine -EndLine -StartCharacter -EndCharacter [-Wait] + [-ResponseTimeout ] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Creates a Visual Studio Code range object from zero-based start and end line and character values. + +## EXAMPLES + +### Example 1 + +```powershell +New-VSCodeRange -StartLine 0 -StartCharacter 0 -EndLine 0 -EndCharacter 10 +``` +Creates a range covering the first ten characters in the document. + +## PARAMETERS + +### -EndCharacter + +The zero-based ending character offset. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EndLine + +The zero-based ending line number. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ResponseTimeout + +The number of milliseconds to wait for a response from Visual Studio Code. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -StartCharacter + +The zero-based starting character offset. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -StartLine + +The zero-based starting line number. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Wait + +Waits for the VS Code command response before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/New-VSCodeTreeItem.md b/HostInjection/Help/New-VSCodeTreeItem.md new file mode 100644 index 0000000..99c0cba --- /dev/null +++ b/HostInjection/Help/New-VSCodeTreeItem.md @@ -0,0 +1,193 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: New-VSCodeTreeItem +--- + +# New-VSCodeTreeItem + +## SYNOPSIS + +Creates an item for a Visual Studio Code tree view. + +## SYNTAX + +### __AllParameterSets + +``` +New-VSCodeTreeItem -Label [-Description ] [-Tooltip ] [-Icon ] + [-HasChildren] [-DisableInvoke] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Creates a tree item object for a Visual Studio Code tree view registered with Register-VSCodeTreeView. + +## EXAMPLES + +### Example 1 + +```powershell +New-VSCodeTreeItem -Label 'Build' -Description 'Run build task' -Tooltip 'Start the build' +``` +Creates a tree item for a custom view. + +## PARAMETERS + +### -Description + +Additional descriptive text for the item or tree view. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DisableInvoke + +Prevents the tree item from invoking an action when selected. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -HasChildren + +Indicates that the tree item can load child items. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Icon + +The icon associated with the tree item or tree view. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Label + +The display label. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Tooltip + +Tooltip text shown for the item. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Open-VSCodeTextDocument.md b/HostInjection/Help/Open-VSCodeTextDocument.md new file mode 100644 index 0000000..5791809 --- /dev/null +++ b/HostInjection/Help/Open-VSCodeTextDocument.md @@ -0,0 +1,129 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Open-VSCodeTextDocument +--- + +# Open-VSCodeTextDocument + +## SYNOPSIS + +Opens a text document in Visual Studio Code. + +## SYNTAX + +### __AllParameterSets + +``` +Open-VSCodeTextDocument -FileName [-Wait] [-ResponseTimeout ] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Opens a file in Visual Studio Code and returns the corresponding text document object. + +## EXAMPLES + +### Example 1 + +```powershell +Open-VSCodeTextDocument -FileName .\README.md +``` +Opens README.md in Visual Studio Code. + +## PARAMETERS + +### -FileName + +The file name to open or use as context. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ResponseTimeout + +The number of milliseconds to wait for a response from Visual Studio Code. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Wait + +Waits for the VS Code command response before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Out-PoshToolsVariable.md b/HostInjection/Help/Out-PoshToolsVariable.md new file mode 100644 index 0000000..c232875 --- /dev/null +++ b/HostInjection/Help/Out-PoshToolsVariable.md @@ -0,0 +1,134 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Out-PoshToolsVariable +--- + +# Out-PoshToolsVariable + +## SYNOPSIS + +Stores pipeline input in the PowerShell Pro Tools host. + +## SYNTAX + +### __AllParameterSets + +``` +Out-PoshToolsVariable [-InputObject ] [-PassThru] [-ExcludeAutomatic ] + [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Stores pipeline input in the PowerShell Pro Tools host so it can be inspected or retrieved later. Use PassThru to continue passing objects through the pipeline. + +## EXAMPLES + +### Example 1 + +```powershell +Get-Process | Out-PoshToolsVariable -PassThru +``` +Stores the processes in the host and continues passing them through the pipeline. + +## PARAMETERS + +### -ExcludeAutomatic + +Excludes automatic PowerShell variables from the stored value set. + +```yaml +Type: System.Boolean +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -InputObject + +The object to display, expand, or store. + +```yaml +Type: System.Management.Automation.PSVariable +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -PassThru + +Returns selected or original objects to the pipeline. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSVariable + +This command returns objects described by the section heading. + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Out-VSCodeGridView.md b/HostInjection/Help/Out-VSCodeGridView.md new file mode 100644 index 0000000..0285d79 --- /dev/null +++ b/HostInjection/Help/Out-VSCodeGridView.md @@ -0,0 +1,204 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Out-VSCodeGridView +--- + +# Out-VSCodeGridView + +## SYNOPSIS + +Shows objects in a Visual Studio Code grid view. + +## SYNTAX + +### PassThru (Default) + +``` +Out-VSCodeGridView [-InputObject ] [-Title ] [-PassThru] [-Wait] + [-ResponseTimeout ] [] +``` + +### OutputMode + +``` +Out-VSCodeGridView [-InputObject ] [-Title ] [-OutputMode ] + [-Wait] [-ResponseTimeout ] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Displays pipeline objects in a Visual Studio Code grid view. It can be used for display only or to return selected rows. + +## EXAMPLES + +### Example 1 + +```powershell +Get-Process | Out-VSCodeGridView -Title 'Processes' -PassThru +``` +Displays processes in a grid view and returns selected rows. + +## PARAMETERS + +### -InputObject + +The object to display, expand, or store. + +```yaml +Type: System.Management.Automation.PSObject +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -OutputMode + +Controls how grid view selections are returned. + +```yaml +Type: PowerShellToolsPro.Cmdlets.VSCode.OutputModeOption +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: OutputMode + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -PassThru + +Returns selected or original objects to the pipeline. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: PassThru + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ResponseTimeout + +The number of milliseconds to wait for a response from Visual Studio Code. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Title + +The grid view title. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Wait + +Waits for the VS Code command response before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +This command returns objects described by the section heading. + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Register-VSCodeTreeView.md b/HostInjection/Help/Register-VSCodeTreeView.md new file mode 100644 index 0000000..d1183e1 --- /dev/null +++ b/HostInjection/Help/Register-VSCodeTreeView.md @@ -0,0 +1,193 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Register-VSCodeTreeView +--- + +# Register-VSCodeTreeView + +## SYNOPSIS + +Registers a Visual Studio Code tree view. + +## SYNTAX + +### __AllParameterSets + +``` +Register-VSCodeTreeView -Label [-Description ] [-Tooltip ] [-Icon ] + [-LoadChildren ] [-InvokeChild ] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Registers a custom Visual Studio Code tree view backed by PowerShell script blocks for loading children and invoking items. + +## EXAMPLES + +### Example 1 + +```powershell +Register-VSCodeTreeView -Label 'Scripts' -LoadChildren { Get-ChildItem . -Filter *.ps1 | ForEach-Object { New-VSCodeTreeItem -Label $_.Name } } +``` +Registers a tree view whose children are generated by a script block. + +## PARAMETERS + +### -Description + +Additional descriptive text for the item or tree view. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Icon + +The icon associated with the tree item or tree view. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -InvokeChild + +The script block invoked when a child item is selected. + +```yaml +Type: System.Management.Automation.ScriptBlock +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Label + +The display label. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -LoadChildren + +The script block used to load child tree items. + +```yaml +Type: System.Management.Automation.ScriptBlock +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Tooltip + +Tooltip text shown for the item. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Remove-VSCodeTextDocumentText.md b/HostInjection/Help/Remove-VSCodeTextDocumentText.md new file mode 100644 index 0000000..d95c8ca --- /dev/null +++ b/HostInjection/Help/Remove-VSCodeTextDocumentText.md @@ -0,0 +1,157 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Remove-VSCodeTextDocumentText +--- + +# Remove-VSCodeTextDocumentText + +## SYNOPSIS + +Removes text from a Visual Studio Code text document. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-VSCodeTextDocumentText -TextDocument -Range [-Wait] + [-ResponseTimeout ] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Removes text from a Visual Studio Code text document over the specified range. + +## EXAMPLES + +### Example 1 + +```powershell +$document = Get-VSCodeTextDocument +$range = New-VSCodeRange -StartLine 0 -StartCharacter 0 -EndLine 0 -EndCharacter 5 +Remove-VSCodeTextDocumentText -TextDocument $document -Range $range +``` +Removes text from the supplied document range. + +## PARAMETERS + +### -Range + +The range of text to read, remove, or decorate. + +```yaml +Type: PowerShellToolsPro.Cmdlets.VSCode.VsCodeRange +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ResponseTimeout + +The number of milliseconds to wait for a response from Visual Studio Code. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -TextDocument + +The text document to read or update. + +```yaml +Type: PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Wait + +Waits for the VS Code command response before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument + +This command returns objects described by the section heading. + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Remove-VSCodeTextEditor.md b/HostInjection/Help/Remove-VSCodeTextEditor.md new file mode 100644 index 0000000..3d702d4 --- /dev/null +++ b/HostInjection/Help/Remove-VSCodeTextEditor.md @@ -0,0 +1,135 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Remove-VSCodeTextEditor +--- + +# Remove-VSCodeTextEditor + +## SYNOPSIS + +Removes a Visual Studio Code text editor reference. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-VSCodeTextEditor -TextEditor [-Wait] [-ResponseTimeout ] + [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Removes or disposes a text editor reference managed by the PowerShell Pro Tools VS Code host. + +## EXAMPLES + +### Example 1 + +```powershell +$editor = Get-VSCodeTextEditor +Remove-VSCodeTextEditor -TextEditor $editor +``` +Removes the active text editor reference. + +## PARAMETERS + +### -ResponseTimeout + +The number of milliseconds to wait for a response from Visual Studio Code. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -TextEditor + +The text editor to decorate or remove. + +```yaml +Type: PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextEditor +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Wait + +Waits for the VS Code command response before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextEditor + +This command returns objects described by the section heading. + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Send-VSCodeTerminalText.md b/HostInjection/Help/Send-VSCodeTerminalText.md new file mode 100644 index 0000000..b7711f6 --- /dev/null +++ b/HostInjection/Help/Send-VSCodeTerminalText.md @@ -0,0 +1,208 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Send-VSCodeTerminalText +--- + +# Send-VSCodeTerminalText + +## SYNOPSIS + +Sends text to a Visual Studio Code terminal. + +## SYNTAX + +### name + +``` +Send-VSCodeTerminalText -Name -Text [-AddNewLine] [-Wait] [-ResponseTimeout ] + [] +``` + +### terminal + +``` +Send-VSCodeTerminalText -Terminal -Text [-AddNewLine] [-Wait] + [-ResponseTimeout ] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Sends text to a Visual Studio Code terminal. You can target a terminal by object or name and control whether a newline is appended. + +## EXAMPLES + +### Example 1 + +```powershell +Send-VSCodeTerminalText -Name 'PowerShell' -Text 'Get-Process' -AddNewLine +``` +Sends a command to the named terminal and appends a newline. + +## PARAMETERS + +### -AddNewLine + +Appends a newline after the text is sent to the terminal. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Name + +The terminal name. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: name + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ResponseTimeout + +The number of milliseconds to wait for a response from Visual Studio Code. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Terminal + +The terminal object to receive text. + +```yaml +Type: PowerShellToolsPro.Cmdlets.VSCode.VsCodeTerminal +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: terminal + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Text + +The text to insert or send. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Wait + +Waits for the VS Code command response before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +This command returns objects described by the section heading. + +### PowerShellToolsPro.Cmdlets.VSCode.VsCodeTerminal + +This command returns objects described by the section heading. + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Set-VSCodeStatusBarMessage.md b/HostInjection/Help/Set-VSCodeStatusBarMessage.md new file mode 100644 index 0000000..9122f93 --- /dev/null +++ b/HostInjection/Help/Set-VSCodeStatusBarMessage.md @@ -0,0 +1,151 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Set-VSCodeStatusBarMessage +--- + +# Set-VSCodeStatusBarMessage + +## SYNOPSIS + +Sets the Visual Studio Code status bar message. + +## SYNTAX + +### __AllParameterSets + +``` +Set-VSCodeStatusBarMessage -Message [-Timeout ] [-Wait] [-ResponseTimeout ] + [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Displays a message in the Visual Studio Code status bar. Use Timeout to automatically hide the message after a period of time. + +## EXAMPLES + +### Example 1 + +```powershell +Set-VSCodeStatusBarMessage -Message 'Build complete' -Timeout 5000 +``` +Shows a status bar message for five seconds. + +## PARAMETERS + +### -Message + +The message text to display. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ResponseTimeout + +The number of milliseconds to wait for a response from Visual Studio Code. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Timeout + +The number of milliseconds to show the status bar message. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Wait + +Waits for the VS Code command response before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Set-VSCodeTextEditorDecoration.md b/HostInjection/Help/Set-VSCodeTextEditorDecoration.md new file mode 100644 index 0000000..58263a8 --- /dev/null +++ b/HostInjection/Help/Set-VSCodeTextEditorDecoration.md @@ -0,0 +1,625 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Set-VSCodeTextEditorDecoration +--- + +# Set-VSCodeTextEditorDecoration + +## SYNOPSIS + +Sets a Visual Studio Code text editor decoration. + +## SYNTAX + +### __AllParameterSets + +``` +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 ] + [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Creates or updates text editor decoration styling in Visual Studio Code and applies it to one or more ranges in a text editor. + +## EXAMPLES + +### Example 1 + +```powershell +$editor = Get-VSCodeTextEditor +$range = New-VSCodeRange -StartLine 0 -StartCharacter 0 -EndLine 0 -EndCharacter 5 +Set-VSCodeTextEditorDecoration -TextEditor $editor -Key 'highlight' -Range $range -BackgroundColor '#ffff0033' +``` +Highlights a range in the active editor. + +## PARAMETERS + +### -After + +Attachment styling to display after the decorated text. + +```yaml +Type: PowerShellToolsPro.Cmdlets.VSCode.DecorationAttachment +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -BackgroundColor + +The CSS background color to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Before + +Attachment styling to display before the decorated text. + +```yaml +Type: PowerShellToolsPro.Cmdlets.VSCode.DecorationAttachment +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Border + +The CSS border value to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -BorderColor + +The CSS border color to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -BorderRadius + +The CSS border radius to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -BorderStyle + +The CSS border style to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -BorderWidth + +The CSS border width to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Color + +The CSS foreground color to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Cursor + +The CSS cursor value to use over the decorated text. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -FontStyle + +The CSS font style to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -FontWeight + +The CSS font weight to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -IsWholeLine + +Applies the decoration to the whole line. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Key + +The unique key used to identify a decoration. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -LetterSpacing + +The CSS letter spacing to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Opacity + +The CSS opacity value to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Outline + +The CSS outline value to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -OutlineColor + +The CSS outline color to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -OutlineStyle + +The CSS outline style to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -OutlineWidth + +The CSS outline width to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Range + +The range of text to read, remove, or decorate. + +```yaml +Type: PowerShellToolsPro.Cmdlets.VSCode.VsCodeRange +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -RangeBehavior + +Controls how the decoration range behaves as text changes. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ResponseTimeout + +The number of milliseconds to wait for a response from Visual Studio Code. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -TextDecoration + +The CSS text-decoration value to apply. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -TextEditor + +The text editor to decorate or remove. + +```yaml +Type: PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextEditor +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Wait + +Waits for the VS Code command response before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextEditor + +This command returns objects described by the section heading. + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Show-VSCodeInputBox.md b/HostInjection/Help/Show-VSCodeInputBox.md new file mode 100644 index 0000000..aa841d2 --- /dev/null +++ b/HostInjection/Help/Show-VSCodeInputBox.md @@ -0,0 +1,257 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Show-VSCodeInputBox +--- + +# Show-VSCodeInputBox + +## SYNOPSIS + +Shows an input box in Visual Studio Code. + +## SYNTAX + +### __AllParameterSets + +``` +Show-VSCodeInputBox [-IgnoreFocusOut] [-Password] [-PlaceHolder ] [-Prompt ] + [-Value ] [-StartValueSelection ] [-EndValueSelection ] [-Wait] + [-ResponseTimeout ] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Shows a Visual Studio Code input box and returns the value entered by the user. + +## EXAMPLES + +### Example 1 + +```powershell +Show-VSCodeInputBox -Prompt 'Enter a server name' -PlaceHolder 'localhost' +``` +Prompts the user for a server name. + +## PARAMETERS + +### -EndValueSelection + +The ending character index for the selected input text. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -IgnoreFocusOut + +Keeps the picker or input box open when focus moves away. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Password + +Masks the input box value. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -PlaceHolder + +Placeholder text shown before input or selection. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Prompt + +Prompt text shown in the input box. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ResponseTimeout + +The number of milliseconds to wait for a response from Visual Studio Code. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -StartValueSelection + +The starting character index for the selected input text. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Value + +The default value shown in the input box. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Wait + +Waits for the VS Code command response before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Show-VSCodeMessage.md b/HostInjection/Help/Show-VSCodeMessage.md new file mode 100644 index 0000000..27b6300 --- /dev/null +++ b/HostInjection/Help/Show-VSCodeMessage.md @@ -0,0 +1,193 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Show-VSCodeMessage +--- + +# Show-VSCodeMessage + +## SYNOPSIS + +Shows a message in Visual Studio Code. + +## SYNTAX + +### __AllParameterSets + +``` +Show-VSCodeMessage -Message [-Items ] [-Modal] [-Type ] [-Wait] + [-ResponseTimeout ] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Shows an information, warning, or error message in Visual Studio Code. Optional items are displayed as action buttons. + +## EXAMPLES + +### Example 1 + +```powershell +Show-VSCodeMessage -Message 'Build complete' -Type Information +``` +Shows an informational message in Visual Studio Code. + +## PARAMETERS + +### -Items + +The items to show as actions or selections. + +```yaml +Type: System.String[] +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Message + +The message text to display. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Modal + +Shows the message as a modal dialog. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ResponseTimeout + +The number of milliseconds to wait for a response from Visual Studio Code. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Type + +The message type. Use Information, Warning, or Error. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Wait + +Waits for the VS Code command response before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Show-VSCodeQuickPick.md b/HostInjection/Help/Show-VSCodeQuickPick.md new file mode 100644 index 0000000..c88b331 --- /dev/null +++ b/HostInjection/Help/Show-VSCodeQuickPick.md @@ -0,0 +1,193 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Show-VSCodeQuickPick +--- + +# Show-VSCodeQuickPick + +## SYNOPSIS + +Shows a quick pick list in Visual Studio Code. + +## SYNTAX + +### __AllParameterSets + +``` +Show-VSCodeQuickPick -Items [-PlaceHolder ] [-CanPickMany] [-IgnoreFocusOut] + [-Wait] [-ResponseTimeout ] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Shows a Visual Studio Code quick pick list and returns the selected item or items. + +## EXAMPLES + +### Example 1 + +```powershell +Show-VSCodeQuickPick -Items 'Debug','Release' -PlaceHolder 'Select configuration' +``` +Prompts the user to select a build configuration. + +## PARAMETERS + +### -CanPickMany + +Allows the user to select more than one item. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -IgnoreFocusOut + +Keeps the picker or input box open when focus moves away. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Items + +The items to show as actions or selections. + +```yaml +Type: System.String[] +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -PlaceHolder + +Placeholder text shown before input or selection. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ResponseTimeout + +The number of milliseconds to wait for a response from Visual Studio Code. + +```yaml +Type: System.Int32 +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Wait + +Waits for the VS Code command response before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/Help/Start-PoshToolsServer.md b/HostInjection/Help/Start-PoshToolsServer.md new file mode 100644 index 0000000..32e723c --- /dev/null +++ b/HostInjection/Help/Start-PoshToolsServer.md @@ -0,0 +1,87 @@ +--- +document type: cmdlet +external help file: PowerShellProTools.VSCode.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools.VSCode +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Start-PoshToolsServer +--- + +# Start-PoshToolsServer + +## SYNOPSIS + +Starts the PowerShell Pro Tools VS Code host server. + +## SYNTAX + +### __AllParameterSets + +``` +Start-PoshToolsServer [[-PipeName] ] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Starts the named-pipe server used by the PowerShell Pro Tools VS Code extension to communicate with PowerShell commands. + +## EXAMPLES + +### Example 1 + +```powershell +Start-PoshToolsServer -PipeName 'PowerShellProTools' +``` +Starts the VS Code host server using the specified named pipe. + +## PARAMETERS + +### -PipeName + +The named pipe used by the host server. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/HostInjection/PowerShellProTools.Common.csproj b/HostInjection/PowerShellProTools.Common.csproj index 0723fb7..4bb70c9 100644 --- a/HostInjection/PowerShellProTools.Common.csproj +++ b/HostInjection/PowerShellProTools.Common.csproj @@ -21,6 +21,9 @@ Always + + PreserveNewest + diff --git a/HostInjection/en-US/PowerShellProTools.VSCode.dll-Help.xml b/HostInjection/en-US/PowerShellProTools.VSCode.dll-Help.xml new file mode 100644 index 0000000..8b42a8a --- /dev/null +++ b/HostInjection/en-US/PowerShellProTools.VSCode.dll-Help.xml @@ -0,0 +1,3782 @@ + + + + + Add-VSCodeTextDocumentText + + Adds text to a Visual Studio Code text document. + + Add + VSCodeTextDocumentText + + + Adds text to a Visual Studio Code text document at the specified position. Use this command when automating editor changes from PowerShell running inside the PowerShell Pro Tools host. + + + + Add-VSCodeTextDocumentText + + Position + + The position where text is inserted. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodePosition + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Text + + The text to insert or send. + + System.String + + + TextDocument + + The text document to read or update. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + Position + + The position where text is inserted. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodePosition + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Text + + The text to insert or send. + + System.String + + + TextDocument + + The text document to read or update. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument + + + This command returns objects described by the section heading. + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +$document = Get-VSCodeTextDocument +$position = New-VSCodePosition -Line 0 -Character 0 +Add-VSCodeTextDocumentText -TextDocument $document -Position $position -Text '# Header' +``` +Adds text to the beginning of the active document. + + + + + + + + Online Version + + + + + + + Clear-VSCodeDecoration + + Clears a text editor decoration in Visual Studio Code. + + Clear + VSCodeDecoration + + + Clears a decoration that was previously created with Set-VSCodeTextEditorDecoration. The key identifies which decoration registration to remove. + + + + Clear-VSCodeDecoration + + Key + + The unique key used to identify a decoration. + + System.String + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + Key + + The unique key used to identify a decoration. + + System.String + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +Clear-VSCodeDecoration -Key 'search-highlight' +``` +Clears the decoration identified by the key. + + + + + + + + Online Version + + + + + + + Get-CompletionItem + + Returns completion items for PowerShell code. + + Get + CompletionItem + + + Returns completion items for a command, variable, type, or file path based on the supplied PowerShell context. The command is used by RapidSense and editor completion features. + + + + Get-CompletionItem + + IgnoredAssemblies + + Assembly names to exclude from completion results. + + System.String + + + IgnoredTypes + + Type names to exclude from completion results. + + System.String + + + Types + + Type names to include in completion context. + + System.Management.Automation.SwitchParameter + + + + Get-CompletionItem + + Command + + The command text to complete. + + System.Management.Automation.CommandInfo + + + IgnoredCommands + + Command names to exclude from completion results. + + System.String + + + IgnoredModules + + Module names to exclude from completion results. + + System.String + + + + Get-CompletionItem + + IgnoredVariables + + Variable names to exclude from completion results. + + System.String + + + Variable + + The variable name to complete. + + PowerShellTools.Common.ServiceManagement.DebuggingContract.Variable + + + + Get-CompletionItem + + File + + The file path used as completion context. + + System.IO.FileInfo + + + + Get-CompletionItem + + Directory + + The working directory used when resolving completions. + + System.IO.DirectoryInfo + + + + + + Command + + The command text to complete. + + System.Management.Automation.CommandInfo + + + Directory + + The working directory used when resolving completions. + + System.IO.DirectoryInfo + + + File + + The file path used as completion context. + + System.IO.FileInfo + + + IgnoredAssemblies + + Assembly names to exclude from completion results. + + System.String + + + IgnoredCommands + + Command names to exclude from completion results. + + System.String + + + IgnoredModules + + Module names to exclude from completion results. + + System.String + + + IgnoredTypes + + Type names to exclude from completion results. + + System.String + + + IgnoredVariables + + Variable names to exclude from completion results. + + System.String + + + Types + + Type names to include in completion context. + + System.Management.Automation.SwitchParameter + + + Variable + + The variable name to complete. + + PowerShellTools.Common.ServiceManagement.DebuggingContract.Variable + + + + + + System.Management.Automation.CommandInfo + + + This command returns objects described by the section heading. + + + + + PowerShellTools.Common.ServiceManagement.DebuggingContract.Variable + + + This command returns objects described by the section heading. + + + + + System.IO.FileInfo + + + This command returns objects described by the section heading. + + + + + System.IO.DirectoryInfo + + + This command returns objects described by the section heading. + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +Get-CompletionItem -Command 'Get-Pro' +``` +Returns completion items for a partially typed command. + + + + + + + + Online Version + + + + + + + Get-PoshToolsVariable + + Gets a variable stored by the PowerShell Pro Tools host. + + Get + PoshToolsVariable + + + Retrieves a variable value stored by the PowerShell Pro Tools host. Use ValueOnly to return only the value rather than the host variable wrapper. + + + + Get-PoshToolsVariable + + Path + + The path to the input file or host variable. + + System.String + + + ValueOnly + + Returns only the stored variable value. + + System.Management.Automation.SwitchParameter + + + + + + Path + + The path to the input file or host variable. + + System.String + + + ValueOnly + + Returns only the stored variable value. + + System.Management.Automation.SwitchParameter + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +Get-PoshToolsVariable -Path 'Session.Result' -ValueOnly +``` +Returns only the value stored at the specified host variable path. + + + + + + + + Online Version + + + + + + + Get-VSCodeTerminal + + Gets the active Visual Studio Code terminal. + + Get + VSCodeTerminal + + + Returns the active Visual Studio Code terminal object so it can be used with commands such as Send-VSCodeTerminalText. + + + + Get-VSCodeTerminal + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +$terminal = Get-VSCodeTerminal +``` +Gets the active terminal. + + + + + + + + Online Version + + + + + + + Get-VSCodeTextDocument + + Gets the active Visual Studio Code text document. + + Get + VSCodeTextDocument + + + Returns the active Visual Studio Code text document object for use with commands that read or update editor text. + + + + Get-VSCodeTextDocument + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +$document = Get-VSCodeTextDocument +``` +Gets the active text document. + + + + + + + + Online Version + + + + + + + Get-VSCodeTextDocumentText + + Gets text from a Visual Studio Code text document. + + Get + VSCodeTextDocumentText + + + Gets text from a Visual Studio Code text document. Provide a range to retrieve only part of the document. + + + + Get-VSCodeTextDocumentText + + Range + + The range of text to read, remove, or decorate. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeRange + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + TextDocument + + The text document to read or update. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + Range + + The range of text to read, remove, or decorate. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeRange + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + TextDocument + + The text document to read or update. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument + + + This command returns objects described by the section heading. + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +$document = Get-VSCodeTextDocument +Get-VSCodeTextDocumentText -TextDocument $document +``` +Returns all text from the active document. + + + + + + + + Online Version + + + + + + + Get-VSCodeTextEditor + + Gets the active Visual Studio Code text editor. + + Get + VSCodeTextEditor + + + Returns the active Visual Studio Code text editor object for use with decoration and editor automation commands. + + + + Get-VSCodeTextEditor + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +$editor = Get-VSCodeTextEditor +``` +Gets the active text editor. + + + + + + + + Online Version + + + + + + + Measure-Block + + Measures execution timing for an instrumented script block. + + Measure + Block + + + Measures timing information for a section of PowerShell code. It can target a script block or a named command or pipeline segment in a script file. + + + + Measure-Block + + EndOffset + + The ending offset of the measured block. + + System.Int32 + + + FileName + + The file name to open or use as context. + + System.String + + + ScriptBlock + + The script block to profile or measure. + + System.Management.Automation.ScriptBlock + + + StartOffset + + The starting offset of the measured block. + + System.Int32 + + + + Measure-Block + + CommandName + + The command name to measure within the script. + + System.String + + + ModuleName + + The module name to measure within the script. + + System.String + + + PipelineMethod + + The pipeline method to measure. + + System.String + + + ScriptBlock + + The script block to profile or measure. + + System.Management.Automation.ScriptBlock + + + + + + CommandName + + The command name to measure within the script. + + System.String + + + EndOffset + + The ending offset of the measured block. + + System.Int32 + + + FileName + + The file name to open or use as context. + + System.String + + + ModuleName + + The module name to measure within the script. + + System.String + + + PipelineMethod + + The pipeline method to measure. + + System.String + + + ScriptBlock + + The script block to profile or measure. + + System.Management.Automation.ScriptBlock + + + StartOffset + + The starting offset of the measured block. + + System.Int32 + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +Measure-Block -ScriptBlock { Get-ChildItem } +``` +Measures the supplied script block. + + + + + + + + Online Version + + + + + + + Measure-Script + + Measures execution timing for a script file or script block. + + Measure + Script + + + Runs a PowerShell script file or script block under the PowerShell Pro Tools profiler and returns timing information for the profiled script. + + + + Measure-Script + + ScriptBlock + + The script block to profile or measure. + + System.Management.Automation.ScriptBlock + + + + Measure-Script + + FilePath + + The path to the PowerShell script file. + + System.String + + + + + + FilePath + + The path to the PowerShell script file. + + System.String + + + ScriptBlock + + The script block to profile or measure. + + System.Management.Automation.ScriptBlock + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +Measure-Script -FilePath .\Build.ps1 +``` +Profiles a PowerShell script file. + + + + + + + + Online Version + + + + + + + New-VSCodeDecorationAttachment + + Creates attachment styling for a Visual Studio Code decoration. + + New + VSCodeDecorationAttachment + + + Creates before or after attachment styling that can be assigned to a Visual Studio Code text editor decoration. + + + + New-VSCodeDecorationAttachment + + BackgroundColor + + The CSS background color to apply. + + System.String + + + Border + + The CSS border value to apply. + + System.String + + + BorderColor + + The CSS border color to apply. + + System.String + + + Color + + The CSS foreground color to apply. + + System.String + + + ContentText + + The text displayed by a decoration attachment. + + System.String + + + FontStyle + + The CSS font style to apply. + + System.String + + + FontWeight + + The CSS font weight to apply. + + System.String + + + Height + + The CSS height for the decoration attachment. + + System.String + + + Margin + + The CSS margin for the decoration attachment. + + System.String + + + TextDecoration + + The CSS text-decoration value to apply. + + System.String + + + Width + + The CSS width for the decoration attachment. + + System.String + + + + + + BackgroundColor + + The CSS background color to apply. + + System.String + + + Border + + The CSS border value to apply. + + System.String + + + BorderColor + + The CSS border color to apply. + + System.String + + + Color + + The CSS foreground color to apply. + + System.String + + + ContentText + + The text displayed by a decoration attachment. + + System.String + + + FontStyle + + The CSS font style to apply. + + System.String + + + FontWeight + + The CSS font weight to apply. + + System.String + + + Height + + The CSS height for the decoration attachment. + + System.String + + + Margin + + The CSS margin for the decoration attachment. + + System.String + + + TextDecoration + + The CSS text-decoration value to apply. + + System.String + + + Width + + The CSS width for the decoration attachment. + + System.String + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +$after = New-VSCodeDecorationAttachment -ContentText ' <- review' -Color '#888888' +``` +Creates attachment styling for text displayed after a decorated range. + + + + + + + + Online Version + + + + + + + New-VSCodePosition + + Creates a Visual Studio Code position. + + New + VSCodePosition + + + Creates a Visual Studio Code position object from zero-based line and character values. + + + + New-VSCodePosition + + Character + + The zero-based character offset within the line. + + System.Int32 + + + Line + + The zero-based line number. + + System.Int32 + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + Character + + The zero-based character offset within the line. + + System.Int32 + + + Line + + The zero-based line number. + + System.Int32 + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +New-VSCodePosition -Line 10 -Character 4 +``` +Creates a position at line 10, character 4. + + + + + + + + Online Version + + + + + + + New-VSCodeRange + + Creates a Visual Studio Code range. + + New + VSCodeRange + + + Creates a Visual Studio Code range object from zero-based start and end line and character values. + + + + New-VSCodeRange + + EndCharacter + + The zero-based ending character offset. + + System.Int32 + + + EndLine + + The zero-based ending line number. + + System.Int32 + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + StartCharacter + + The zero-based starting character offset. + + System.Int32 + + + StartLine + + The zero-based starting line number. + + System.Int32 + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + EndCharacter + + The zero-based ending character offset. + + System.Int32 + + + EndLine + + The zero-based ending line number. + + System.Int32 + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + StartCharacter + + The zero-based starting character offset. + + System.Int32 + + + StartLine + + The zero-based starting line number. + + System.Int32 + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +New-VSCodeRange -StartLine 0 -StartCharacter 0 -EndLine 0 -EndCharacter 10 +``` +Creates a range covering the first ten characters in the document. + + + + + + + + Online Version + + + + + + + New-VSCodeTreeItem + + Creates an item for a Visual Studio Code tree view. + + New + VSCodeTreeItem + + + Creates a tree item object for a Visual Studio Code tree view registered with Register-VSCodeTreeView. + + + + New-VSCodeTreeItem + + Description + + Additional descriptive text for the item or tree view. + + System.String + + + DisableInvoke + + Prevents the tree item from invoking an action when selected. + + System.Management.Automation.SwitchParameter + + + HasChildren + + Indicates that the tree item can load child items. + + System.Management.Automation.SwitchParameter + + + Icon + + The icon associated with the tree item or tree view. + + System.String + + + Label + + The display label. + + System.String + + + Tooltip + + Tooltip text shown for the item. + + System.String + + + + + + Description + + Additional descriptive text for the item or tree view. + + System.String + + + DisableInvoke + + Prevents the tree item from invoking an action when selected. + + System.Management.Automation.SwitchParameter + + + HasChildren + + Indicates that the tree item can load child items. + + System.Management.Automation.SwitchParameter + + + Icon + + The icon associated with the tree item or tree view. + + System.String + + + Label + + The display label. + + System.String + + + Tooltip + + Tooltip text shown for the item. + + System.String + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +New-VSCodeTreeItem -Label 'Build' -Description 'Run build task' -Tooltip 'Start the build' +``` +Creates a tree item for a custom view. + + + + + + + + Online Version + + + + + + + Open-VSCodeTextDocument + + Opens a text document in Visual Studio Code. + + Open + VSCodeTextDocument + + + Opens a file in Visual Studio Code and returns the corresponding text document object. + + + + Open-VSCodeTextDocument + + FileName + + The file name to open or use as context. + + System.String + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + FileName + + The file name to open or use as context. + + System.String + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +Open-VSCodeTextDocument -FileName .\README.md +``` +Opens README.md in Visual Studio Code. + + + + + + + + Online Version + + + + + + + Out-PoshToolsVariable + + Stores pipeline input in the PowerShell Pro Tools host. + + Out + PoshToolsVariable + + + Stores pipeline input in the PowerShell Pro Tools host so it can be inspected or retrieved later. Use PassThru to continue passing objects through the pipeline. + + + + Out-PoshToolsVariable + + ExcludeAutomatic + + Excludes automatic PowerShell variables from the stored value set. + + System.Boolean + + + InputObject + + The object to display, expand, or store. + + System.Management.Automation.PSVariable + + + PassThru + + Returns selected or original objects to the pipeline. + + System.Management.Automation.SwitchParameter + + + + + + ExcludeAutomatic + + Excludes automatic PowerShell variables from the stored value set. + + System.Boolean + + + InputObject + + The object to display, expand, or store. + + System.Management.Automation.PSVariable + + + PassThru + + Returns selected or original objects to the pipeline. + + System.Management.Automation.SwitchParameter + + + + + + System.Management.Automation.PSVariable + + + This command returns objects described by the section heading. + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +Get-Process | Out-PoshToolsVariable -PassThru +``` +Stores the processes in the host and continues passing them through the pipeline. + + + + + + + + Online Version + + + + + + + Out-VSCodeGridView + + Shows objects in a Visual Studio Code grid view. + + Out + VSCodeGridView + + + Displays pipeline objects in a Visual Studio Code grid view. It can be used for display only or to return selected rows. + + + + Out-VSCodeGridView + + InputObject + + The object to display, expand, or store. + + System.Management.Automation.PSObject + + + PassThru + + Returns selected or original objects to the pipeline. + + System.Management.Automation.SwitchParameter + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Title + + The grid view title. + + System.String + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + Out-VSCodeGridView + + InputObject + + The object to display, expand, or store. + + System.Management.Automation.PSObject + + + OutputMode + + Controls how grid view selections are returned. + + PowerShellToolsPro.Cmdlets.VSCode.OutputModeOption + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Title + + The grid view title. + + System.String + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + InputObject + + The object to display, expand, or store. + + System.Management.Automation.PSObject + + + OutputMode + + Controls how grid view selections are returned. + + PowerShellToolsPro.Cmdlets.VSCode.OutputModeOption + + + PassThru + + Returns selected or original objects to the pipeline. + + System.Management.Automation.SwitchParameter + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Title + + The grid view title. + + System.String + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + System.Management.Automation.PSObject + + + This command returns objects described by the section heading. + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +Get-Process | Out-VSCodeGridView -Title 'Processes' -PassThru +``` +Displays processes in a grid view and returns selected rows. + + + + + + + + Online Version + + + + + + + Register-VSCodeTreeView + + Registers a Visual Studio Code tree view. + + Register + VSCodeTreeView + + + Registers a custom Visual Studio Code tree view backed by PowerShell script blocks for loading children and invoking items. + + + + Register-VSCodeTreeView + + Description + + Additional descriptive text for the item or tree view. + + System.String + + + Icon + + The icon associated with the tree item or tree view. + + System.String + + + InvokeChild + + The script block invoked when a child item is selected. + + System.Management.Automation.ScriptBlock + + + Label + + The display label. + + System.String + + + LoadChildren + + The script block used to load child tree items. + + System.Management.Automation.ScriptBlock + + + Tooltip + + Tooltip text shown for the item. + + System.String + + + + + + Description + + Additional descriptive text for the item or tree view. + + System.String + + + Icon + + The icon associated with the tree item or tree view. + + System.String + + + InvokeChild + + The script block invoked when a child item is selected. + + System.Management.Automation.ScriptBlock + + + Label + + The display label. + + System.String + + + LoadChildren + + The script block used to load child tree items. + + System.Management.Automation.ScriptBlock + + + Tooltip + + Tooltip text shown for the item. + + System.String + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +Register-VSCodeTreeView -Label 'Scripts' -LoadChildren { Get-ChildItem . -Filter *.ps1 | ForEach-Object { New-VSCodeTreeItem -Label $_.Name } } +``` +Registers a tree view whose children are generated by a script block. + + + + + + + + Online Version + + + + + + + Remove-VSCodeTextDocumentText + + Removes text from a Visual Studio Code text document. + + Remove + VSCodeTextDocumentText + + + Removes text from a Visual Studio Code text document over the specified range. + + + + Remove-VSCodeTextDocumentText + + Range + + The range of text to read, remove, or decorate. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeRange + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + TextDocument + + The text document to read or update. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + Range + + The range of text to read, remove, or decorate. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeRange + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + TextDocument + + The text document to read or update. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextDocument + + + This command returns objects described by the section heading. + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +$document = Get-VSCodeTextDocument +$range = New-VSCodeRange -StartLine 0 -StartCharacter 0 -EndLine 0 -EndCharacter 5 +Remove-VSCodeTextDocumentText -TextDocument $document -Range $range +``` +Removes text from the supplied document range. + + + + + + + + Online Version + + + + + + + Remove-VSCodeTextEditor + + Removes a Visual Studio Code text editor reference. + + Remove + VSCodeTextEditor + + + Removes or disposes a text editor reference managed by the PowerShell Pro Tools VS Code host. + + + + Remove-VSCodeTextEditor + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + TextEditor + + The text editor to decorate or remove. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextEditor + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + TextEditor + + The text editor to decorate or remove. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextEditor + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextEditor + + + This command returns objects described by the section heading. + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +$editor = Get-VSCodeTextEditor +Remove-VSCodeTextEditor -TextEditor $editor +``` +Removes the active text editor reference. + + + + + + + + Online Version + + + + + + + Send-VSCodeTerminalText + + Sends text to a Visual Studio Code terminal. + + Send + VSCodeTerminalText + + + Sends text to a Visual Studio Code terminal. You can target a terminal by object or name and control whether a newline is appended. + + + + Send-VSCodeTerminalText + + AddNewLine + + Appends a newline after the text is sent to the terminal. + + System.Management.Automation.SwitchParameter + + + Name + + The terminal name. + + System.String + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Text + + The text to insert or send. + + System.String + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + Send-VSCodeTerminalText + + AddNewLine + + Appends a newline after the text is sent to the terminal. + + System.Management.Automation.SwitchParameter + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Terminal + + The terminal object to receive text. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeTerminal + + + Text + + The text to insert or send. + + System.String + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + AddNewLine + + Appends a newline after the text is sent to the terminal. + + System.Management.Automation.SwitchParameter + + + Name + + The terminal name. + + System.String + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Terminal + + The terminal object to receive text. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeTerminal + + + Text + + The text to insert or send. + + System.String + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + System.String + + + This command returns objects described by the section heading. + + + + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeTerminal + + + This command returns objects described by the section heading. + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +Send-VSCodeTerminalText -Name 'PowerShell' -Text 'Get-Process' -AddNewLine +``` +Sends a command to the named terminal and appends a newline. + + + + + + + + Online Version + + + + + + + Set-VSCodeStatusBarMessage + + Sets the Visual Studio Code status bar message. + + Set + VSCodeStatusBarMessage + + + Displays a message in the Visual Studio Code status bar. Use Timeout to automatically hide the message after a period of time. + + + + Set-VSCodeStatusBarMessage + + Message + + The message text to display. + + System.String + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Timeout + + The number of milliseconds to show the status bar message. + + System.Int32 + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + Message + + The message text to display. + + System.String + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Timeout + + The number of milliseconds to show the status bar message. + + System.Int32 + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +Set-VSCodeStatusBarMessage -Message 'Build complete' -Timeout 5000 +``` +Shows a status bar message for five seconds. + + + + + + + + Online Version + + + + + + + Set-VSCodeTextEditorDecoration + + Sets a Visual Studio Code text editor decoration. + + Set + VSCodeTextEditorDecoration + + + Creates or updates text editor decoration styling in Visual Studio Code and applies it to one or more ranges in a text editor. + + + + Set-VSCodeTextEditorDecoration + + After + + Attachment styling to display after the decorated text. + + PowerShellToolsPro.Cmdlets.VSCode.DecorationAttachment + + + BackgroundColor + + The CSS background color to apply. + + System.String + + + Before + + Attachment styling to display before the decorated text. + + PowerShellToolsPro.Cmdlets.VSCode.DecorationAttachment + + + Border + + The CSS border value to apply. + + System.String + + + BorderColor + + The CSS border color to apply. + + System.String + + + BorderRadius + + The CSS border radius to apply. + + System.String + + + BorderStyle + + The CSS border style to apply. + + System.String + + + BorderWidth + + The CSS border width to apply. + + System.String + + + Color + + The CSS foreground color to apply. + + System.String + + + Cursor + + The CSS cursor value to use over the decorated text. + + System.String + + + FontStyle + + The CSS font style to apply. + + System.String + + + FontWeight + + The CSS font weight to apply. + + System.String + + + IsWholeLine + + Applies the decoration to the whole line. + + System.Management.Automation.SwitchParameter + + + Key + + The unique key used to identify a decoration. + + System.String + + + LetterSpacing + + The CSS letter spacing to apply. + + System.String + + + Opacity + + The CSS opacity value to apply. + + System.String + + + Outline + + The CSS outline value to apply. + + System.String + + + OutlineColor + + The CSS outline color to apply. + + System.String + + + OutlineStyle + + The CSS outline style to apply. + + System.String + + + OutlineWidth + + The CSS outline width to apply. + + System.String + + + Range + + The range of text to read, remove, or decorate. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeRange + + + RangeBehavior + + Controls how the decoration range behaves as text changes. + + System.String + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + TextDecoration + + The CSS text-decoration value to apply. + + System.String + + + TextEditor + + The text editor to decorate or remove. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextEditor + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + After + + Attachment styling to display after the decorated text. + + PowerShellToolsPro.Cmdlets.VSCode.DecorationAttachment + + + BackgroundColor + + The CSS background color to apply. + + System.String + + + Before + + Attachment styling to display before the decorated text. + + PowerShellToolsPro.Cmdlets.VSCode.DecorationAttachment + + + Border + + The CSS border value to apply. + + System.String + + + BorderColor + + The CSS border color to apply. + + System.String + + + BorderRadius + + The CSS border radius to apply. + + System.String + + + BorderStyle + + The CSS border style to apply. + + System.String + + + BorderWidth + + The CSS border width to apply. + + System.String + + + Color + + The CSS foreground color to apply. + + System.String + + + Cursor + + The CSS cursor value to use over the decorated text. + + System.String + + + FontStyle + + The CSS font style to apply. + + System.String + + + FontWeight + + The CSS font weight to apply. + + System.String + + + IsWholeLine + + Applies the decoration to the whole line. + + System.Management.Automation.SwitchParameter + + + Key + + The unique key used to identify a decoration. + + System.String + + + LetterSpacing + + The CSS letter spacing to apply. + + System.String + + + Opacity + + The CSS opacity value to apply. + + System.String + + + Outline + + The CSS outline value to apply. + + System.String + + + OutlineColor + + The CSS outline color to apply. + + System.String + + + OutlineStyle + + The CSS outline style to apply. + + System.String + + + OutlineWidth + + The CSS outline width to apply. + + System.String + + + Range + + The range of text to read, remove, or decorate. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeRange + + + RangeBehavior + + Controls how the decoration range behaves as text changes. + + System.String + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + TextDecoration + + The CSS text-decoration value to apply. + + System.String + + + TextEditor + + The text editor to decorate or remove. + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextEditor + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + PowerShellToolsPro.Cmdlets.VSCode.VsCodeTextEditor + + + This command returns objects described by the section heading. + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +$editor = Get-VSCodeTextEditor +$range = New-VSCodeRange -StartLine 0 -StartCharacter 0 -EndLine 0 -EndCharacter 5 +Set-VSCodeTextEditorDecoration -TextEditor $editor -Key 'highlight' -Range $range -BackgroundColor '#ffff0033' +``` +Highlights a range in the active editor. + + + + + + + + Online Version + + + + + + + Show-VSCodeInputBox + + Shows an input box in Visual Studio Code. + + Show + VSCodeInputBox + + + Shows a Visual Studio Code input box and returns the value entered by the user. + + + + Show-VSCodeInputBox + + EndValueSelection + + The ending character index for the selected input text. + + System.Int32 + + + IgnoreFocusOut + + Keeps the picker or input box open when focus moves away. + + System.Management.Automation.SwitchParameter + + + Password + + Masks the input box value. + + System.Management.Automation.SwitchParameter + + + PlaceHolder + + Placeholder text shown before input or selection. + + System.String + + + Prompt + + Prompt text shown in the input box. + + System.String + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + StartValueSelection + + The starting character index for the selected input text. + + System.Int32 + + + Value + + The default value shown in the input box. + + System.String + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + EndValueSelection + + The ending character index for the selected input text. + + System.Int32 + + + IgnoreFocusOut + + Keeps the picker or input box open when focus moves away. + + System.Management.Automation.SwitchParameter + + + Password + + Masks the input box value. + + System.Management.Automation.SwitchParameter + + + PlaceHolder + + Placeholder text shown before input or selection. + + System.String + + + Prompt + + Prompt text shown in the input box. + + System.String + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + StartValueSelection + + The starting character index for the selected input text. + + System.Int32 + + + Value + + The default value shown in the input box. + + System.String + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +Show-VSCodeInputBox -Prompt 'Enter a server name' -PlaceHolder 'localhost' +``` +Prompts the user for a server name. + + + + + + + + Online Version + + + + + + + Show-VSCodeMessage + + Shows a message in Visual Studio Code. + + Show + VSCodeMessage + + + Shows an information, warning, or error message in Visual Studio Code. Optional items are displayed as action buttons. + + + + Show-VSCodeMessage + + Items + + The items to show as actions or selections. + + System.String[] + + + Message + + The message text to display. + + System.String + + + Modal + + Shows the message as a modal dialog. + + System.Management.Automation.SwitchParameter + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Type + + The message type. Use Information, Warning, or Error. + + System.String + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + Items + + The items to show as actions or selections. + + System.String[] + + + Message + + The message text to display. + + System.String + + + Modal + + Shows the message as a modal dialog. + + System.Management.Automation.SwitchParameter + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Type + + The message type. Use Information, Warning, or Error. + + System.String + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +Show-VSCodeMessage -Message 'Build complete' -Type Information +``` +Shows an informational message in Visual Studio Code. + + + + + + + + Online Version + + + + + + + Show-VSCodeQuickPick + + Shows a quick pick list in Visual Studio Code. + + Show + VSCodeQuickPick + + + Shows a Visual Studio Code quick pick list and returns the selected item or items. + + + + Show-VSCodeQuickPick + + CanPickMany + + Allows the user to select more than one item. + + System.Management.Automation.SwitchParameter + + + IgnoreFocusOut + + Keeps the picker or input box open when focus moves away. + + System.Management.Automation.SwitchParameter + + + Items + + The items to show as actions or selections. + + System.String[] + + + PlaceHolder + + Placeholder text shown before input or selection. + + System.String + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + CanPickMany + + Allows the user to select more than one item. + + System.Management.Automation.SwitchParameter + + + IgnoreFocusOut + + Keeps the picker or input box open when focus moves away. + + System.Management.Automation.SwitchParameter + + + Items + + The items to show as actions or selections. + + System.String[] + + + PlaceHolder + + Placeholder text shown before input or selection. + + System.String + + + ResponseTimeout + + The number of milliseconds to wait for a response from Visual Studio Code. + + System.Int32 + + + Wait + + Waits for the VS Code command response before returning. + + System.Management.Automation.SwitchParameter + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +Show-VSCodeQuickPick -Items 'Debug','Release' -PlaceHolder 'Select configuration' +``` +Prompts the user to select a build configuration. + + + + + + + + Online Version + + + + + + + Start-PoshToolsServer + + Starts the PowerShell Pro Tools VS Code host server. + + Start + PoshToolsServer + + + Starts the named-pipe server used by the PowerShell Pro Tools VS Code extension to communicate with PowerShell commands. + + + + Start-PoshToolsServer + + PipeName + + The named pipe used by the host server. + + System.String + + + + + + PipeName + + The named pipe used by the host server. + + System.String + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +Start-PoshToolsServer -PipeName 'PowerShellProTools' +``` +Starts the VS Code host server using the specified named pipe. + + + + + + + + Online Version + + + + + diff --git a/PowerShellToolsPro.Cmdlets/CreateHelp.ps1 b/PowerShellToolsPro.Cmdlets/CreateHelp.ps1 index 0c01599..a10e64d 100644 --- a/PowerShellToolsPro.Cmdlets/CreateHelp.ps1 +++ b/PowerShellToolsPro.Cmdlets/CreateHelp.ps1 @@ -1 +1,41 @@ -New-ExternalHelp .\Help -OutputPath .\en-US -Force \ No newline at end of file +param( + [string]$HelpPath = (Join-Path $PSScriptRoot "Help"), + [string]$OutputPath = (Join-Path $PSScriptRoot "en-US") +) + +$platyps = Import-Module Microsoft.PowerShell.PlatyPS -RequiredVersion 1.0.1 -PassThru -ErrorAction SilentlyContinue +if ($null -eq $platyps) { + Install-Module Microsoft.PowerShell.PlatyPS -RequiredVersion 1.0.1 -Scope CurrentUser -Force -AllowClobber + Import-Module Microsoft.PowerShell.PlatyPS -RequiredVersion 1.0.1 +} + +$commandHelpPaths = Get-ChildItem $HelpPath -Filter "*.md" | + Where-Object { $_.Name -notlike "about_*.md" } | + Select-Object -ExpandProperty FullName +$commandHelp = Import-MarkdownCommandHelp -Path $commandHelpPaths +$externalHelpFiles = $commandHelp | Select-Object -ExpandProperty ExternalHelpFile -Unique +Export-MamlCommandHelp -CommandHelp $commandHelp -OutputFolder $OutputPath -Force | Out-Null + +Get-ChildItem $OutputPath -Filter "*-Help.xml" -Recurse | + Where-Object { $_.DirectoryName -ne (Resolve-Path $OutputPath).Path } | + Where-Object { $externalHelpFiles -contains $_.Name } | + ForEach-Object { + Copy-Item $_.FullName -Destination (Join-Path $OutputPath $_.Name) -Force + } + +Get-ChildItem $OutputPath -Directory | Remove-Item -Recurse -Force + +$utf8NoBom = New-Object System.Text.UTF8Encoding $false +Get-ChildItem $OutputPath -Filter "*-Help.xml" | ForEach-Object { + if ($externalHelpFiles -notcontains $_.Name) { + return + } + + $content = [System.IO.File]::ReadAllText($_.FullName) + $lines = $content -split "\r?\n" | ForEach-Object { $_ -replace "\s+$", "" } + $content = ($lines | Where-Object { $null -ne $_ }) -join "`n" + if (-not $content.EndsWith("`n")) { + $content += "`n" + } + [System.IO.File]::WriteAllText($_.FullName, $content, $utf8NoBom) +} diff --git a/PowerShellToolsPro.Cmdlets/Help/ConvertTo-WinForm.md b/PowerShellToolsPro.Cmdlets/Help/ConvertTo-WinForm.md new file mode 100644 index 0000000..5ebb812 --- /dev/null +++ b/PowerShellToolsPro.Cmdlets/Help/ConvertTo-WinForm.md @@ -0,0 +1,222 @@ +--- +document type: cmdlet +external help file: PowerShellToolsPro.Cmdlets.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: ConvertTo-WinForm +--- + +# ConvertTo-WinForm + +## SYNOPSIS + +Generates Windows Forms scripts from PowerShell commands or functions. + +## SYNTAX + +### filePath + +``` +ConvertTo-WinForm [-Path ] [-OutputPath ] [-PackageAsExecutable] + [] +``` + +### def + +``` +ConvertTo-WinForm [-FunctionDefinition ] [-OutputPath ] [-PackageAsExecutable] + [] +``` + +### functionInfo + +``` +ConvertTo-WinForm -Function [-OutputPath ] [-PackageAsExecutable] + [] +``` + +### cmdletInfo + +``` +ConvertTo-WinForm -Cmdlet [-OutputPath ] [-PackageAsExecutable] + [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Creates a Windows Forms designer script and companion logic script from a function, cmdlet, script block, or script file. The generated files can be edited with the Windows Forms designer and optionally packaged as an executable. + +## EXAMPLES + +### Example 1 + +```powershell +ConvertTo-WinForm -Path .\Get-UserInput.ps1 -OutputPath .\Get-UserInput.form.ps1 +``` +Generates a Windows Forms designer script and logic script from a PowerShell script file. + +## PARAMETERS + +### -Cmdlet + +A cmdlet whose parameters are used to generate a form. + +```yaml +Type: System.Management.Automation.CmdletInfo +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: cmdletInfo + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Function + +A function whose parameters are used to generate a form. + +```yaml +Type: System.Management.Automation.FunctionInfo +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: functionInfo + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -FunctionDefinition + +A script block whose parameters are used to generate a form. + +```yaml +Type: System.Management.Automation.ScriptBlock +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: def + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -OutputPath + +The output file or directory path. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -PackageAsExecutable + +Packages the generated form script as an executable. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Path + +The path to the input file or host variable. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: filePath + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.FunctionInfo + +This command returns objects described by the section heading. + +### System.Management.Automation.CmdletInfo + +This command returns objects described by the section heading. + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/PowerShellToolsPro.Cmdlets/Help/Expand-Object.md b/PowerShellToolsPro.Cmdlets/Help/Expand-Object.md new file mode 100644 index 0000000..598aaf5 --- /dev/null +++ b/PowerShellToolsPro.Cmdlets/Help/Expand-Object.md @@ -0,0 +1,91 @@ +--- +document type: cmdlet +external help file: PowerShellToolsPro.Cmdlets.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Expand-Object +--- + +# Expand-Object + +## SYNOPSIS + +Expands an object into name and value entries. + +## SYNTAX + +### __AllParameterSets + +``` +Expand-Object [-InputObject] [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Expands an input object into name and value entries that are easier to inspect in PowerShell Pro Tools views. + +## EXAMPLES + +### Example 1 + +```powershell +Get-Process -Id $PID | Expand-Object +``` +Expands the current PowerShell process object for inspection. + +## PARAMETERS + +### -InputObject + +The object to display, expand, or store. + +```yaml +Type: System.Object +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object + +This command returns objects described by the section heading. + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/PowerShellToolsPro.Cmdlets/Help/Merge-Script.md b/PowerShellToolsPro.Cmdlets/Help/Merge-Script.md index f719b1b..5dc1318 100644 --- a/PowerShellToolsPro.Cmdlets/Help/Merge-Script.md +++ b/PowerShellToolsPro.Cmdlets/Help/Merge-Script.md @@ -1,192 +1,257 @@ ---- -external help file: PowerShellToolsPro.Cmdlets.dll-Help.xml -online version: -schema: 2.0.0 ---- - -# Merge-Script - -## SYNOPSIS -Packages, bundles and\or obfuscates scripts. - -## SYNTAX - -### Parameters -``` -Merge-Script -Script [-OutputPath ] [-Bundle] [-Package] [-Obfuscate] [] -``` - -### ConfigFile -``` -Merge-Script -ConfigFile [] -``` - -### Config -``` -Merge-Script -Config [] -``` - -## DESCRIPTION -Packages, bundles and\or obfuscates scripts. Packaging and bundling are not mutually exclusive. Obfuscation -requires packaging. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Merge-Script -Script .\MyScript.ps1 -Output .\ -Package -``` - -Packages MyScript.ps1 into MyScript.exe and then outputs it to .\ - -### Example 2 -``` -PS C:\> Merge-Script -Script .\MyScript.ps1 -Output .\Bundle -Bundle -``` - -Bundles MyScript.ps1 and any scripts it dot sources into a single file and outputs it to .\Bundle. - -### Example 3 -``` -PS C:\> Merge-Script -Script .\MyScript.ps1 -Output .\Bundle -Bundle -Package -``` - -Bundles MyScript.ps1 and any scripts it dot sources into a single file and then packages it into MyScript.exe and outputs it to .\Bundle. - -### Example 4 -``` -PS C:\> Merge-Script -Script .\MyScript.ps1 -Output .\Bundle -Bundle -Package -Obfuscate -``` - -Bundles MyScript.ps1 and any scripts it dot sources into a single file and then packages it into MyScript.exe and outputs it to .\Bundle. The resulting executable will be obfuscated. - -### Example 5 -``` -PS C:\> Merge-Script -Config @{ Root = ".\MyScript.ps1"; Output = ".\"; Bundle = @{ Enabled = $true; NestedModules = $true; Modules = $true; } } -``` - -Uses a config hashtable to bundle MyScript.ps1 and any modules and nested modules with the script. - -## PARAMETERS - -### -Bundle -Bundles the script with dot sourced scripts found in the script. - -```yaml -Type: SwitchParameter -Parameter Sets: Parameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Config -A hashtable to specify the config for the cmdlet. See about_MergeScriptConfig. - -```yaml -Type: Hashtable -Parameter Sets: Config -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConfigFile -A config file to specify for the cmdlet. See about_MergeScriptConfig. - -```yaml -Type: String -Parameter Sets: ConfigFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Obfuscate -Obfuscate the .NET executable and PowerShell script. - -```yaml -Type: SwitchParameter -Parameter Sets: Parameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputPath -The output path for the resulting script or executable. -This should be a directory. - -```yaml -Type: String -Parameter Sets: Parameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Package -Package the script as a .NET executable. - -```yaml -Type: SwitchParameter -Parameter Sets: Parameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Script -The script to package in an executable and optionally bundle with other scripts. - -```yaml -Type: String -Parameter Sets: Parameters -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 - +--- +document type: cmdlet +external help file: PowerShellToolsPro.Cmdlets.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Merge-Script +--- + +# Merge-Script + +## SYNOPSIS + +Packages, bundles, or obfuscates PowerShell scripts. + +## SYNTAX + +### Parameters + +``` +Merge-Script -Script [-OutputPath ] [-Bundle] [-Package] [-Obfuscate] + [] +``` + +### Config + +``` +Merge-Script -Config [] +``` + +### ConfigFile + +``` +Merge-Script -ConfigFile [] +``` + +### PackageConfig + +``` +Merge-Script -SerializedPackageConfig [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Packages, bundles, or obfuscates scripts. Packaging and bundling can be used together, and obfuscation requires packaging. + +## EXAMPLES + +### Example 1 + +```powershell +Merge-Script -Script .\MyScript.ps1 -OutputPath .\out -Bundle -Package +``` +Bundles a script and packages it as an executable in the output directory. + +## PARAMETERS + +### -Bundle + +Bundles the script with dot sourced scripts found in the script. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: Parameters + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Config + +A hashtable to specify the config for the cmdlet. +See about_MergeScriptConfig. + +```yaml +Type: System.Collections.Hashtable +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: Config + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ConfigFile + +A config file to specify for the cmdlet. + See about_MergeScriptConfig. + +```yaml +Type: System.String +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: ConfigFile + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Obfuscate + +Obfuscate the .NET executable and PowerShell script. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: Parameters + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -OutputPath + +The output path for the resulting script or executable. +This should be a directory. + +```yaml +Type: System.String +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: Parameters + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Package + +Package the script as a .NET executable. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: Parameters + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Script + +The script to package in an executable and optionally bundle with other scripts. + +```yaml +Type: System.String +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: Parameters + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SerializedPackageConfig + +A serialized package configuration JSON string. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: PackageConfig + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + + + + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/PowerShellToolsPro.Cmdlets/Help/Show-WinFormDesigner.md b/PowerShellToolsPro.Cmdlets/Help/Show-WinFormDesigner.md new file mode 100644 index 0000000..16a8a61 --- /dev/null +++ b/PowerShellToolsPro.Cmdlets/Help/Show-WinFormDesigner.md @@ -0,0 +1,108 @@ +--- +document type: cmdlet +external help file: PowerShellToolsPro.Cmdlets.dll-Help.xml +HelpUri: '' +Locale: en-US +Module Name: PowerShellProTools +ms.date: 07-21-2026 +PlatyPS schema version: 2024-05-01 +title: Show-WinFormDesigner +--- + +# Show-WinFormDesigner + +## SYNOPSIS + +Opens the Windows Forms designer for PowerShell scripts. + +## SYNTAX + +### __AllParameterSets + +``` +Show-WinFormDesigner -DesignerFilePath -CodeFilePath [] +``` + +## ALIASES + +This cmdlet has no aliases. + +## DESCRIPTION + +Starts the PowerShell Pro Tools Windows Forms designer for the specified designer and code-behind script files. This command is only supported on Windows. + +## EXAMPLES + +### Example 1 + +```powershell +Show-WinFormDesigner -DesignerFilePath .\MainForm.designer.ps1 -CodeFilePath .\MainForm.ps1 +``` +Opens the Windows Forms designer for the specified form files. + +## PARAMETERS + +### -CodeFilePath + +The path to the form code-behind script. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DesignerFilePath + +The path to the designer script file. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, +-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +This command returns objects described by the section heading. + +## NOTES + +This command is intended for use with PowerShell Pro Tools automation. + +## RELATED LINKS + +https://docs.poshtools.com/sitemap.md diff --git a/PowerShellToolsPro.Cmdlets/PowerShellToolsPro.Cmdlets.csproj b/PowerShellToolsPro.Cmdlets/PowerShellToolsPro.Cmdlets.csproj index 4d2bb37..39678ee 100644 --- a/PowerShellToolsPro.Cmdlets/PowerShellToolsPro.Cmdlets.csproj +++ b/PowerShellToolsPro.Cmdlets/PowerShellToolsPro.Cmdlets.csproj @@ -37,8 +37,7 @@ - - + @@ -71,4 +70,3 @@ - diff --git a/PowerShellToolsPro.Cmdlets/build.ps1 b/PowerShellToolsPro.Cmdlets/build.ps1 index 86a5d63..eb8e4d1 100644 --- a/PowerShellToolsPro.Cmdlets/build.ps1 +++ b/PowerShellToolsPro.Cmdlets/build.ps1 @@ -2,10 +2,10 @@ Push-Location $PSScriptRoot -$platyps = Import-Module PlatyPS -PassThru -ErrorAction SilentlyContinue +$platyps = Import-Module Microsoft.PowerShell.PlatyPS -RequiredVersion 1.0.1 -PassThru -ErrorAction SilentlyContinue if ($platyps -eq $null) { - Install-Module PlatyPS -Force -Scope CurrentUser - Import-Module PlatyPS + Install-Module Microsoft.PowerShell.PlatyPS -RequiredVersion 1.0.1 -Force -Scope CurrentUser -AllowClobber + Import-Module Microsoft.PowerShell.PlatyPS -RequiredVersion 1.0.1 } dotnet publish -f netstandard2.0 -c $Configuration diff --git a/PowerShellToolsPro.Cmdlets/en-US/PowerShellToolsPro.Cmdlets.dll-Help.xml b/PowerShellToolsPro.Cmdlets/en-US/PowerShellToolsPro.Cmdlets.dll-Help.xml index 355a09b..2fd7979 100644 --- a/PowerShellToolsPro.Cmdlets/en-US/PowerShellToolsPro.Cmdlets.dll-Help.xml +++ b/PowerShellToolsPro.Cmdlets/en-US/PowerShellToolsPro.Cmdlets.dll-Help.xml @@ -1,257 +1,553 @@ - - - - - Merge-Script - Merge - Script - - Packages, bundles and\or obfuscates scripts. - - - - Packages, bundles and\or obfuscates scripts. Packaging and bundling are not mutually exclusive. Obfuscation requires packaging. - - - - Merge-Script - - Bundle - - Bundles the script with dot sourced scripts found in the script. - - - SwitchParameter - - - False - - - Obfuscate - - Obfuscate the .NET executable and PowerShell script. - - - SwitchParameter - - - False - - - OutputPath - - The output path for the resulting script or executable. This should be a directory. - - String - - String - - - None - - - Package - - Package the script as a .NET executable. - - - SwitchParameter - - - False - - - Script - - The script to package in an executable and optionally bundle with other scripts. - - String - - String - - - None - - - - Merge-Script - - Config - - A hashtable to specify the config for the cmdlet. See about_MergeScriptConfig. - - Hashtable - - Hashtable - - - None - - - - Merge-Script - - ConfigFile - - A config file to specify for the cmdlet. See about_MergeScriptConfig. - - String - - String - - - None - - - - - - Bundle - - Bundles the script with dot sourced scripts found in the script. - - SwitchParameter - - SwitchParameter - - - False - - - Config - - A hashtable to specify the config for the cmdlet. See about_MergeScriptConfig. - - Hashtable - - Hashtable - - - None - - - ConfigFile - - A config file to specify for the cmdlet. See about_MergeScriptConfig. - - String - - String - - - None - - - Obfuscate - - Obfuscate the .NET executable and PowerShell script. - - SwitchParameter - - SwitchParameter - - - False - - - OutputPath - - The output path for the resulting script or executable. This should be a directory. - - String - - String - - - None - - - Package - - Package the script as a .NET executable. - - SwitchParameter - - SwitchParameter - - - False - - - Script - - The script to package in an executable and optionally bundle with other scripts. - - String - - String - - - None - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Merge-Script -Script .\MyScript.ps1 -Output .\ -Package - - Packages MyScript.ps1 into MyScript.exe and then outputs it to .\ - - - - -------------------------- Example 2 -------------------------- - PS C:\> Merge-Script -Script .\MyScript.ps1 -Output .\Bundle -Bundle - - Bundles MyScript.ps1 and any scripts it dot sources into a single file and outputs it to .\Bundle. - - - - -------------------------- Example 3 -------------------------- - PS C:\> Merge-Script -Script .\MyScript.ps1 -Output .\Bundle -Bundle -Package - - Bundles MyScript.ps1 and any scripts it dot sources into a single file and then packages it into MyScript.exe and outputs it to .\Bundle. - - - - -------------------------- Example 4 -------------------------- - PS C:\> Merge-Script -Script .\MyScript.ps1 -Output .\Bundle -Bundle -Package -Obfuscate - - Bundles MyScript.ps1 and any scripts it dot sources into a single file and then packages it into MyScript.exe and outputs it to .\Bundle. The resulting executable will be obfuscated. - - - - -------------------------- Example 5 -------------------------- - PS C:\> Merge-Script -Config @{ Root = ".\MyScript.ps1"; Output = ".\"; Bundle = @{ Enabled = $true; NestedModules = $true; Modules = $true; } } - - Uses a config hashtable to bundle MyScript.ps1 and any modules and nested modules with the script. - - - - - - \ No newline at end of file + + + + + ConvertTo-WinForm + + Generates Windows Forms scripts from PowerShell commands or functions. + + ConvertTo + WinForm + + + Creates a Windows Forms designer script and companion logic script from a function, cmdlet, script block, or script file. The generated files can be edited with the Windows Forms designer and optionally packaged as an executable. + + + + ConvertTo-WinForm + + OutputPath + + The output file or directory path. + + System.String + + + PackageAsExecutable + + Packages the generated form script as an executable. + + System.Management.Automation.SwitchParameter + + + Path + + The path to the input file or host variable. + + System.String + + + + ConvertTo-WinForm + + FunctionDefinition + + A script block whose parameters are used to generate a form. + + System.Management.Automation.ScriptBlock + + + OutputPath + + The output file or directory path. + + System.String + + + PackageAsExecutable + + Packages the generated form script as an executable. + + System.Management.Automation.SwitchParameter + + + + ConvertTo-WinForm + + Function + + A function whose parameters are used to generate a form. + + System.Management.Automation.FunctionInfo + + + OutputPath + + The output file or directory path. + + System.String + + + PackageAsExecutable + + Packages the generated form script as an executable. + + System.Management.Automation.SwitchParameter + + + + ConvertTo-WinForm + + Cmdlet + + A cmdlet whose parameters are used to generate a form. + + System.Management.Automation.CmdletInfo + + + OutputPath + + The output file or directory path. + + System.String + + + PackageAsExecutable + + Packages the generated form script as an executable. + + System.Management.Automation.SwitchParameter + + + + + + Cmdlet + + A cmdlet whose parameters are used to generate a form. + + System.Management.Automation.CmdletInfo + + + Function + + A function whose parameters are used to generate a form. + + System.Management.Automation.FunctionInfo + + + FunctionDefinition + + A script block whose parameters are used to generate a form. + + System.Management.Automation.ScriptBlock + + + OutputPath + + The output file or directory path. + + System.String + + + PackageAsExecutable + + Packages the generated form script as an executable. + + System.Management.Automation.SwitchParameter + + + Path + + The path to the input file or host variable. + + System.String + + + + + + System.Management.Automation.FunctionInfo + + + This command returns objects described by the section heading. + + + + + System.Management.Automation.CmdletInfo + + + This command returns objects described by the section heading. + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +ConvertTo-WinForm -Path .\Get-UserInput.ps1 -OutputPath .\Get-UserInput.form.ps1 +``` +Generates a Windows Forms designer script and logic script from a PowerShell script file. + + + + + + + + Online Version + + + + + + + Expand-Object + + Expands an object into name and value entries. + + Expand + Object + + + Expands an input object into name and value entries that are easier to inspect in PowerShell Pro Tools views. + + + + Expand-Object + + InputObject + + The object to display, expand, or store. + + System.Object + + + + + + InputObject + + The object to display, expand, or store. + + System.Object + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +Get-Process -Id $PID | Expand-Object +``` +Expands the current PowerShell process object for inspection. + + + + + + + + Online Version + + + + + + + Merge-Script + + Packages, bundles, or obfuscates PowerShell scripts. + + Merge + Script + + + Packages, bundles, or obfuscates scripts. Packaging and bundling can be used together, and obfuscation requires packaging. + + + + Merge-Script + + Bundle + + Bundles the script with dot sourced scripts found in the script. + + System.Management.Automation.SwitchParameter + + + Obfuscate + + Obfuscate the .NET executable and PowerShell script. + + System.Management.Automation.SwitchParameter + + + OutputPath + + The output path for the resulting script or executable. +This should be a directory. + + System.String + + + Package + + Package the script as a .NET executable. + + System.Management.Automation.SwitchParameter + + + Script + + The script to package in an executable and optionally bundle with other scripts. + + System.String + + + + Merge-Script + + Config + + A hashtable to specify the config for the cmdlet. +See about_MergeScriptConfig. + + System.Collections.Hashtable + + + + Merge-Script + + ConfigFile + + A config file to specify for the cmdlet. + See about_MergeScriptConfig. + + System.String + + + + Merge-Script + + SerializedPackageConfig + + A serialized package configuration JSON string. + + System.String + + + + + + Bundle + + Bundles the script with dot sourced scripts found in the script. + + System.Management.Automation.SwitchParameter + + + Config + + A hashtable to specify the config for the cmdlet. +See about_MergeScriptConfig. + + System.Collections.Hashtable + + + ConfigFile + + A config file to specify for the cmdlet. + See about_MergeScriptConfig. + + System.String + + + Obfuscate + + Obfuscate the .NET executable and PowerShell script. + + System.Management.Automation.SwitchParameter + + + OutputPath + + The output path for the resulting script or executable. +This should be a directory. + + System.String + + + Package + + Package the script as a .NET executable. + + System.Management.Automation.SwitchParameter + + + Script + + The script to package in an executable and optionally bundle with other scripts. + + System.String + + + SerializedPackageConfig + + A serialized package configuration JSON string. + + System.String + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + + + + + + --------- Example 1 --------- + + ```powershell +Merge-Script -Script .\MyScript.ps1 -OutputPath .\out -Bundle -Package +``` +Bundles a script and packages it as an executable in the output directory. + + + + + + + + Online Version + + + + + + + Show-WinFormDesigner + + Opens the Windows Forms designer for PowerShell scripts. + + Show + WinFormDesigner + + + Starts the PowerShell Pro Tools Windows Forms designer for the specified designer and code-behind script files. This command is only supported on Windows. + + + + Show-WinFormDesigner + + CodeFilePath + + The path to the form code-behind script. + + System.String + + + DesignerFilePath + + The path to the designer script file. + + System.String + + + + + + CodeFilePath + + The path to the form code-behind script. + + System.String + + + DesignerFilePath + + The path to the designer script file. + + System.String + + + + + + + System.Object + + + This command returns objects described by the section heading. + + + + + + This command is intended for use with PowerShell Pro Tools automation. + + + + + --------- Example 1 --------- + + ```powershell +Show-WinFormDesigner -DesignerFilePath .\MainForm.designer.ps1 -CodeFilePath .\MainForm.ps1 +``` +Opens the Windows Forms designer for the specified form files. + + + + + + + + Online Version + + + + + diff --git a/PowerShellToolsPro.Cmdlets/post-build.ps1 b/PowerShellToolsPro.Cmdlets/post-build.ps1 index f33b432..03fb244 100644 --- a/PowerShellToolsPro.Cmdlets/post-build.ps1 +++ b/PowerShellToolsPro.Cmdlets/post-build.ps1 @@ -30,6 +30,5 @@ New-ModuleManifest $ManifestPath @Arguments Import-Module $ManifestPath -Force -New-ExternalHelp -Path (Join-Path $PSScriptRoot "help") -OutputPath (Join-Path $PSScriptRoot "en-US") -Force - +& (Join-Path $PSScriptRoot "CreateHelp.ps1") -HelpPath (Join-Path $PSScriptRoot "Help") -OutputPath (Join-Path $PSScriptRoot "en-US") diff --git a/vscode/vscode.build.ps1 b/vscode/vscode.build.ps1 index 2cc9086..f80fc2f 100644 --- a/vscode/vscode.build.ps1 +++ b/vscode/vscode.build.ps1 @@ -45,6 +45,7 @@ task BuildWinFormDesigner { task BuildHost { Push-Location (Join-Path $RootDir ".\..\..\HostInjection") dotnet build -c $Configuration -o $RootDir\Modules\PowerShellProTools.VSCode + & .\CreateHelp.ps1 -OutputPath $RootDir\Modules\PowerShellProTools.VSCode\en-US Pop-Location & $PSScriptRoot\..\Build\sign.ps1 -Path $RootDir\Modules\PowerShellProTools.VSCode\PowerShellProTools.VSCode.dll