Qodana consists of these basic components:
Static analysis mechanism of Qodana means automated analysis of your codebase.
Linters are the components that let you analyze your code, find duplicate functions and incompatible licenses.
Code inspections are the linter components that immediately analyze your code for specific issues.
The diagram below shows how all these components are combined in Qodana.
The diagram below provides an overview of a typical Qodana use-case.
This diagram describes several steps:
Set up Qodana using available options.
Take all necessary configuration steps:
Inspection results are available in these forms:
You can overview inspection results for all your projects using Qodana Cloud.
Based on the inspection results, you can improve your code using your IDE, and run Qodana again to track the progress.
Setting up Qodana
Qodana provides several deployment options to better fit your needs:
JetBrains IDEs let you run Qodana, connect to Qodana Cloud, open and overview inspection reports.
Qodana extension for Visual Studio Code lets you retrieve reports from Qodana Cloud and overview inspection reports.
Integration tools include applications for seamless integration with CI/CD systems like GitHub and TeamCity, and guides for configuring Qodana Docker images for CI/CD.
Gradle plugin provides the Gradle interface for running Qodana in IntelliJ IDEA.
Cloud service is a cloud-based version of Qodana.
You can run Qodana locally in a standalone mode using a PC or a server. Alternatively, inspecting your code within a CI/CD pipeline means that your code will be inspected by Qodana as part of a building and/or deployment process.
Qodana Cloud is a cloud-based solution that helps you accumulate various Qodana reports and track the progress in your project(s) from a single point. To learn more about Qodana Cloud, you can study the documentation.
Qodana Playground is a sandbox environment that runs in TeamCity, a cloud-based CI system developed by JetBrains. You can use it to see Qodana in action and try various options yourself.
To actively participate in the Qodana community, join Qodana Slack.