Provide opinionated rules with the scan tool

[gayaldassanayake]

Problem

Ballerina has its own style of opinianated programming. These are not essentially rules but conventions. We need to support these opinionated conventions in the scan tool.

Proposed Solution

Have the opinionated conventions as a set of rules in a compiler plugin, wrapped with a ballerina package and pushed to central. Users can specify this package in the Scan.toml.

We can have another flag in the CLI if needed - bal scan --opinionated.

Alternatives

No response

Version

No response

[gayaldassanayake]

I drafted a design document for this[1]. The TLDR is,

Instead of duplicating every rule's documentation, we append rule documentation to the README.md of the tool package. This will act as the source of truth for the scan tool central docs, and the sonarqube documentation. Other metadata will reside as a JSON file in the resource dir of the tool package.

This will be dynamically fetched and registered when a sonarqube server is starting using the central API calls.

I will update on the final decision per the scheduled meeting tomorrow.

[1] https://docs.google.com/document/d/1YF2PytjoBuEecF_jt2ghRIgknEpxodmzw5dp0n4lCp8/edit?usp=sharing