[COMPARISION] shellcheck-sarif/sarif-fmt 🆚 csgrep
#137
Comments
jamacku
changed the title
shellcheck-sarif/sarif/fmt 🆚 csgrepshellcheck-sarif/sarif-fmt 🆚 csgrep
|
The rules generated by |
|
@lzaoral We already provide help text to be shown by GitHub:
Do we have any other information to put into |
|
Yes, I know. But according to the documentation above, everything from this list:
|
|
@kdudka Would it make sense to use JSON output instead of the the GCC format of ShellCheck in OSH? |
|
That could be difficult because we use |
|
Actually, we use |
|
Thanks to csutils/csmock#182, csmock and consequently OSH now use ShellCheck with the JSON output format only. |
This is not an actual issue in csdiff. I will demonstrate the differences between
sarif-rsutilities (soon available in Fedora) andcsutils.The main purpose of this issue is to show how other tools deal with the over-complicated specification of the SARIF format. And maybe get some inspiration for new features or enhancements.
Shell
shellcheck --format=json1 src/index.sh | csgrep --mode=sarifgenerated SARIF
{ "$schema": "https://json.schemastore.org/sarif-2.1.0.json", "version": "2.1.0", "runs": [ { "tool": { "driver": { "name": "csdiff", "version": "3.0.3", "informationUri": "https://github.com/csutils/csdiff", "rules": [ { "id": "SHELLCHECK_WARNING: error[SC1058]", "name": "SC1058", "properties": { "tags": [ "ShellCheck" ] }, "help": { "text": "Defect reference: https://github.com/koalaman/shellcheck/wiki/SC1058", "markdown": "Defect reference: [SC1058](https://github.com/koalaman/shellcheck/wiki/SC1058)" } }, { "id": "SHELLCHECK_WARNING: error[SC1072]", "name": "SC1072", "properties": { "tags": [ "ShellCheck" ] }, "help": { "text": "Defect reference: https://github.com/koalaman/shellcheck/wiki/SC1072", "markdown": "Defect reference: [SC1072](https://github.com/koalaman/shellcheck/wiki/SC1072)" } }, { "id": "SHELLCHECK_WARNING: error[SC1073]", "name": "SC1073", "properties": { "tags": [ "ShellCheck" ] }, "help": { "text": "Defect reference: https://github.com/koalaman/shellcheck/wiki/SC1073", "markdown": "Defect reference: [SC1073](https://github.com/koalaman/shellcheck/wiki/SC1073)" } } ] } }, "results": [ { "ruleId": "SHELLCHECK_WARNING: error[SC1073]", "level": "error", "locations": [ { "id": 0, "physicalLocation": { "artifactLocation": { "uri": "shell.sh" }, "region": { "startLine": 5 } } } ], "message": { "text": "Couldn't parse this for loop. Fix to allow more checks." }, "codeFlows": [ { "threadFlows": [ { "locations": [ { "location": { "id": 0, "physicalLocation": { "artifactLocation": { "uri": "shell.sh" }, "region": { "startLine": 5 } }, "message": { "text": "Couldn't parse this for loop. Fix to allow more checks." } }, "nestingLevel": 0, "kinds": [ "error[SC1073]" ] } ] } ] } ] }, { "ruleId": "SHELLCHECK_WARNING: error[SC1058]", "level": "error", "locations": [ { "id": 0, "physicalLocation": { "artifactLocation": { "uri": "shell.sh" }, "region": { "startLine": 6 } } } ], "message": { "text": "Expected 'do'." }, "codeFlows": [ { "threadFlows": [ { "locations": [ { "location": { "id": 0, "physicalLocation": { "artifactLocation": { "uri": "shell.sh" }, "region": { "startLine": 6 } }, "message": { "text": "Expected 'do'." } }, "nestingLevel": 0, "kinds": [ "error[SC1058]" ] } ] } ] } ] }, { "ruleId": "SHELLCHECK_WARNING: error[SC1072]", "level": "error", "locations": [ { "id": 0, "physicalLocation": { "artifactLocation": { "uri": "shell.sh" }, "region": { "startLine": 6 } } } ], "message": { "text": "Expected 'do'. Fix any mentioned problems and try again." }, "codeFlows": [ { "threadFlows": [ { "locations": [ { "location": { "id": 0, "physicalLocation": { "artifactLocation": { "uri": "shell.sh" }, "region": { "startLine": 6 } }, "message": { "text": "Expected 'do'. Fix any mentioned problems and try again." } }, "nestingLevel": 0, "kinds": [ "error[SC1072]" ] } ] } ] } ] } ] } ] }shellcheck --format=json shell.sh | shellcheck-sarifgenerated SARIF
{ "runs": [ { "results": [ { "fixes": [], "level": "error", "locations": [ { "physicalLocation": { "artifactLocation": { "uri": "shell.sh" }, "region": { "endColumn": 1, "endLine": 5, "startColumn": 1, "startLine": 5 } } } ], "message": { "text": "Couldn't parse this for loop. Fix to allow more checks." }, "relatedLocations": [], "ruleId": "1073", "ruleIndex": 0 }, { "fixes": [], "level": "error", "locations": [ { "physicalLocation": { "artifactLocation": { "uri": "shell.sh" }, "region": { "endColumn": 1, "endLine": 6, "startColumn": 1, "startLine": 6 } } } ], "message": { "text": "Expected 'do'." }, "relatedLocations": [], "ruleId": "1058", "ruleIndex": 1 }, { "fixes": [], "level": "error", "locations": [ { "physicalLocation": { "artifactLocation": { "uri": "shell.sh" }, "region": { "endColumn": 1, "endLine": 6, "startColumn": 1, "startLine": 6 } } } ], "message": { "text": "Expected 'do'. Fix any mentioned problems and try again." }, "relatedLocations": [], "ruleId": "1072", "ruleIndex": 2 } ], "tool": { "driver": { "name": "shellcheck", "rules": [ { "fullDescription": { "text": "For more information: https://www.shellcheck.net/wiki/SC1073" }, "id": "1073", "name": "1073", "shortDescription": { "text": "SC1073" } }, { "fullDescription": { "text": "For more information: https://www.shellcheck.net/wiki/SC1058" }, "id": "1058", "name": "1058", "shortDescription": { "text": "SC1058" } }, { "fullDescription": { "text": "For more information: https://www.shellcheck.net/wiki/SC1072" }, "id": "1072", "name": "1072", "shortDescription": { "text": "SC1072" } } ] } } } ], "version": "2.1.0" }Rust
Support for clippy is currently missing in
csutils, so this is only an example withsarif-rsutils.cargo clippy --message-format=json | clippy-sarif{ "$schema": "https://schemastore.azurewebsites.net/schemas/json/sarif-2.1.0-rtm.5.json", "runs": [ { "results": [ { "level": "error", "locations": [ { "physicalLocation": { "artifactLocation": { "uri": "src/main.rs" }, "region": { "byteLength": 14, "byteOffset": 53, "endColumn": 20, "endLine": 3, "startColumn": 6, "startLine": 3 } } } ], "message": { "text": "this comparison involving the minimum or maximum element for this type contains a case that is always true or always false" }, "ruleId": "clippy::absurd_extreme_comparisons", "ruleIndex": 0 }, { "level": "error", "locations": [ { "physicalLocation": { "artifactLocation": { "uri": "src/main.rs" }, "region": { "byteLength": 14, "byteOffset": 76, "endColumn": 20, "endLine": 4, "startColumn": 6, "startLine": 4 } } } ], "message": { "text": "this comparison involving the minimum or maximum element for this type contains a case that is always true or always false" }, "ruleId": "clippy::absurd_extreme_comparisons", "ruleIndex": 0 } ], "tool": { "driver": { "informationUri": "https://rust-lang.github.io/rust-clippy/", "name": "clippy", "rules": [ { "fullDescription": { "text": "because `0` is the minimum value for this type, the case where the two sides are not equal never occurs, consider using `vec.len() == 0` instead\nfor further information visit https://rust-lang.github.io/rust-clippy/master/index.html#absurd_extreme_comparisons\n`#[deny(clippy::absurd_extreme_comparisons)]` on by default\n" }, "id": "clippy::absurd_extreme_comparisons" } ] } } } ], "version": "2.1.0" }csgrep is able to parse SARIF format produced by
clippy-sarif.{ "defects": [ { "checker": "UNKNOWN_SARIF_WARNING", "tool": "unknown-sarif", "key_event_idx": 0, "events": [ { "file_name": "src/main.rs", "line": 3, "column": 6, "event": "error[clippy::absurd_extreme_comparisons]", "message": "this comparison involving the minimum or maximum element for this type contains a case that is always true or always false", "verbosity_level": 0 } ] }, { "checker": "UNKNOWN_SARIF_WARNING", "tool": "unknown-sarif", "key_event_idx": 0, "events": [ { "file_name": "src/main.rs", "line": 4, "column": 6, "event": "error[clippy::absurd_extreme_comparisons]", "message": "this comparison involving the minimum or maximum element for this type contains a case that is always true or always false", "verbosity_level": 0 } ] } ] }The text was updated successfully, but these errors were encountered: