Skip to content

Commit 5bdb520

Browse files
doc: add output format doc
1 parent 1f1cf7f commit 5bdb520

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

website/reference/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ ast-grep scan [OPTIONS] [PATHS]...
6969
| | --report-style `<REPORT_STYLE>` | [default: rich] [possible values: rich, medium, short]
7070
| | --follow | Follow symbolic links |
7171
| | --json`[=<STYLE>]` | Output matches in structured JSON [possible values: pretty, stream, compact] |
72-
| | --format `<FORMAT>` | Output warning/error messages in GitHub Action format [possible values: github] |
72+
| | --format `<FORMAT>` | Output warning/error messages in different formats [possible values: github, sarif] |
7373
| -U | --update-all | Apply all rewrite without confirmation |
7474
| | --no-ignore `<NO_IGNORE>` | Do not respect ignore files. (.gitignore, .ignore, etc.) [possible values: hidden, dot, exclude, global, parent, vcs] |
7575
| | --stdin | Enable search code from StdIn. See [link](/guide/tooling-overview.html#enable-stdin-mode) |

website/reference/cli/scan.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,11 +129,11 @@ Possible values:
129129
- **entity**: Show per-file/per-rule tracing information
130130

131131
### `--format <FORMAT>`
132-
Output warning/error messages in GitHub Action format.
132+
Output warning/error messages in different formats.
133133

134-
Currently, only GitHub is supported.
134+
Supported formats: GitHub Action, [SARIF](https://sarifweb.azurewebsites.net/) (Static Analysis Results Interchange Format).
135135

136-
[possible values: github]
136+
[possible values: github, sarif]
137137

138138
## Context Options
139139

0 commit comments

Comments
 (0)