New code
New code in the context of Clean as You Code
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), SonarQube for IDE uses the New Code Definition (NCD) to determine which issues you should focus on fixing, and calls out that these issues are found in new code. Focusing on new code is at the core of implementing the Clean as You Code strategy, knowing that the other code will be incrementally fixed over time.
To achieve this, SonarQube for IDE offers the Focus 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 the SonarQube Server or SonarQube 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.
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 check the documentation in SonarQube Server, SonarQube Cloud, or SonarQube Community Build to properly set your new code definition.
When not running in connected mode, the SonarQube focus feature can still be used to highlight only issues found in new code.
Setting the SonarQube focus on new code is easy. To activate or deactivate this mode, select SonarQube focus: in the VS Code Status Bar, then press Enter or choose Focus on new code or Focus on overall code from the Command Palette. Additionally, you can select or deselect the SonarQube focus mode from the VS Code > Settings… > Settings > Extensions > SonarLint > User settings menu.
By default, the SonarQube focus is set to overall code when you set up a new connection and establish the project binding.
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 SonarQube focus: new code mode option.
Running SonarQube for IDE in Connected Mode with SonarQube Server or SonarQube Cloud offers more opportunities to choose how you define new code. Check out their respective pages for details.
How the new code definition affects the analysis results
The core idea of Clean as You Code is that you focus your attention and effort on new code (code that has been added or modified recently) and improve your code incrementally. SonarQube Server and SonarQube Cloud use your NCD as a baseline for code comparison, to identify what is new code which reinforces the Clean as You Code strategy by only showing you issues found in new 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, every SonarQube for IDE 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.
Was this page helpful?