summaryrefslogtreecommitdiff
path: root/doc/.vale/vale-json.tmpl
diff options
context:
space:
mode:
Diffstat (limited to 'doc/.vale/vale-json.tmpl')
-rw-r--r--doc/.vale/vale-json.tmpl58
1 files changed, 58 insertions, 0 deletions
diff --git a/doc/.vale/vale-json.tmpl b/doc/.vale/vale-json.tmpl
new file mode 100644
index 00000000000..ed3c3259df3
--- /dev/null
+++ b/doc/.vale/vale-json.tmpl
@@ -0,0 +1,58 @@
+{{- /* Modify Vale's output https://docs.errata.ai/vale/cli#--output */ -}}
+
+{{- /* Keep track of our various counts */ -}}
+
+{{- $e := 0 -}}
+{{- $w := 0 -}}
+{{- $s := 0 -}}
+{{- $f := 0 -}}
+
+{{- /* Range over the linted files */ -}}
+
+{{- range .Files}}
+
+{{- $f = add1 $f -}}
+{{- $path := .Path -}}
+
+{{- /* Range over the file's alerts */ -}}
+[
+
+{{- range $idx, $a := .Alerts -}}
+
+{{- $error := "" -}}
+{{- if eq .Severity "error" -}}
+ {{- $error = .Severity -}}
+ {{- $e = add1 $e -}}
+{{- else if eq .Severity "warning" -}}
+ {{- $error = .Severity -}}
+ {{- $w = add1 $w -}}
+{{- else -}}
+ {{- $error = .Severity -}}
+ {{- $s = add1 $s -}}
+{{- end}}
+
+{{- /* Variables setup */ -}}
+
+{{- $path = $path -}}
+{{- $loc := printf "%d" .Line -}}
+{{- $check := printf "%s" .Check -}}
+{{- $message := printf "%s" .Message -}}
+{{- $link := printf "%s" .Link -}}
+{{- if $idx -}},{{- end -}}
+
+{{- /* Output */ -}}
+
+ {
+ "description": "{{ $message }}",
+ "fingerprint": "{{ $path }}-{{ $loc }}",
+ "severity": "{{ $error }}",
+ "location": {
+ "path": "{{ $path }}",
+ "lines": {
+ "begin": {{ $loc }}
+ }
+ }
+ }
+{{end -}}
+{{end -}}
+]