Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add convenient commands for vim and sarif #28

Merged
merged 5 commits into from
Apr 2, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions content/docs/static-analysis/semgrep/00-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,9 +211,18 @@ according to your preferences and tooling.
- **SARIF format**: Use the SARIF format with the Visual Studio Code and the
[SARIF Explorer](https://marketplace.visualstudio.com/items?itemName=trailofbits.sarif-explorer) extension.
This makes it easy to review the analysis results and drill down into specific issues to understand their
impact and severity.
impact and severity. Example usage of the `p/default` ruleset with the SARIF output format:

```sh
semgrep -c p/default --sarif --output scan_results.sarif
```

- **VIM format**: Use the VIM format to have all the information about a finding in a single line, making it
convenient for users of the Vim text editor.
convenient for users of the Vim text editor. Example usage of the `p/default` ruleset with the VIM output format:

```sh
semgrep -c p/default --vim --output scan_results.vim
```

c. Filtering and limiting results:
- Use the `--severity [INFO|WARNING|ERROR]` flag to report findings only from rules that match
Expand Down
Loading