IDE integration
Starting from version 2022.3, you can use Qodana functionality in JetBrains IDEs for binding Qodana reports, both stored locally or in Qodana Cloud, with your project opened in an IDE. This means that you can:
Study Qodana reports including reports stored locally
Link your projects with Qodana Cloud and overview Qodana Cloud-based reports
This functionality is supported by IntelliJ IDEA, PhpStorm, WebStorm, Rider, GoLand, PyCharm, and Rider.
Before you start
Make sure that your preferred IDE is installed via JetBrains Toolbox App.
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.
UI overview
Qodana is available in the Qodana tab of the Problems window of your IDE. This window is located in the lower-left part of the IDE user interface, and becomes visible once 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 buttons listed in this table:
Button | Description |
|---|---|
Logging 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 menu of your IDE as described here. | |
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 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 your IDE, 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 .
Alternatively, you can click the Log in to Qodana button of the Qodana tab.
On the window, click . 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 tool window of your IDE. To link a project, you first need to log in to Qodana Cloud.
In your IDE, navigate to , and then click .
Alternatively, you can click the Link project with Cloud button of the Qodana tab.
On the window, select the Qodana Cloud project you would like to link your local project with, and then click .
After linking, you can overview the report using the tab of the window, see the UI overview section.
Update report
To update the report, you should first have it linked with Qodana Cloud.
In your IDE, navigate to , uncheck Cloud Project <project-name>, and then check it back.
Alternatively, in the tab of the window, you can uncheck , and then check it back.
Open report from a local storage
In the IDE, go to and select the qodana.sarif.json report file you would like to open.
In the 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].