JetBrains IDEs
Starting from version 2022.3, you can use Qodana to inspect your codebase for problems and use the recommendations to eliminate them using JetBrains IDEs installed via JetBrains Toolbox App such as IntelliJ IDEA, PhpStorm, WebStorm, Rider, GoLand, PyCharm, and Rider.
Using the IDE, you can:
UI overview
Qodana functionality is available using the menu of your IDE.
You can also have access to Qodana using the Problems | Server-Side Analysis tool window of your IDE.
Run Qodana locally
You can configure and run Qodana locally using your IDE, and then forward inspection reports to Qodana Cloud for storage and analysis purposes.
In your IDE, navigate to .
In the dialog, click the button.
In the upper part of the dialog, configure the
qodana.yamlfile.Under the text field, configure the options to make Qodana:
Forward inspection results to Qodana Cloud using the project token
Save
qodana.yamlin your project rootRun the baseline feature
Click for inspecting your code.
In the tool window, overview inspection results.
Configure Qodana for CI
You can add Qodana into CI pipelines using the configuration wizard.
In your IDE, navigate to .
In the dialog, click the button.
In the dialog, configure the
qodana.yamlfile.
Select the CI solution you would like to configure Qodana for, and study the instructions.
Connect to Qodana Cloud
You can connect your local project to a specific Qodana Cloud project, get the latest Qodana report, and overview it using the IDE.
In your IDE, navigate to .
In the dialog, click .
This will redirect you to the authentication page.
Select the Qodana Cloud project to link your local project with.
In the tool window, overview inspection results.
Open a local report
You can open and study SARIF-formatted Qodana reports in your IDE.
In your IDE, navigate to .
Select the SARIF-formatted report file you would like to open.
In the tool window, you can overview inspection results.
Qodana report overview
Using the Server-Side Analysis tool window of your IDE, you can view Qodana reports and navigate to the code fragments containing such problems.
The left part of the Server-Side Analysis tool window contains several buttons.
This table describes each button from top to bottom:
Button | Description |
|---|---|
Close the report that was previously opened | |
Download the updated version of the report from Qodana Cloud. This requires that you first link your project with Qodana Cloud | |
Log in Qodana Cloud, or log out. This action is a prerequisite for linking your project with Qodana Cloud-based reports | |
Link your project with a specific Qodana Cloud-based project, or unlink it. This requires that you first log in to Qodana Cloud | |
Filter out code issues by their severity and configure their sorting. When no grouping or sorting options are selected, the issues are listed in the order they appear in the file. You can also filter all issues by the baseline | |
Open the preview pane to view the selected issue in its source context. This preview lets you can change the code and apply available quick-fixes | |
Expand all nodes to see all issues in the expanded form | |
Collapse all nodes that were previously expanded | |
Open the inspection report using your default browser | |
Functionalities from the menu |
Qodana log overview
In your IDE, navigate to Help | Collect Logs and Diagnostic Data. This will collect all necessary data and save them under a specific directory.