Get-ValeConfiguration

Get-ValeConfiguration

SYNOPSIS

Returns the current configuration for Vale as an object.

SYNTAX

Get-ValeConfiguration [[-Path] <String>] [<CommonParameters>]

DESCRIPTION

The Get-ValeConfiguration cmdlet returns a Vale configuration as an object.

EXAMPLES

Example 1: Get the workspace Vale configuration

Get-ValeConfiguration

BlockIgnores   :
Checks         : {PowerShell-Docs.Passive, Vale.Spelling, alex.Ablist…}
Formats        :
Asciidoctor    :
FormatToLang   :
GBaseStyles    :
GChecks        :
IgnoredClasses :
IgnoredScopes  :
MinAlertLevel  : 0
Vocab          : {Base}
RuleToLevel    :
SBaseStyles    : @{*.md=System.Object[]}
SChecks        : @{*.md=}
SkippedScopes  :
Stylesheets    :
StylesPath     : C:/code/Documentarian/.vscode/styles
TokenIgnores   :
WordTemplate   :
DictionaryPath :
NLPEndpoint    :

Example 2: Get a specific Vale configuration

Get-ValeConfiguration -Path /code/site/.vale.ini

BlockIgnores   : @{*.md=System.Object[]}
Checks         : {alex.Ablist, alex.Gendered, alex.ProfanityLikely, alex.ProfanityMaybe…}
Formats        :
Asciidoctor    :
FormatToLang   :
GBaseStyles    :
GChecks        :
IgnoredClasses :
IgnoredScopes  :
MinAlertLevel  : 0
Vocab          : {Base}
RuleToLevel    :
SBaseStyles    : @{*.md=System.Object[]}
SChecks        : @{*.md=}
SkippedScopes  :
Stylesheets    :
StylesPath     : C:/code/site/.vscode/styles
TokenIgnores   : @{*.md=System.Object[]}
WordTemplate   :
DictionaryPath :
NLPEndpoint    :

PARAMETERS

-Path

Specify the path to a Vale configuration file (typically .vale.ini) to return as an object.

Type: String
Parameter Sets: (All)
Aliases:

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

CommonParameters

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

INPUTS

None

This cmdlet doesn’t support any pipeline input.

OUTPUTS

ValeEffectiveConfiguration

This cmdlet returns an object reflecting the effective configuration defined in the .vale.ini configuration file. An effective configuration merges the settings from any packages that include a configuration with the root configuration.

NOTES

RELATED LINKS