Qodana

A standard qodana.yaml (or qodana.yml) format for Qodana configuration. Documentation: https://jetbrains.com/qodana

Type object
File match qodana.yaml qodana.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/qodana/latest.json
Source https://www.schemastore.org/qodana-1.0.json

Validate with Lintel

npx @lintel/lintel check
Type: object

A configuration file for Qodana (https://jetbrains.com/qodana), named qodana.yaml or qodana.yml

Properties

version enum required

The version of the file format

Values: "1.0"
profile object

A profile is some template set of checks to run with Qodana analysis

Any of: object object, object object
failThreshold integer

Deprecated: Use failureConditions#anySeverity

min=0
script object

The default running scenario

2 nested properties
name enum

The name of the script

Values: "default" "php-migration" "local-changes" "teamcity-changes" "migrate-classes"
parameters object

The parameters to pass to the script

exclude exclude[]

The inspections and paths that are excluded from analysis

minItems=0
include include[]

The inspections and paths that are added to those from the profile

minItems=0
linter string

The linter (Docker image) to run for Qodana CLI / any CI extensions

ide string

The local path to an IDE or a product code to use for Qodana analysis. Incompatible with 'linter'

bootstrap string

The command to run inside Docker before the analysis starts

properties Record<string, string>

Set JVM properties to be used while running Qodana

licenseRules licenseRule[]

A list of license rules to apply for license checks

minItems=0
dependencyIgnores dependencyIgnore[]
minItems=0
dependencyOverrides dependencyOverride[]
minItems=0
projectLicenses licenseOverride[]

Overrides the licenses attached to the project

minItems=0
customDependencies customDependency[]
minItems=0
plugins plugin[]

A list of plugins to install for Qodana analysis

minItems=0
dot-net object | object

Configuration for .NET solutions and projects

dotnet object | object | object | object | object

Configuration for .NET solutions and projects

cpp object

Configuration for Qodana for C/C++

1 nested properties
cmakePreset string

Name of a specific CMake preset to use during analysis

minLength=1
projectJDK string

The JDK to use for the project

php object

Configuration for PHP projects

1 nested properties
version string

The PHP version to use for the code analysis

minLength=1
disableSanityInspections boolean

Disable sanity checks for the project

Default: false
fixesStrategy enum

The strategy to apply fixes

Default: "none"
Values: "none" "cleanup" "apply"
runPromoInspections boolean

Whether to run a curated set of promo inspections

Default: false
includeAbsent boolean

Whether to include absent issues in the baseline calculation

Default: false
maxRuntimeNotifications integer

Maximum amount of internal errors to collect in the report

Default: 100
failOnErrorNotification boolean

Whether to fail the run when any internal error was encountered. In that case, the program returns exit code 70

Default: false
failureConditions object
2 nested properties
severityThresholds object

Configures maximum thresholds for different problem severities. Absent properties are not checked. If a baseline is given, only new results are counted

6 nested properties
any integer

The run fails if the total amount of results exceeds this number.

Default: null
critical integer

The run fails if the amount results with severity CRITICAL exceeds this number.

Default: null
high integer

The run fails if the amount results with severity HIGH exceeds this number.

Default: null
moderate integer

The run fails if the amount results with severity MODERATE exceeds this number.

Default: null
low integer

The run fails if the amount results with severity LOW exceeds this number.

Default: null
info integer

The run fails if the amount results with severity INFO exceeds this number.

Default: null
testCoverageThresholds object

Configures minimum thresholds for test coverage metrics. Absent properties are not checked

2 nested properties
total integer

The run fails if the percentage of total lines covered is lower than this number.

Default: null
fresh integer

The run fails if the percentage of fresh lines covered is lower than this number

Default: null
dependencySbomExclude dependencyIgnore[]

Which dependencies to exclude from the generated SBOM report

modulesToAnalyze object[]

Which submodules to include. Omitting this key will include all submodules

minItems=0
analyzeDevDependencies boolean

Whether to include dev dependencies in the analysis

Default: false
enablePackageSearch boolean

Using package-search service for fetching license data for dependencies (only for jvm libraries)

Default: false
raiseLicenseProblems boolean

Show license problems like other inspections

Default: false

Definitions

profile object

A profile is some template set of checks to run with Qodana analysis

include object

The inspections to run in addition to those from the profile

name string required

The ID of the inspection to be added

paths string[]

The path in which to enable the inspection, relative to the project root. Omitting the paths enables the inspection everywhere

minItems=0
exclude object

The inspections or paths to exclude from analysis

name string required

The ID of the inspection to exclude, or 'All'

paths string[]

The path in which to disable the inspection, relative to the project root. Omitting the paths disables the inspection everywhere

minItems=0
script object

The default running scenario

name enum

The name of the script

Values: "default" "php-migration" "local-changes" "teamcity-changes" "migrate-classes"
parameters object

The parameters to pass to the script

licenseRule object

A license rule to apply for license compatibility checks in Qodana

keys string[]

The list of project license SPDX IDs

minItems=0
allowed string[]

The list of allowed dependency licenses for the project

minItems=0
prohibited string[]

The list of prohibited dependency licenses for the project

minItems=0
dependencyIgnore object

A dependency to ignore for license checks in Qodana

name string

The name of a dependency to ignore

dependencyOverride object

A dependency metadata to override for license checks in Qodana

name string required

The dependency name

version string required

The dependency version

licenses license[] required

The dependency licenses

minItems=0
url string

The dependency homepage

customDependency object

A dependency to add to license checks to Qodana

name string required

The dependency name

version string required

The dependency version

licenses license[] required

The dependency licenses

minItems=0
url string

The dependency homepage

license object

A license to apply for license compatibility checks in Qodana

key string

The SPDX ID of the license

url string

The license homepage

dotnet object | object | object | object | object

Configuration for .NET solutions and projects

dot-net object | object

Configuration for .NET solutions and projects

cpp object

Configuration for Qodana for C/C++

cmakePreset string

Name of a specific CMake preset to use during analysis

minLength=1
licenseOverride object

Specifies the license of a dependency or project

key string

SPDX id of this license

url string

Homepage of this license

format=uri
php object

Configuration for PHP projects

version string

The PHP version to use for the code analysis

minLength=1
plugin object

A plugin to install for Qodana analysis

id string

The plugin ID to install (can be copied from the plugin page on the JetBrains Marketplace)

minLength=1
severityThresholds object

Configures maximum thresholds for different problem severities. Absent properties are not checked. If a baseline is given, only new results are counted

any integer

The run fails if the total amount of results exceeds this number.

Default: null
critical integer

The run fails if the amount results with severity CRITICAL exceeds this number.

Default: null
high integer

The run fails if the amount results with severity HIGH exceeds this number.

Default: null
moderate integer

The run fails if the amount results with severity MODERATE exceeds this number.

Default: null
low integer

The run fails if the amount results with severity LOW exceeds this number.

Default: null
info integer

The run fails if the amount results with severity INFO exceeds this number.

Default: null
coverageThresholds object

Configures minimum thresholds for test coverage metrics. Absent properties are not checked

total integer

The run fails if the percentage of total lines covered is lower than this number.

Default: null
fresh integer

The run fails if the percentage of fresh lines covered is lower than this number

Default: null
failureConditions object
severityThresholds object

Configures maximum thresholds for different problem severities. Absent properties are not checked. If a baseline is given, only new results are counted

6 nested properties
any integer

The run fails if the total amount of results exceeds this number.

Default: null
critical integer

The run fails if the amount results with severity CRITICAL exceeds this number.

Default: null
high integer

The run fails if the amount results with severity HIGH exceeds this number.

Default: null
moderate integer

The run fails if the amount results with severity MODERATE exceeds this number.

Default: null
low integer

The run fails if the amount results with severity LOW exceeds this number.

Default: null
info integer

The run fails if the amount results with severity INFO exceeds this number.

Default: null
testCoverageThresholds object

Configures minimum thresholds for test coverage metrics. Absent properties are not checked

2 nested properties
total integer

The run fails if the percentage of total lines covered is lower than this number.

Default: null
fresh integer

The run fails if the percentage of fresh lines covered is lower than this number

Default: null