scripts

Get-VSCodeSettingsFile.ps1

SYNOPSIS

Gets the path of the VSCode settings.config file.

SYNTAX

Get-VSCodeSettingsFile.ps1 [-Workspace] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

EXAMPLES

EXAMPLE 1

Get-VSCodeSettingsFile.ps1

C:\Users\zaphodb\AppData\Roaming\Code\User\settings.json

EXAMPLE 2

Get-VSCodeSettingsFile.ps1 -Workspace

C:\Users\zaphodb\GitHub\scripts.vscode\settings.json

PARAMETERS

-Workspace

Indicates that the current workspace settings should be parsed instead of the user settings.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.String containing the path of the settings.config file.

NOTES

https://code.visualstudio.com/docs/getstarted/settings

https://powershell.github.io/PowerShellEditorServices/api/Microsoft.PowerShell.EditorServices.Extensions.EditorObject.html

https://git-scm.com/docs/git-rev-parse

Join-Path

Get-Command

Stop-ThrowError.ps1