Skip to content

Plugin Options

Properties

Name Type Description Required
formatters object Configuration for different report formatters
sortReportsBy string How report findings are grouped (rule, endpoint, or severity). Normally set from the –sort-reports-by CLI flag; affects the markdown formatter only.
Enum: "rule", "endpoint", "severity"
reportsDir string Base directory report output is written under. A relative path resolves against the run working directory, an absolute one is used as-is. Defaults to .thymian/reports. Every report gets its own directory beneath it, named -, holding one report. per configured formatter — so consecutive runs never overwrite each other and every format of one run stays together. CI should glob /*/report..
Minimal Length: 1
Pattern: \S

Additional Properties: not allowed 
Example

{
"formatters": {
"markdown": {},
"csv": {},
"json": {}
}
}

formatters: object

Properties

Name Type Description Required
markdown object Configuration for the Markdown formatter
csv object Configuration for the CSV formatter
json object Configuration for the JSON formatter, which writes the canonical report payload for machine consumption

Additional Properties: not allowed 
Example

{
"markdown": {},
"csv": {},
"json": {}
}

formatters.csv: object

No properties.

Additional Properties: not allowed 

formatters.json: object

No properties.

Additional Properties: not allowed 

formatters.markdown: object

No properties.

Additional Properties: not allowed