How to apply an existing sonarQube rule for only given class type

Question

Please help me to solve these problems. Simply I want to apply an existing sonarqube rule for only certain type of classes. As far as I know, we can use class tree to get the classes and identify the target class. The thing I want t know is how can I enable or disable existing sonar rule within a custom rule?.

The next question is to identify the base class which is child class is extended. As an example class A extend class B, B extend class C and now I want to identify all the classes that is extended from the class C(The base class).

Even a small guide, link, tip will be really appreciate.

@Todd this is the rule "Fields in a "Serializable" class should either be transient or serializable" https://rules.sonarsource.com/java/RSPEC-1948 — Chanaka Fernando, May 26 '19 at 17:28

Josef Prochazka · Accepted Answer · 2019-10-17T07:15:35.103

I think you canot disable existing rule from default java plugin within your custom plugin. You could disable the rule in your profile and replace the default rule with custom one. (Actually there may be way with creating custom issue filter in your plugin )

The rule is implemented like this.

@Rule(key = "S1948") public class SerializableFieldInSerializableClassCheck extends IssuableSubscriptionVisitor

 public List<Tree.Kind> nodesToVisit() {
    return ImmutableList.of(Tree.Kind.CLASS);
  }

  public void visitNode(Tree tree) {
    if(!hasSemantic()) {
      return;
    }
   ... rule logic
  }

just copy (and change the rule key and etc.) the existing rule into your custom plugin and add a check for class supertype

if(!classTree.symbol().type().isSubtypeOf("your.supertype.C")) || !hasSemantic()) {
  return;
}

How to apply an existing sonarQube rule for only given class type

1 Answers1