Replies: 1 comment 4 replies
-
|
Maybe -- do you have some examples of specific clippy output that you think should be included and/or links I can follow? Technically there are few limitations to be aware of:
Ideally I would like to figure out if we can map the additional information you mentioned into a standardized SARIF field, which has a standard display style, because I would like |
Beta Was this translation helpful? Give feedback.
-
|
Hi, I added a simple example to my original post. Maybe I wasn't quite clear what exactly I am asking. I would prefer to always print the clippy output to the terminal and collect the SARIF only for the code scanning alerts from GitHub. Ideally, I can achieve that with a single execution of clippy, by enabling JSON output of cargo, printing the rendered error message and simultaneously generating the SARIF report. |
Beta Was this translation helpful? Give feedback.
-
|
Hi, thanks for the additional info - I think I understand what you're looking for - I'll also take a look into why some the information is missing. Meanwhile, if I understand correctly, you're looking for something like this? cargo clippy --all-targets --all-features --message-format=json-diagnostic-rendered-ansi | tee >(cat | jq -r '. | select(.message.rendered != null) .message.rendered' > /dev/tty) | clippy-sarif | tee results.sarif | sarif-fmtOn my small test, this gives the following: The first half being from |
Beta Was this translation helpful? Give feedback.
-
|
Yes, that is what I have in mind. Instead of the |
Beta Was this translation helpful? Give feedback.
-
|
Makes sense to me, i'll try to put something together when I have some time. |
Beta Was this translation helpful? Give feedback.
-
cargohas the option to include the original error message into its output JSON. The error message can even contain all ANSI codes for proper formatting. The option to do so is--message-format=json-diagnostic-rendered-ansi. The output ofsarif-fmtlooks good, but sometimes the original error has further details.Would it be possible to teach
clippy-sarifto output these pre-formatted error on stderr and writing the SARIF to stdout?Then this command
cargo clippy --all-targets --all-features --message-format=json | clippy-sarif | tee results.sarif | sarif-fmtcould be changed tocargo clippy --all-targets --all-features --message-format=json-diagnostic-rendered-ansi | clippy-sarif >results.sarif.Example
Code
clippy prints the note about
macro-backtraceand a hint about thetodo!()line as the cause.clippy-sarif/sarif-fmt seems to have a problem with macros.
Clippy JSON
{ "reason": "compiler-message", "package_id": "abc 0.1.0 (path+file:///tmp/abc)", "manifest_path": "/tmp/abc/Cargo.toml", "target": { "kind": [ "bin" ], "crate_types": [ "bin" ], "name": "abc", "src_path": "/tmp/abc/src/main.rs", "edition": "2021", "doc": true, "doctest": false, "test": true }, "message": { "rendered": "warning: unreachable statement\n --> src/main.rs:3:5\n |\n2 | todo!();\n | ------- any code following this expression is unreachable\n3 | println!(\"Hello, world!\");\n | ^^^^^^^^^^^^^^^^^^^^^^^^^ unreachable statement\n |\n = note: `#[warn(unreachable_code)]` on by default\n = note: this warning originates in the macro `println` (in Nightly builds, run with -Z macro-backtrace for more info)\n\n", "children": [ { "children": [], "code": null, "level": "note", "message": "`#[warn(unreachable_code)]` on by default", "rendered": null, "spans": [] } ], "code": { "code": "unreachable_code", "explanation": null }, "level": "warning", "message": "unreachable statement", "spans": [ { "byte_end": 2841, "byte_start": 2771, "column_end": 6, "column_start": 23, "expansion": { "def_site_span": { "byte_end": 2844, "byte_start": 2692, "column_end": 2, "column_start": 1, "expansion": null, "file_name": "/rustc/22e491ac7ed454d34669151a8b6464cb643c9b41/library/std/src/macros.rs", "is_primary": false, "label": null, "line_end": 99, "line_start": 94, "suggested_replacement": null, "suggestion_applicability": null, "text": [ { "highlight_end": 1, "highlight_start": 1, "text": "macro_rules! println {" }, { "highlight_end": 1, "highlight_start": 1, "text": " () => ($crate::print!(\"\\n\"));" }, { "highlight_end": 1, "highlight_start": 1, "text": " ($($arg:tt)*) => ({" }, { "highlight_end": 1, "highlight_start": 1, "text": " $crate::io::_print($crate::format_args_nl!($($arg)*));" }, { "highlight_end": 1, "highlight_start": 1, "text": " })" }, { "highlight_end": 2, "highlight_start": 1, "text": "}" } ] }, "macro_decl_name": "println!", "span": { "byte_end": 54, "byte_start": 29, "column_end": 30, "column_start": 5, "expansion": null, "file_name": "src/main.rs", "is_primary": false, "label": null, "line_end": 3, "line_start": 3, "suggested_replacement": null, "suggestion_applicability": null, "text": [ { "highlight_end": 30, "highlight_start": 5, "text": " println!(\"Hello, world!\");" } ] } }, "file_name": "/rustc/22e491ac7ed454d34669151a8b6464cb643c9b41/library/std/src/macros.rs", "is_primary": true, "label": "unreachable statement", "line_end": 98, "line_start": 96, "suggested_replacement": null, "suggestion_applicability": null, "text": [ { "highlight_end": 24, "highlight_start": 23, "text": " ($($arg:tt)*) => ({" }, { "highlight_end": 63, "highlight_start": 1, "text": " $crate::io::_print($crate::format_args_nl!($($arg)*));" }, { "highlight_end": 6, "highlight_start": 1, "text": " })" } ] }, { "byte_end": 24992, "byte_start": 24945, "column_end": 59, "column_start": 12, "expansion": { "def_site_span": { "byte_end": 25094, "byte_start": 24914, "column_end": 2, "column_start": 1, "expansion": null, "file_name": "/rustc/22e491ac7ed454d34669151a8b6464cb643c9b41/library/core/src/macros/mod.rs", "is_primary": false, "label": null, "line_end": 744, "line_start": 741, "suggested_replacement": null, "suggestion_applicability": null, "text": [ { "highlight_end": 1, "highlight_start": 1, "text": "macro_rules! todo {" }, { "highlight_end": 1, "highlight_start": 1, "text": " () => ($crate::panicking::panic(\"not yet implemented\"));" }, { "highlight_end": 1, "highlight_start": 1, "text": " ($($arg:tt)+) => ($crate::panic!(\"not yet implemented: {}\", $crate::format_args!($($arg)+)));" }, { "highlight_end": 2, "highlight_start": 1, "text": "}" } ] }, "macro_decl_name": "todo!", "span": { "byte_end": 23, "byte_start": 16, "column_end": 12, "column_start": 5, "expansion": null, "file_name": "src/main.rs", "is_primary": false, "label": null, "line_end": 2, "line_start": 2, "suggested_replacement": null, "suggestion_applicability": null, "text": [ { "highlight_end": 12, "highlight_start": 5, "text": " todo!();" } ] } }, "file_name": "/rustc/22e491ac7ed454d34669151a8b6464cb643c9b41/library/core/src/macros/mod.rs", "is_primary": false, "label": "any code following this expression is unreachable", "line_end": 742, "line_start": 742, "suggested_replacement": null, "suggestion_applicability": null, "text": [ { "highlight_end": 59, "highlight_start": 12, "text": " () => ($crate::panicking::panic(\"not yet implemented\"));" } ] } ] } } { "reason": "compiler-message", "package_id": "abc 0.1.0 (path+file:///tmp/abc)", "manifest_path": "/tmp/abc/Cargo.toml", "target": { "kind": [ "bin" ], "crate_types": [ "bin" ], "name": "abc", "src_path": "/tmp/abc/src/main.rs", "edition": "2021", "doc": true, "doctest": false, "test": true }, "message": { "rendered": "warning: 1 warning emitted\n\n", "children": [], "code": null, "level": "warning", "message": "1 warning emitted", "spans": [] } } { "reason": "compiler-artifact", "package_id": "abc 0.1.0 (path+file:///tmp/abc)", "manifest_path": "/tmp/abc/Cargo.toml", "target": { "kind": [ "bin" ], "crate_types": [ "bin" ], "name": "abc", "src_path": "/tmp/abc/src/main.rs", "edition": "2021", "doc": true, "doctest": false, "test": true }, "profile": { "opt_level": "0", "debuginfo": 2, "debug_assertions": true, "overflow_checks": true, "test": false }, "features": [], "filenames": [ "/tmp/abc/target/debug/deps/libabc-db949bcf713f8f0a.rmeta" ], "executable": null, "fresh": true } { "reason": "build-finished", "success": true }Sarif
{ "$schema": "https://schemastore.azurewebsites.net/schemas/json/sarif-2.1.0-rtm.5.json", "runs": [ { "results": [ { "level": "warning", "locations": [ { "physicalLocation": { "artifactLocation": { "uri": "/rustc/22e491ac7ed454d34669151a8b6464cb643c9b41/library/std/src/macros.rs" }, "region": { "byteLength": 70, "byteOffset": 2771, "endColumn": 6, "endLine": 98, "startColumn": 23, "startLine": 96 } } } ], "message": { "text": "unreachable statement" }, "ruleId": "unreachable_code", "ruleIndex": 0 }, { "level": "warning", "locations": [ { "physicalLocation": { "artifactLocation": { "uri": "/rustc/22e491ac7ed454d34669151a8b6464cb643c9b41/library/core/src/macros/mod.rs" }, "region": { "byteLength": 47, "byteOffset": 24945, "endColumn": 59, "endLine": 742, "startColumn": 12, "startLine": 742 } } } ], "message": { "text": "unreachable statement" }, "ruleId": "unreachable_code", "ruleIndex": 0 } ], "tool": { "driver": { "informationUri": "https://rust-lang.github.io/rust-clippy/", "name": "clippy", "rules": [ { "fullDescription": { "text": "`#[warn(unreachable_code)]` on by default\n" }, "id": "unreachable_code" } ] } } } ], "version": "2.1.0" }Beta Was this translation helpful? Give feedback.
All reactions