Qodana IDE plugin
Edit page Last modified: 05 December 2022The Qodana IDE plugin is a JetBrains IDE plugin that binds Qodana reports, both stored locally or in Qodana Cloud, with your project opened in an IDE. Using this plugin, you can do the following things in your IDE:
Open and study Qodana reports from Qodana reports, as well as from a local storage
Link your projects with Qodana Cloud and overview Qodana Cloud-based reports
By default, this plugin is available in all JetBrains IDEs starting from version 2022.3. Otherwise, you can install it using JetBrains Marketplace.
note
The functionalities described in this section are available only with the nightly images of IntelliJ IDEA and PhpStorm.
Before you start
Make sure your preferred IDE is installed via JetBrains Toolbox App.
Install the plugin for the IDE as described in the IntelliJ IDEA Documentation. IDE versions 2021.2 and later are supported. Starting from 2021.3, this plugin is installed by default.
To open Qodana reports from your local storage, make sure that you previously opened the project by the IDE at least one time. This action establishes the link between the Qodana report and your IDE.
Plugin overview
Functionality of this plugin is available in the Qodana tab of the Problems window located in the lower-left part of the IDE user interface, and it becomes visible after you open a report.
After opening, the Qodana tab shows the list of problems that were detected by Qodana.
If you click an item in this list, you can navigate to the highlighted code fragments that contain a problem.
In the upper-left corner of this tab, you can find the Log in to Qodana and Link project with Cloud buttons.
The Log in to Qodana button lets you log in to Qodana Cloud. This action is a prerequisite for linking your project with Qodana Cloud-based reports. Alternatively, you can do it using the Tools | Qodana | Log in to Qodana menu of your IDE as described here.
Using the Link project with Cloud button, you can link your project with a specific report uploaded to Qodana Cloud. After linking, you can study the report using your IDE. Alternatively, you can link your project using the Tools | Qodana | Link Project with Cloud menu of your IDE as described here.
Open report from Qodana UI
In a Qodana HTML report, choose a problem and click Open file in <IDE>.
Open report from Qodana Cloud
Using the plugin functionality, you can:
Log in to Qodana Cloud
Logging in to Qodana Cloud is required before linking your project with reports from Qodana Cloud.
In your IDE, navigate to Tools | Qodana | Log in to Qodana.
Alternatively, you can click the Log in to Qodana button of the Qodana tab.
On the Settings | Tools | Qodana window, click Log in. This will redirect you to the authentication page.
On the authentication page, complete the authentication step.
Link project with Qodana Cloud
You can synchronize your local project with reports uploaded to Qodana Cloud and related to a specific project. This lets you overview the detected problems using the Problems tool window of your IDE. To link a project, you first need to log in to Qodana Cloud.
tip
For successful linking, your local project should already be inspected by Qodana at least once with the report uploaded to Qodana Cloud.
In your IDE, navigate to Tools | Qodana, and then click Link Project with Cloud.
Alternatively, you can click the Link project with Cloud button of the Qodana tab.
On the Link Project with Qodana Cloud window, select the Qodana Cloud project you would like to link your local project with, and then click Apply.
After linking, you can overview the report using the Qodana tab of the Problems window, see the Plugin overview section.
Update report
To update the report, you should first have it linked with Qodana Cloud.
In your IDE, navigate to Tools | Qodana, uncheck Cloud Project <project-name>, and then check it back.
Alternatively, in the Qodana tab of the Problems window, you can uncheck Cloud Project <project-name>, and then check it back.
Open report from a local storage
In the IDE, go to Tools | Qodana | Open Qodana Analysis report and select the qodana.sarif.json
report file you would like to open.
In the Qodana tab, you can overview the detected problems and jump to the corresponding line in the code editor. In case a problem was fixed before opening the qodana.sarif.json
file, it is marked as [Not present]
.