Collating Vale output
You can use a template to collate the results from running vale
on the command line. This collated output is non-repetitive and might be easier to use.
The RedHat
style includes a collate-output.tmpl
template you can specify when you run the vale
command. For example:
$ cd openshift-docs/ $ vale --output='.vale/styles/RedHat/collate-output.tmpl' modules/about-crio.adoc
The resulting command output collates any repetitive the suggestions, warnings, or errors.
vale
output from the collate-output.tmpl
templatemodules/about-crio.adoc 7:9,11:107 suggestion Define acronyms and RedHat.Definitions abbreviations (such as 'CRI') on first occurrence if they're likely to be unfamiliar. 0 errors, 0 warnings and 2 suggestions in 1 file.
When you use the |
Understanding the vale
output
- First column
-
A comma-separated list of each instance where the issue appears:
7:9,11:107
. - Second column
-
The alert level, such as
error
,suggestion
, orwarning
. See: Understanding Vale alert levels - Third column
-
The rule message, such as:
Define acronyms and abbreviations (such as 'CRI') on first occurrence if they’re likely to be unfamiliar.
- Fourth column
-
The name of the style and rule, such as:
RedHat.Definitions
.