Qodana
 

Prepare your project

Edit pageLast modified: 15 January 2025

When Qodana runs on your project, it tries to figure out the build system and project structure by itself. If Qodana cannot figure out the project structure, it will run the inspections nevertheless, but some inspections may report that they cannot find classes, packages, files or cannot resolve references. In these cases, Qodana needs a bit of help. Typical actions to prepare the project for Qodana are:

  • Install third-party packages or libraries

  • Run a program that sets up the build environment

These actions are carried out using the bootstrap key of the qodana.yaml file contained in the root directory of your project:

To be able to use syntax highlighting and validation in your IDE, you can create the prepare-qodana.sh shell script and save it in the root directory of your project:

Run the script in a Qodana Docker container using the bootstrap key: