SonarLint: Custom Rules 101

balbi_andre · August 13, 2024, 2:59pm

Enterprise Edition
Version 9.9.1 (build 69595)
Docker

Context
I have a set of custom rules installed in my SonarQube server, I want the rules from my custom plugin (installed .jar) to be shown to every developer using SonarLint in their IDEs. I’m asking this again since the latest question I’ve found here regarding this subject was from 2 years ago.

Question 1: Is it possible for SonarLint to analyse using my custom rules, if so, how?
Question 2: If I create a XPATH custom rule within my instance, this rule will be shown in connected SonarLint clients?

ganncamp · August 14, 2024, 12:57pm

Hi,

I need to ask what may seem like dumb questions:

Are your custom rules included in the relevant Quality Profile(s)?
Are your developers working in connected mode?

Thx,
Ann

balbi_andre · August 14, 2024, 5:42pm

Hello! Thanks for answering!

Are your custom rules included in the relevant Quality Profile(s)?
We’ve developed a plugin for a new language, it has a default Quality Profile associated with it, we had to develop this Quality Profile in order to the plugin to work.
Are your developers working in connected mode?
Some are, most aren’t. We could assert the use of connected mode if necessary.

Cheers,
André

ganncamp · August 14, 2024, 5:47pm

Hi Andre,

(Sorry about the missing accent. AmE keyboard. )

This is the problem. I believe we support rules from custom plugins for built-in languages. But this I’m sure we don’t support.

Ann

balbi_andre · August 14, 2024, 6:26pm

Don’t worry about the name , Andre is almost the same thing!

So no lint for custom rules implemented as we did…
Thanks for answering! You’ve been very helpful

I still have some other questions regarding custom rules:

We’d like to have custom rules regarding built-in languages, e.g.XML. If I create a XML XPATH custom rule within my instance, would this rule be shown in connected mode SonarLint clients?
Are there any guidelines of example repos for custom plugins for built-in languages (preferably XML or JS)

Cheers!

ganncamp · August 14, 2024, 6:34pm

Hi Andre,

thanks!

I believe it should be, assuming it’s in the profile and you’re in connected mode.

This is the only one I’m aware of:

github.com

SonarSource/sonar-java/blob/master/docs/CUSTOM_RULES_101.md

Writing Custom Java Rules 101
==========

If you are using SonarQube along with its Java Analyzer to analyze your projects, you might find that certain specific requirements of your company cannot be addressed by the existing rules. 
In such cases, the most suitable option would be to develop your own custom Java rules.

This document introduces custom rule writing for the SonarQube Java Analyzer. 
It will cover all the main concepts of static analysis required to understand and develop effective rules, relying on the API provided by the SonarSource Analyzer for Java.

## Content

* [Getting Started](#getting-started)
  * [Looking at the pom](#looking-at-the-pom)
* [Writing a rule](#writing-a-rule)
  * [Three files to forge a rule](#three-files-to-forge-a-rule)
  * [A specification to make it right](#a-specification-to-make-it-right)
  * [A test file to rule them all](#a-test-file-to-rule-them-all)
  * [A test class to make it pass](#a-test-class-to-make-it-pass)
  * [First version: Using syntax trees and API basics](#first-version-using-syntax-trees-and-api-basics)
  * [Second version: Using semantic API](#second-version-using-semantic-api)

This file has been truncated. show original

HTH,
Ann

ganncamp · August 15, 2024, 11:41am

Hi again,

It’s just been brought to my attention that SonarLint doesn’t support anything below 9.9.6. You’ll need to upgrade your LTA version (you should anyway )

Ann