feat: added a new option: --no-markdown for sarif output #2630
Conversation
|
saark-snyk
force-pushed
the
feat/no-markdown
branch
from
6220088
to
f3deee8
Compare
src/lib/plugins/sast/index.ts
Outdated
| if (options.sarif || options.json) { | ||
| if (numOfIssues > 0) { | ||
| if (options['no-markdown']) { | ||
| sarifTypedResult.runs?.[0].results?.forEach((result) => { | ||
| result.message = omit(result.message, ['markdown']); |
There was a problem hiding this comment.
Apparently omit is not great for performance... Would it be better to just use either delete or object spread? I'm aware that this code will only be run if no-markdown is passed.
src/lib/plugins/sast/index.ts
Outdated
| if (options.sarif || options.json) { | ||
| if (numOfIssues > 0) { | ||
| if (options['no-markdown']) { | ||
| sarifTypedResult.runs?.[0].results?.forEach((result) => { | ||
| result.message = omit(result.message, ['markdown']); |
There was a problem hiding this comment.
Would be better not to use lodash here. You could call delete since you're modifying in place anyway.
@robcresswell something like that, all the details in the PR description. (I share the same opinion) |
help/cli-commands/code.md
Outdated
| @@ -53,6 +53,10 @@ Print results in JSON format. | |||
|
|
|||
| Return results in SARIF format. | |||
|
|
|||
| ## `--no-markdown` | |||
|
|
|||
| Should be used when using `--sarif`. Will remove the `markdown` field from the `result.message` object. Might help if parsing `arguments` is not working properly. | |||
There was a problem hiding this comment.
Docs should be written in active voice.
Also, I'm not sure about the "Might help if" part, but up to you.
| Should be used when using `--sarif`. Will remove the `markdown` field from the `result.message` object. Might help if parsing `arguments` is not working properly. | |
| Removes the `markdown` field from the `result.message` object. Should be used when using `--sarif`. |
What does this PR do?
Adding a new flag to options,
--no-markdown, which removes themarkdownproperty fromresult.messagewhen usingsarifoutput.How should this be manually tested?
snyk code test --sarif --no-markdownAny background context you want to provide?
Slack discussion: https://snyk.slack.com/archives/C01U14WSN73/p1642928960104800
What are the relevant tickets?
This is a result of a support ticket: https://snyk.zendesk.com/agent/tickets/18450