Qodana 2023.2 Help

About Qodana

official project

Qodana is a smart code quality platform by JetBrains. This powerful static analysis engine enables development teams to automate code reviews, build quality gates, and enforce code quality guidelines enterprise-wide – all within their JetBrains ecosystems. The platform can be integrated into any CI/CD pipeline and can analyze code written in 60+ languages including Java, JavaScript, TypeScript, PHP, Kotlin, Python, Go, and C#.

Basic components

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.

Basic components of Qodana

The fourth essential component is Qodana Cloud that aggregates Qodana reports and processes license information.

Qodana workflow

The diagram below provides an overview of a typical Qodana use-case.

Basic Qodana workflow

This diagram describes several steps:

  1. Set up Qodana using available options.

  2. Take all necessary configuration steps:

  3. Inspect your codebase using available linters and features. You can run Qodana either locally or within a CI/CD pipeline.

    Inspection results are available in these forms:

You can overview inspection results for all your projects using Qodana Cloud.

  1. 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:

  • Docker images let you inspect local projects and build Qodana into your CI/CD pipelines.

  • 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.

Running 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

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

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.

Contact us

If you encounter a bug or would like to suggest a new feature, use the issue tracker or email the support team at qodana-support@jetbrains.com.

To actively participate in the Qodana community, join Qodana Slack.

Next steps

Last modified: 18 July 2023