Generating extended Vale alerts reports
Consider generating extended Vale alerts reports about a Git repository to:
-
Measure language compliance in a repository
-
Gather data before Defining a Vale onboarding strategy
These reports use the Vale report in JSON format and additional information such as the word count.
On bigger repositories, with more than 1000000 words, consider building your own reporting tool to chunk the task in smaller pieces.
-
The
valetool is installed and configured. See Installing Vale. -
The
jqtool is installed. See Downloadingjq.
-
Generate vale alerts reports for <location>:
$ ./tools/vale_report.sh <location> -
The script creates following files for each Git repository found at <location>:
vale-report_<repository>_-list.log-
List of AsciiDoc files considered for the report.
vale-report_<repository>_-wordcount.log-
Word count for all files in the file list. Use this information to compare the number of alerts between repositories.
vale-report_<repository>_.json-
Vale report in JSON format. Use the
jqtool to query the results. vale-report_<repository>_.severity-
Breakdown of alerts by severity.
vale-report_<repository>_.rules-
Breakdown of alerts by rules.
vale-report_<repository>_.Spelling.txt-
Breakdown of
Spellingalerts.