New code

SonarQube for VS Code uses the New Code Definition to determine which issues you should focus on fixing, and calls out that these issues are found in new code.

New code and your quality standards

Focusing on new code is an important step in getting the most out of SonarQube for IDE. When you run an analysis on your main branch (or other long-lived branches) in SonarQube (Server, Cloud) and have set up Connected mode, SonarQube for IDE uses the server’s New Code Definition (NCD) to determine which issues you should focus on fixing, and calls out the issues found in new code. Focusing on new code is at the core of implementing the SonarQube strategy, knowing that the other code will be incrementally fixed over time.

To achieve this, SonarQube for IDE offers the Focusing on new code feature to highlight new code in the IDE.

Your new code definition

When SonarQube for IDE is running in connected mode, the SonarQube for IDE uses the NCD defined in SonarQube Server or on SonarQube Cloud. When SonarQube for IDE is running in standalone mode, a locally defined new code period highlights your new code.

Running SonarQube for IDE in connected mode with SonarQube (Server, Cloud) offers more opportunities to choose how you define new code.

New code definition options

When you use the NCD found in your SonarQube (Server, Cloud) quality profile, you have more opportunities to choose how to define new code. Check out their respective pages for details:

Without Connected mode, new code is defined by a new code period: any code added or changed in the last 30 days is considered new code. The 30-day timeframe is defined using Git.

When not using Git, the new code period begins with the first SonarQube for IDE analysis.

There is no option to manually define a new code period in SonarQube for IDE.

Setting your focus on new code

The Focus on new code feature works when SonarQube for IDE is running in either connected mode or standalone mode. New code is defined differently in each mode as mentioned above*.*

Focus on new code in connected mode

Setting your focus on new code has these prerequisites running in Connected mode:

  • Your local project must be bound to a SonarQube (Server, Cloud) or SonarQube Community Build project.

  • The new code definition must be defined in SonarQube (Server, Cloud) or SonarQube Community Build using a Previous version, Number of days, or Specific analysis.

  • The Reference branch new code definition is not supported. Please see the New code definition options article above for links to learn how to properly set your new code definition on the server.

By default, the Focus on New Code feature is set to overall code when you set up a new connection and establish the project binding; the last saved setting persists through restarts.

Focus on new code in standalone mode

When not running in connected mode, the SonarQube focus can still be used to highlight only issues found in new code. By default, the SonarQube focus feature is set to overall code when you open SonarQube for VS Code for the first time; the last saved setting persists through restarts.

Change your SonarQube focus

Setting your SonarQube focus is easy. To activate or deactivate this mode, select either the eye icon from the SONARQUBE panel or, when you select SonarQube focus: in the VS Code Status Bar, a quick pick window will pop up allowing you to switch focus.

Additionally, you can select or deselect the Focus on New Code mode from the VS Code > Settings… > Settings > Extensions > SonarLint > User settings menu.

When deciding to override a globally defined new code definition at the project level in SonarQube (Server, Cloud) or SonarQube for Community Build, note that it is not possible to specify a unique new code definition at the branch level and still activate the Focus on New Code option.

Running SonarQube for Eclipse in connected mode with SonarQube (Server, Cloud) and SonarQube Community Build offers more opportunities to choose how you define new code.

How the new code definition affects the analysis results

Focusing on new code and understanding how to work with new code to apply your quality standards are only applicable in SonarQube Server, SonarQube Cloud, and SonarQube Community Build. Learn more about setting quality standards in the server documentation:

Here are two important points to consider regarding your NCD and SonarQube for VS Code:

  • When running SonarQube for IDE in connected mode and enabling the Focus on New Code feature, the NCD from SonarQube (Server, Cloud) is used to show you only issues found in new code.

  • When running SonarQube for IDE while not in connected mode and enabling the Focus on New Code feature, Running an analysis will show you only issues found in new code.

The Focus on New Code feature gives you immediate feedback in the IDE, before you submit new code with new issues. Read the Focusing on new code article for more information.

Last updated

Was this helpful?