SonarQube Ballerina Plugin (Sonar Plugin API)

SonarQube plugins allow developers to provide static code analysis support for new languages.

This analyzer consist of 2 parts to function, the bal scan tool and the SonarQube ballerina analyzer. The SonarQube Ballerina Plugin is dependent on the bal scan tool, as the scanner is responsible for performing the static code analysis for ballerina projects and the analyzer is responsible for aggregating and reporting the results on the scan to the SonarQube server.

Prerequisites

The following software should be installed locally

• Java version: 17
• SonarQube version: 9.9 (LTS)
• Sonar scanner
• Ballerina version: 2201.8.5
• Node.js version: v20.12.0
• npm (version 10.5.0 or later)

Getting started

1. Create the bal scan tool by following the instructions here
2. Create the SonarQube Ballerina Plugin by following the instructions here
3. Run SonarQube server instance
4. Initialize a sonar scan in a project, example