AdaCore / ada_language_server

Server implementing the Microsoft Language Protocol for Ada and SPARK
GNU General Public License v3.0
233 stars 55 forks source link

[Bug]: there's no documentation on what is Sarif and why it is included #1208

Open mgrojo opened 2 weeks ago

mgrojo commented 2 weeks ago

Environment

Bug Summary and Reproducer

Bug Summary:

There's no mention of SARIF Viewer and how it is useful in the documentation.

Steps to reproduce:

When you open VS Code with a GitHub project, there is a notification asking you to connect to GitHub to display scanning results.

imagen

Expected behavior:

Documentation improved to mention what is SARIF Viewer and how can the user take advantage of it.

Configuration and Logs

Sarif Viewer output:

Connect to GitHub Code Scanning: prompt.
updateDiags /.vscode/settings.json. 0 Results.

updateDiags vscode-scm:git/scm0/input?rootUri%3Dfile%253A%252F%252F%252Fhome%252Fmgr%252Fsrc%252Fgithub%252Fmgrojo%252Fcoap_spark. 0 Results.

Repository name with owner: mgrojo/coap_spark.
Eligible to connect to GitHub Code Scanning.
updateDiags vscode-scm:git/scm1/input?rootUri%3Dfile%253A%252F%252F%252Fhome%252Fmgr%252Fsrc%252Fgithub%252Fmgrojo%252Fcoap_spark%252Ftools%252FRecordFlux. 0 Results.

Other VS Code Extensions

No response

Additional context

No response

AnthonyLeonardoGracio commented 1 week ago

Hello,

We package the SARIF Viewer extension to display results from GNAT SAS, a static analysis tool that we integrate.

We will add some documentation about it.

Regards,