Improving the Static Code Analysis Report - Githubissues

ballerina-platform / static-code-analysis-tool

Tool for performing static code analysis for Ballerina projects.

Apache License 2.0

3 stars 5 forks source link

Improving the Static Code Analysis Report #17

Open Xenowa opened 5 months ago

Xenowa commented 5 months ago

Description:

Currently, the scan report does not use any library to format and display the contents of the Ballerina file in its UI, It's better to integrate a library like Shiki that is dedicated to perform syntax highlighting operations of code content.

It's better to display the Ballerina project version alongside the project name in the scan report.

It's better to replace the back arrow icon with a hyperlink that navigates back to the main page when user clicks on the file name, similar to the testerina report.

Currently the analysis report only shows the Ballerina files in the project that has had at least one analysis issue found, it would be ideal to display all analyzed files in the Ballerina project regardless whether it has analysis issues or not.

MohamedSabthar commented 3 weeks ago

Currently, the report only shows a simple description. Ideally, we should provide more details on what this issue is and how to resolve it.

Screenshot 2024-11-06 at 13 15 59

We should consider adding additional fields to the structure of result.json to include these details.