Static code analysis upcoming tasks

[gayaldassanayake]

Description

The following tasks are to be completed for the scan tool with a higher priority.

Urgent

• Add scan rules and their documentation to the sonar-ballerina-plugin sonar-ballerina#12
• Improve the static code analysis tool documentation ballerina-dev-website#9804

Features

• Allow suppressing analysis in specific places #20
• Migrate sonar-ballerina-plugin to 2025.1 LTA sonar-ballerina#10 - LATER

Improvements

• Add a Public API to Engage the Scan Tool and Verify the Output #27
• Provide a way to auto extend the sonar ballerina rules when the rules are added to the scan tool sonar-ballerina#11

Bug fixes

• Ballerina version for static code analysis is picked from BALLERINA_HOME env variable #39
• Line numbers should exact same with the Ballerina file line numbers in Error tests in Static code analayzer #29

Version

No response

[gayaldassanayake]

Currently working on ballerina-platform/ballerina-dev-website#9804.

[gayaldassanayake]

Currently working on #27. The progress is updated in the issue.

[gayaldassanayake]

The Test API has been introduced with #56

This is useful for writing tests by directly testing at the Java API instead of asserting the CLI logs.

The related design document - https://docs.google.com/document/d/1JrfBg8zfejK1Lg6aNLGAtA_6tpQ8jukK6_njnoLGz4Q/edit?usp=sharing

[gayaldassanayake]

Started working on adding the sonar ballerina plugin documentation into the ballerina website scan-tool section. Reopened ballerina-platform/ballerina-dev-website#9804 to track the progress of it.

[gayaldassanayake]

Started working on ballerina-platform/sonar-ballerina#10. This is a prerequisite for ballerina-platform/ballerina-dev-website#9804

[gayaldassanayake]

Had to park ballerina-platform/sonar-ballerina#10 because we have a workaround for the java17-21 issue and the migration takes a considerable effort.

Started on ballerina-platform/sonar-ballerina#12 to update the documentation quickly and get sonar plugin up to date.

All the details are updated in the relevant individual issues.