Prepare your project

During analyses, Qodana linters may report that some inspections cannot find classes, packages, files or cannot resolve references although linters related to JVM, .NET and Golang try to figure out the build system and project structure automatically. In these cases, Qodana needs a bit of help:

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:

bootstrap: |+
  set -eu
  # For PHP projects that use Laravel:
  #composer require --dev barryvdh/laravel-ide-helper

  # For JavaScript projects that use Node.js:
  #npm install

  # For Python projects
  #pip install -r requirements.txt 

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:

#! /bin/sh
# Example bootstrap steps, see https://jetbrains.com/help/qodana/before-running-qodana.html
set -eu

# For PHP projects that use Laravel:
#composer require --dev barryvdh/laravel-ide-helper

# For JavaScript projects that use Node.js:
#npm install

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

bootstrap: sh ./prepare-qodana.sh

14 July 2025