Running an analysis

Now that you've installed the SonarQube for IDE extension in your IDE, running an analysis is straight-forward. For the most part, new analyses are automatically triggered when you open a file, as you type, or with each file save following a change in the code. Below we've outlined other ways to trigger a SonarQube for IDE analysis.

Triggering an analysis

First, open a project using one of the supported languages. Some languages can only be unlocked when running in Connected mode. For C and C++, check the Analyze C and C++ code section below. 

New analyses are automatically triggered in VS Code when you open or save a file; with Autosave configured, new issues will be reported as you type.

Check the Investigating issues page for details about how to recognize issues in your IDE.

How it works

With Auto Save enabled in VS Code, SonarQube for IDE continuously analyzes the code while you type. Simply open any source file, start coding, and you will start seeing issues reported by SonarQube for IDE. Issues are highlighted in your code and also listed in the PROBLEMS panel.

You can access the detailed rule description directly from your editor, using the provided contextual menu.

Analyze C and C++ code

Prerequisites

To analyze C and C++ code, you need to satisfy both of these conditions:

1. Generate a compilation database and 
2. be on one of the Supported environments 

See below for details.

Generate a compilation database

Compilation database is a JSON file format introduced by the LLVM project. It contains the compile commands used to build a project. For instructions on how to generate a compilation database, choose the appropriate collapsible below. The preferred option is to use the build system.

# Add the following "OTHER_CFLAGS" option to the xcodebuild command
xcodebuild clean build <additional args> OTHER_CFLAGS="\$(inherited) -gen-cdb-fragment-path \$(PROJECT_DIR)/CompilationDatabase"
# After the build, aggregate the fragments into "compile_commands.json"
cd CompilationDatabase && sed -e '1s/^/[\'$'\n''/' -e '$s/,$/\'$'\n'']/' *.json > ../compile_commands.json && cd ..

build-wrapper-linux-x86-64 --out-dir build_wrapper_output_directory make clean all

build-wrapper-macosx-x86 --out-dir build_wrapper_output_directory xcodebuild clean build

build-wrapper-win-x86-64.exe --out-dir  build_wrapper_output_directory MSBuild.exe /t:Rebuild /nodeReuse:False

Supported environments

Activating C and C++ Analysis

The analysis can be activated by simply pointing to a compilation database that describes the project to be analyzed. This can be done through a notification that pops up when a folder that contains a file named compile_commands.json is opened, or through the SonarQube for VS Code embedded action that lists all compilation database files in the folder, or by manually assigning the sonarlint.pathToCompileCommands option in the settings to the full path of the compilation database.

Note that the SonarQube for IDE embedded action can be used to switch the active compilation database.

Troubleshooting C and C++ Analysis

In case the analysis is not working or obvious false positives are raised, here are the recommended actions in order:

1. Investigate the logs: 

• First, enable the SonarLint Analyzer Logs and look if there is any error or failures that indicate what went wrong. 
• If there is no obvious sign in the logs, enable Verbose Logs and check again.

2. Make sure that the compilation database is credible:

• Check that the compilation database is up to date. It shouldn't contain outdated commands or point to files that no longer exist.
• Make sure that the compilation database contains the actual compilation commands. This can be done by running the commands inside the compile_commands.json and verifying that they succeed.
• Make sure that the VS Code environment has the environment variables required to build the project.

3. Enable Rule `S2260`: 

• In case of obvious false positives in the raised issues, enable the cpp:S2260 or c:S2260 rule and check if it raises issues in the culprit file. This rule indicates that the analyzer failed to parse part of the code and might give hints or indicate a configuration problem. 
• If it raises issues, follow the rule description to fix your code; if not, move to the step in troubleshooting.

4. Generate the CFamily reproducer File and Report the Issue: 

• When none of the previous suggestions work, please report the problem you encountered in the Sonar Community. 
• In case of a false positive or an analysis failure, we need the CFamily reproducer file to investigate the issue. To generate the reproducer file, add the following analyzer option to the settings.json:
  • "SonarQube for IDE.analyzerProperties": {"sonar.cfamily.reproducer" : "C:\\replace\\by\\path\\to\\file.cpp"}
• The sonar.cfamily.reproducer should point to the source or header file on which you face the issue. After setting that option, trigger the analysis on the culprit file. You should see in the logs that a file name sonar-cfamily.reproducer is generated in a temporary directory. Upload that file in your community report or ask us to share it privately if it contains sensitive information.