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" |
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
Properties
| Name | Type | Description | Required |
|---|---|---|---|
| path | string |
File path where the CSV report will be saved |
Additional Properties: not allowed
formatters.json: object
Properties
| Name | Type | Description | Required |
|---|---|---|---|
| path | string |
File path where the JSON report will be saved |
Additional Properties: not allowed
formatters.markdown: object
Properties
| Name | Type | Description | Required |
|---|---|---|---|
| path | string |
File path where the markdown report will be saved |
Additional Properties: not allowed