Rules

The Sonar Rules catalog is the entry point where you can discover all the existing rules. While running an analysis, SonarLint raises an issue every time a piece of code breaks a coding rule. 

Issues in your code are linked to Clean Code code attributes. When an issue is detected, it signifies that this part of your code is not consistent, intentional, adaptable, or responsible enough and that it impacts one or multiple software qualities. 

For more information about Clean Code attributes and software qualities, check out the Clean Code page.

Overview

Out of the box, SonarLint for Eclipse automatically checks against the following rules:

• CSS rules
• HTML rules
• Java (see below for additional requirements)
• JavaScript rules
• PHP rules
• Python rules
• TypeScript rules
• XML rules
• Secrets detection rules

When using Connected Mode with SonarQube or SonarCloud, you can unlock these rules:

• Abap rules
• Apex rules
• C/C++ (see below for additional requirements)
• COBOL rules (see below for additional requirements)
• Kotlin rules
• PL/I rules (available with SonarQube only)
• PL/SQL rules
• RPG rules (available with SonarQube only)
• Ruby rules
• Scala rules
• T-SQL rules

The full list of available rules is visible in the Rules Configuration preferences tab found by navigating the UI to Window > Preferences > SonarLint (or Eclipse > Settings… > SonarLint for Mac OS) for access to Rules Configuration. Here you can activate and deactivate rules to match your conventions. SonarLint will also show a code action on each issue to quickly deactivate the corresponding rule.

For more details about languages and new features under consideration for all SonarLint IDEs (including Eclipse), please refer to the SonarLint roadmap where we list our coming soon and newly released features.

Rule selection

Sonar Rules can individually be turned on or off while running SonarLint in standalone mode; there are two ways to do this:

• Right-click on the issue and select the Remove rule quick fix in the tooltip.
• Activate and deactivate rules one by one in the SonarLint Preferences > SonarLint > Rules Configuration menu. A full list of rules organized by language is available.

When your project is bound to SonarQube or SonarCloud using Connected Mode, the rule set is managed on the server side as defined by the quality profile. 

Applying rules while in Connected Mode

Connected Mode syncs your SonarQube or SonarCloud Quality Profile with the local analysis to suppress issues reported in the IDE. See the Connected Mode documentation for more information.

Language-specific requirements

C and C++ analysis

To analyze C and C++ code, SonarLint requires a C/C++ Development Tool (CDT). You can check the Eclipse Embedded CDT documentation for more details.

COBOL

COBOL analysis requires a COBOL IDE based on the Eclipse platform such as the IBM IDz or BMC IDEs. Note that recent versions of SonarLint and our analyzers require a JRE 11+ in order to run, and IBM IDz only supports JRE 11 starting from version 16.

• Check the IBM documentation for more information about SonarLint integration with Developer for z Systems.
• Some additional information is available for setting up a SonarLint with your BMC Compuware Topaz Workbench.

Java and JSP

Analysis of Java code requires the Eclipse sub-project Java development tools (JDT). This includes a Java compiler, incremental builder, editors, wizards, content assist, and all the other features of a first-class Java IDE.