en-US/Documentarian.Vale-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ProseMetric</command:name> <command:verb>Get</command:verb> <command:noun>ProseMetric</command:noun> <maml:description> <maml:para>Returns metrics about the prose in a document.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-ProseMetric` cmdlet returns various metrics for a document's prose as an object. The metrics include counts for characters, syllables, words, and more. You can use these metrics to investigate the complexity of your documents.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ProseMetric</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the path to one or more files or folders to get the metrics for. If you specify a folder, the cmdlet returns metrics for every Markdown file in that folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should get metrics for the Markdown files in child folders.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the path to one or more files or folders to get the metrics for. If you specify a folder, the cmdlet returns metrics for every Markdown file in that folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should get metrics for the Markdown files in child folders.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet doesn't support any pipeline input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ValeMetrics</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns a ValeMetrics object containing various counts for different components of the prose, like words and paragraphs.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------ Example 1: Get the metrics for a file ------------</maml:title> <dev:code>Get-ProseMetric -Path ./README.md -pwsh-list characters : 2198 complex_words : 83 heading_h2 : 5 heading_h3 : 4 list : 8 long_words : 139 paragraphs : 28 polysyllabic_words : 96 sentences : 38 syllables : 755 words : 419 FileName : C:\code\pwsh\Documentarian\README.md</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----- Example 2: Get the word count for files and folders -----</maml:title> <dev:code>Get-ProseMetric .\README.md, .\CHANGELOG.md, .\Documentation\reference\cmdlets\ | Format-Table -Property Words, FileName -pwsh-table words FileName ----- -------- 17 C:\code\README.md 3 C:\code\CHANGELOG.md 33 C:\code\Documentation\reference\cmdlets\_index.md 153 C:\code\Documentation\reference\cmdlets\Convert-MDLinks.md 94 C:\code\Documentation\reference\cmdlets\Get-ContentWithoutHeader.md 98 C:\code\Documentation\reference\cmdlets\Get-Document.md 721 C:\code\Documentation\reference\cmdlets\Get-DocumentLink.md 131 C:\code\Documentation\reference\cmdlets\Get-Metadata.md 144 C:\code\Documentation\reference\cmdlets\Remove-Metadata.md 107 C:\code\Documentation\reference\cmdlets\Set-Metadata.md 116 C:\code\Documentation\reference\cmdlets\Update-Metadata.md</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/vale/reference/cmdlets/get-prosemetric</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ProseReadability</command:name> <command:verb>Get</command:verb> <command:noun>ProseReadability</command:noun> <maml:description> <maml:para>Returns the readability score of a markdown using Vale.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet uses the Vale linter to get the readability score of a Markdown file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ProseReadability</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to a markdown file or a folder containing markdown files. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ReadabilityRule</maml:name> <maml:description> <maml:para>Specify the name of one or more readability rules to run. The default value is `AutomatedReadability`.</maml:para> <maml:para>The following values are accepted:</maml:para> <maml:para>- `AutomatedReadability`</maml:para> <maml:para>- `ColemanLiau`</maml:para> <maml:para>- `FleschKincaid`</maml:para> <maml:para>- `FleschReadingEase`</maml:para> <maml:para>- `GunningFog`</maml:para> <maml:para>- `LIX`</maml:para> <maml:para>- `SMOG`</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">AutomatedReadability</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ColemanLiau</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FleschKincaid</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FleschReadingEase</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GunningFog</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LIX</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SMOG</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>AutomatedReadability</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should return the readability scores for all known rules.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProblemsOnly</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should only return readability scores when the score doesn't meet the rule's defined threshold.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should get the readability scores for the Markdown files in child folders.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ProseReadability</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to a markdown file or a folder containing markdown files. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ReadabilityRule</maml:name> <maml:description> <maml:para>Specify the name of one or more readability rules to run. The default value is `AutomatedReadability`.</maml:para> <maml:para>The following values are accepted:</maml:para> <maml:para>- `AutomatedReadability`</maml:para> <maml:para>- `ColemanLiau`</maml:para> <maml:para>- `FleschKincaid`</maml:para> <maml:para>- `FleschReadingEase`</maml:para> <maml:para>- `GunningFog`</maml:para> <maml:para>- `LIX`</maml:para> <maml:para>- `SMOG`</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">AutomatedReadability</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ColemanLiau</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FleschKincaid</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FleschReadingEase</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GunningFog</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LIX</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SMOG</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>AutomatedReadability</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Preset</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should return readability scores for a predefined group of rules. Specify `GradeLevels` to return only the readability scores for rules that map to US school grade levels. Specify `Numericals` to return only the readability scores for rules that don't map to a grade level.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProblemsOnly</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should only return readability scores when the score doesn't meet the rule's defined threshold.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should get the readability scores for the Markdown files in child folders.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ProseReadability</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to a markdown file or a folder containing markdown files. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ReadabilityRule</maml:name> <maml:description> <maml:para>Specify the name of one or more readability rules to run. The default value is `AutomatedReadability`.</maml:para> <maml:para>The following values are accepted:</maml:para> <maml:para>- `AutomatedReadability`</maml:para> <maml:para>- `ColemanLiau`</maml:para> <maml:para>- `FleschKincaid`</maml:para> <maml:para>- `FleschReadingEase`</maml:para> <maml:para>- `GunningFog`</maml:para> <maml:para>- `LIX`</maml:para> <maml:para>- `SMOG`</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">AutomatedReadability</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ColemanLiau</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FleschKincaid</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FleschReadingEase</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GunningFog</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LIX</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SMOG</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>AutomatedReadability</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProblemsOnly</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should only return readability scores when the score doesn't meet the rule's defined threshold.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should get the readability scores for the Markdown files in child folders.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Threshold</maml:name> <maml:description> <maml:para>Specify an alternative target to check the readability score against. When specified with more than one rule, this value overwrites them all.</maml:para> <maml:para>Every rule has its own pre-defined Threshold .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should return the readability scores for all known rules.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to a markdown file or a folder containing markdown files. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Preset</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should return readability scores for a predefined group of rules. Specify `GradeLevels` to return only the readability scores for rules that map to US school grade levels. Specify `Numericals` to return only the readability scores for rules that don't map to a grade level.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProblemsOnly</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should only return readability scores when the score doesn't meet the rule's defined threshold.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ReadabilityRule</maml:name> <maml:description> <maml:para>Specify the name of one or more readability rules to run. The default value is `AutomatedReadability`.</maml:para> <maml:para>The following values are accepted:</maml:para> <maml:para>- `AutomatedReadability`</maml:para> <maml:para>- `ColemanLiau`</maml:para> <maml:para>- `FleschKincaid`</maml:para> <maml:para>- `FleschReadingEase`</maml:para> <maml:para>- `GunningFog`</maml:para> <maml:para>- `LIX`</maml:para> <maml:para>- `SMOG`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>AutomatedReadability</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should get the readability scores for the Markdown files in child folders.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Threshold</maml:name> <maml:description> <maml:para>Specify an alternative target to check the readability score against. When specified with more than one rule, this value overwrites them all.</maml:para> <maml:para>Every rule has its own pre-defined Threshold .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ValeReadability</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ValeMetricsAutomatedReadability</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ValeMetricsColemanLiau</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ValeMetricsFleschKincaid</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ValeMetricsFleschReadingEase</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ValeMetricsGunningFog</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ValeMetricsLIX</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ValeMetricsSMOG</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------ Example 1 - Get the FleschKincaid score of a file ------</maml:title> <dev:code>Get-Readability reference\7.2\CimCmdlets\Get-CimAssociatedInstance.md FleschKincaid Rule Score Threshold File ---- ----- --------- ---- FleschKincaid 11th Grade 8th Grade Get-CimAssociatedInstance.md</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/vale/reference/cmdlets/get-prosereadability</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ProseMetric</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Vale</command:name> <command:verb>Get</command:verb> <command:noun>Vale</command:noun> <maml:description> <maml:para>Gets the command info for Vale installed in a workspace or on a machine.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-Vale` cmdlet returns a System.Management.Automation.ApplicationInfo object for the `vale` binary if it's available. It first checks the `PATH` environment variable and, if `vale` isn't available, checks the `.vale` folder in the current working directory.</maml:para> <maml:para>This cmdlet is a convenience helper for using Vale when installed to the workspace, as with the Install-WorkspaceVale (/modules/vale/reference/cmdlets/install-workspacevale)cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Vale</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet doesn't support any pipeline input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ValeApplicationInfo</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns a ValeApplicationInfo object, representing the same information as the System.Management.Automation.ApplicationInfo type but with the Version property correctly reflecting Vale's version.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Get Vale and show its version -----------</maml:title> <dev:code>$Vale = Get-Vale & $Vale --version vale version 2.22.0</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/vale/reference/cmdlets/get-vale</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-WorkspaceVale</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ValeConfiguration</command:name> <command:verb>Get</command:verb> <command:noun>ValeConfiguration</command:noun> <maml:description> <maml:para>Returns the current configuration for Vale as an object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-ValeConfiguration` cmdlet returns a Vale configuration as an object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ValeConfiguration</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the path to a Vale configuration file (typically `.vale.ini`) to return as an object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the path to a Vale configuration file (typically `.vale.ini`) to return as an object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet doesn't support any pipeline input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ValeEffectiveConfiguration</maml:name> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------- Example 1: Get the workspace Vale configuration -------</maml:title> <dev:code>Get-ValeConfiguration -output-list 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 :</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------- Example 2: Get a specific Vale configuration ---------</maml:title> <dev:code>Get-ValeConfiguration -Path /code/site/.vale.ini -pwsh-list 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 :</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/vale/reference/cmdlets/get-valeconfiguration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Install-WorkspaceVale</command:name> <command:verb>Install</command:verb> <command:noun>WorkspaceVale</command:noun> <maml:description> <maml:para>Installs Vale to the current working directory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Install-WorkspaceVale` cmdlet is a helper for installing Vale into a project folder. When used, it installs Vale into the `.vale` folder of the current directory.</maml:para> <maml:para>This cmdlet is useful for installing Vale in CI or when you only need it for a specific project. It isn't a full alternative to using a package manager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Install-WorkspaceVale</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specify the version of Vale to install. By default, the cmdlet installs the latest version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>When this parameter is specified, the cmdlet returns the FileInfo for the installed binary. By default, the cmdlet returns no output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>When this parameter is specified, the cmdlet returns the FileInfo for the installed binary. By default, the cmdlet returns no output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specify the version of Vale to install. By default, the cmdlet installs the latest version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet doesn't support any pipeline input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>By default, this cmdlet returns no output.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para>If the PassThru parameter is specified, the cmdlet returns the FileInfo for the installed binary.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------- Example 1: Install the latest version of Vale --------</maml:title> <dev:code>Install-Vale</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------- Example 1: Install a specific version of Vale --------</maml:title> <dev:code>Install-Vale -Version 'v2.21.3'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/vale/reference/cmdlets/install-workspacevale</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-Vale</command:name> <command:verb>Invoke</command:verb> <command:noun>Vale</command:noun> <maml:description> <maml:para>Calls the vale executable and returns the result as a PowerShell object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Invoke-Vale` cmdlet calls the `vale` binary and a PSCustomObject representing the JSON output. It makes it simpler to retrieve structured output from Vale.</maml:para> <maml:para>The cmdlet automatically appends the `--output JSON` flag and value to your argument list, ensuring that Vale always returns structured output when it can.</maml:para> <maml:para>It also has specific error-handling for common Vale errors, reducing the need for troubleshooting and parsing strings to understand what went wrong.</maml:para> <maml:para>The cmdlet is capable of calling Vale whether it's installed in the `PATH` environment variable or the workspace, as with the Install-WorkspaceVale (../install-workspacevale)cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-Vale</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ArgumentList</maml:name> <maml:description> <maml:para>Specify one or more arguments to pass to Vale. The arguments `--output` and `JSON` are always appended to the list and don't need to be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ArgumentList</maml:name> <maml:description> <maml:para>Specify one or more arguments to pass to Vale. The arguments `--output` and `JSON` are always appended to the list and don't need to be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet doesn't support any pipeline input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns a string when the argument list includes the flags for displaying Vale's version (`-v` and `--version`) or help (`-h` and `--help`). When any of those flags are used, Vale returns strings instead of JSON.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.OrderedHashtable</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns an OrderedHashtable for the structured output from Vale.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>The `Invoke-Vale` cmdlet is useful for calling Vale, handling its common errors, and returning structured output. However, the output isn't always in the most usable form. The other cmdlets in this module return more specific and useful information. They also have parameters that are easier to use than building an array of arguments.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-- Example 1: Invoke vale to get the effective configuration --</maml:title> <dev:code>Invoke-Vale -ArgumentList 'ls-config' BlockIgnores : Checks : {PowerShell-Docs.Passive, Vale.Spelling, alex.Ablist, alex.Profanity…} Formats : Asciidoctor : FormatToLang : GBaseStyles : GChecks : IgnoredClasses : IgnoredScopes : MinAlertLevel : 0 Vocab : {Base} RuleToLevel : SBaseStyles : @{*.md=System.Object[]} SChecks : @{*.md=} SkippedScopes : Stylesheets : StylesPath : C:/code/pwsh/Documentarian/.vscode/styles TokenIgnores : WordTemplate : DictionaryPath : NLPEndpoint</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/vale/reference/cmdlets/invoke-vale</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-WorkspaceVale</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-ValeConfiguration</command:name> <command:verb>New</command:verb> <command:noun>ValeConfiguration</command:noun> <maml:description> <maml:para>Create a minimal configuration file for Vale.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `New-ValeConfiguration` cmdlet is a helper function for creating a basic Vale configuration file. By default, it creates the `.vale.ini` file in the working directory with the same settings as Vale's own configuration generator (https://vale.sh/generator/)and then immediately syncs the newly created configuration.</maml:para> <maml:para>You can use the FilePath parameter to create the configuration file in a different location or with a different name. You can use the StylesPath to change where style packages are placed when you use the `Sync-Vale` command.</maml:para> <maml:para>The StylePackage parameter can automatically complete values for known Vale style packages. It can also handle arbitrary packages, like those published to a URL or included in a local zip folder.</maml:para> <maml:para>You can use the NoSpelling switch to prevent the new configuration from including Vale's built-in spell checking. Use the NoSync switch if you don't want to sync the styles immediately.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ValeConfiguration</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Specify the path to the configuration file to create. By default, the cmdlet creates the `.vale.ini` file in the current working directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>StylesPath</maml:name> <maml:description> <maml:para>Specify the folder for Vale to store the style packages. The default value is the `styles` folder in the same directory as the configuration file. If this value is a relative path, the path is relative to the configuration file, not the current working directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>MinimumAlertLevel</maml:name> <maml:description> <maml:para>Specify the minimum alert level for the configuration file. This affects whether Vale ignores any rules. The default value is `Suggestion`, which ensures all violations are reported.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Suggestion</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Error</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ValeAlertLevel</command:parameterValue> <dev:type> <maml:name>ValeAlertLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>StylePackage</maml:name> <maml:description> <maml:para>Use this parameter to specify any number of Vale style packages to use when linting prose. By default, no packages are included. This cmdlet includes an argument completer for well-known Vale packages, but you can use any valid style package.</maml:para> <maml:para>To use a local style package, specify the value as the path to the `.zip` archive containing it. The archive must have the same name as the style. The path can be relative to the new configuration file or absolute.</maml:para> <maml:para>To use a remote style package, specify the value as the url to the `.zip` archive containing it. The archive must have the same name as the style.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specify whether the cmdlet should replace an existing configuration file if one exists at the same path. By default, the cmdlet throws an exception when the configuration file already exists.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoSpelling</maml:name> <maml:description> <maml:para>Use this parameter to prevent the configuration from including Vale's built-in spell checking. By default, new configurations use Vale to check spelling.</maml:para> <maml:para>If you use this parameter, you must also use the StylePackage parameter to specify one or more style packages to include in the configuration. Vale won't work without at least one style when spelling is disabled.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoSync</maml:name> <maml:description> <maml:para>Use this parameter to avoid immediately syncing the specified style packages. By default, this cmdlet sync the newly created configuration so it can be used immediately. Most Vale commands fail when a configuration hasn't been synced.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Use this parameter to specify that this cmdlet should return the created configuration file as a System.IO.FileInfo object. By default, this cmdlet returns no output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Specify the path to the configuration file to create. By default, the cmdlet creates the `.vale.ini` file in the current working directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specify whether the cmdlet should replace an existing configuration file if one exists at the same path. By default, the cmdlet throws an exception when the configuration file already exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>MinimumAlertLevel</maml:name> <maml:description> <maml:para>Specify the minimum alert level for the configuration file. This affects whether Vale ignores any rules. The default value is `Suggestion`, which ensures all violations are reported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ValeAlertLevel</command:parameterValue> <dev:type> <maml:name>ValeAlertLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoSpelling</maml:name> <maml:description> <maml:para>Use this parameter to prevent the configuration from including Vale's built-in spell checking. By default, new configurations use Vale to check spelling.</maml:para> <maml:para>If you use this parameter, you must also use the StylePackage parameter to specify one or more style packages to include in the configuration. Vale won't work without at least one style when spelling is disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoSync</maml:name> <maml:description> <maml:para>Use this parameter to avoid immediately syncing the specified style packages. By default, this cmdlet sync the newly created configuration so it can be used immediately. Most Vale commands fail when a configuration hasn't been synced.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Use this parameter to specify that this cmdlet should return the created configuration file as a System.IO.FileInfo object. By default, this cmdlet returns no output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>StylePackage</maml:name> <maml:description> <maml:para>Use this parameter to specify any number of Vale style packages to use when linting prose. By default, no packages are included. This cmdlet includes an argument completer for well-known Vale packages, but you can use any valid style package.</maml:para> <maml:para>To use a local style package, specify the value as the path to the `.zip` archive containing it. The archive must have the same name as the style. The path can be relative to the new configuration file or absolute.</maml:para> <maml:para>To use a remote style package, specify the value as the url to the `.zip` archive containing it. The archive must have the same name as the style.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>StylesPath</maml:name> <maml:description> <maml:para>Specify the folder for Vale to store the style packages. The default value is the `styles` folder in the same directory as the configuration file. If this value is a relative path, the path is relative to the configuration file, not the current working directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet doesn't support any pipeline input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>By default, this cmdlet returns no output.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.IO.FileSystemInfo</maml:name> </dev:type> <maml:description> <maml:para>If the PassThru parameter is specified, the cmdlet returns the FileInfo for the created configuration file.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: Create a basic Vale configuration ---------</maml:title> <dev:code>New-ValeConfiguration -StylesPath '.vscode/styles' -StylePackage Microsoft Get-Content -Path ./.vale.ini Get-ValeStyle Packages=Microsoft StylesPath=.vscode/styles MinAlertLevel=suggestion [*] BasedOnStyles=Vale, Microsoft Name Path Rules ---- ---- ----- Microsoft C:\code\temp\.vscode\styles\Microsoft {Accessibility, Acronyms, Adverbs, AMPM…}</dev:code> <dev:remarks> <maml:para>The output from `Get-ValeStyle` shows that the `Microsoft` style has been synced and can be used.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/vale/reference/cmdlets/new-valeconfiguration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Sync-Vale</command:name> <command:verb>Sync</command:verb> <command:noun>Vale</command:noun> <maml:description> <maml:para>Installs or updates the Vale style packages for a configuration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Sync-Vale` cmdlet installs or updates the Vale style packages for a configuration. If the style packages don't exist in the configured style path, the cmdlet installs them there. If the style packages exist, the cmdlet updates them if needed.</maml:para> <maml:para>By default, this cmdlet synchronizes the `.vale.ini` configuration file in the current working directory.</maml:para> <maml:para>You can use the Path parameter to install or update the Vale style packages for a configuration in a different folder or with a different name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Sync-Vale</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the path to a Vale configuration file. If this parameter isn't specified, Vale looks for the `.vale.ini` configuration file from the current working directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the path to a Vale configuration file. If this parameter isn't specified, Vale looks for the `.vale.ini` configuration file from the current working directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet doesn't support any pipeline input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet doesn't return any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------------- Example 1: Sync style packages ----------------</maml:title> <dev:code>Sync-Vale</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/vale/reference/cmdlets/sync-vale</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-Prose</command:name> <command:verb>Test</command:verb> <command:noun>Prose</command:noun> <maml:description> <maml:para>Test a document's prose with Vale rules.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet tests a document's prose with configured Vale rules, returning an object for style rule violation. The returned object includes detailed information about where and how the document violated a style rule.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-Prose</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the path to one or more files or folders to test. If the value is a folder, the cmdlet tests every Markdown file in that folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ConfigurationPath</maml:name> <maml:description> <maml:para>Specify the path to a Vale configuration file---typically `.vale.ini`---to use for the tests. By default, Vale infers the configuration based on current working directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ConfigurationPath</maml:name> <maml:description> <maml:para>Specify the path to a Vale configuration file---typically `.vale.ini`---to use for the tests. By default, Vale infers the configuration based on current working directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the path to one or more files or folders to test. If the value is a folder, the cmdlet tests every Markdown file in that folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet doesn't support any pipeline input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ValeViolation</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns a ValeViolation representing each rule violation for a document's prose.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------- Example 1: Test a specific document -------------</maml:title> <dev:code>Test-Prose -Path ./README.md -pwsh-list Action : @{Name=; Params=} Span : {18, 20} Check : Microsoft.Acronyms Description : Link : https://docs.microsoft.com/en-us/style-guide/acronyms Message : 'MIT' has no definition. Severity : suggestion Match : MIT Line : 10 FileInfo : C:\code\pwsh\Documentarian\README.md Action : @{Name=replace; Params=System.Object[]} Span : {5, 11} Check : Microsoft.ComplexWords Description : Link : https://docs.microsoft.com/en-us/style-guide/word-choice/ use-simple-words-concise-sentences Message : Consider using 'give' or 'offer' instead of 'provide'. Severity : suggestion Match : provide Line : 25 FileInfo : C:\code\pwsh\Documentarian\README.md</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------- Example 2: Test a folder -------------------</maml:title> <dev:code>Test-Prose -Path ./reference/cmdlets/ -pwsh-table Count Name ----- ---- 4 C:\Documentarian\Documentation\reference\cmdlets\Convert-MDLinks.md 2 C:\Documentarian\Documentation\reference\cmdlets\Get-ContentWithoutHeader.md 2 C:\Documentarian\Documentation\reference\cmdlets\Get-Document.md 15 C:\Documentarian\Documentation\reference\cmdlets\Get-DocumentLink.md 2 C:\Documentarian\Documentation\reference\cmdlets\Get-Metadata.md 3 C:\Documentarian\Documentation\reference\cmdlets\Remove-Metadata.md 2 C:\Documentarian\Documentation\reference\cmdlets\Set-Metadata.md 2 C:\Documentarian\Documentation\reference\cmdlets\Update-Metadata.md</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/vale/reference/cmdlets/test-prose</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |