Skip to content

Commit

Permalink
Added documentation for configuration parameter.
Browse files Browse the repository at this point in the history
  • Loading branch information
@satyamchaurasia
satyamchaurasia committed Dec 11, 2024
1 parent fd020ca commit 9141b37
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/Configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -995,9 +995,10 @@ sarif:
| Configuration | Default | Description |
|------------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `hassnippet` | false | In Checkmarx CX-Flow, when the hasSnippet flag is set to true, the tool displays relevant code snippets under the "Region" section of the UI. These snippets provide a portion of the code where potential vulnerabilities are detected, giving developers context to better understand the issue. This feature helps in identifying the exact location of security concerns, streamlining the remediation process by offering precise, actionable insights directly within the code. |
| `enableTextNHelpSame` |false | In Checkmarx CX-Flow, when the enableTextNHelpSame flag is set to true, sarif report will have same value in help and text under rules section. |
| `enableTextNHelpSame` | false | In Checkmarx CX-Flow, when the enableTextNHelpSame flag is set to true, sarif report will have same value in help and text under rules section. |
| `enableOriginalUriBaseIds` | false | In Checkmarx CX-Flow, when the enableOriginalUriBaseIds flag is set to true, Sarif report will have modules details scanned in project. |
| `srcRootPath` | %SRCROOT% | In Checkmarx CX-Flow, when the srcRootPath has value, It will display same root path in report. |
| `sourceNodefound` | false | In Checkmarx CX-Flow, if the source node is not found at node 1, it will search for the next lowest node, alternatively node 1, if this boolean variable is set to true. |

**Note**: Command line parameter for snippet is `--sarif.hassnippet=true`

Expand Down

0 comments on commit 9141b37

Please sign in to comment.