Qodana
A standard qodana.yaml (or qodana.yml) format for Qodana configuration. Documentation: https://jetbrains.com/qodana
qodana.yamlqodana.yml
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
qodana.yaml and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
versionrequired | enum | The version of the file format one of: "1.0" |
profile | object | A profile is some template set of checks to run with Qodana analysis |
failThresholddeprecated | integer | Deprecated: Use failureConditions#anySeverity |
script | object | The default running scenario |
script.name | enum | The name of the script one of: "default", "php-migration", "local-changes", "teamcity-changes", "migrate-classes" |
script.parameters | object | The parameters to pass to the script |
exclude | array | The inspections and paths that are excluded from analysis |
include | array | The inspections and paths that are added to those from the profile |
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 | object | Set JVM properties to be used while running Qodana |
licenseRules | array | A list of license rules to apply for license checks |
dependencyIgnores | array | — |
dependencyOverrides | array | — |
projectLicenses | array | Overrides the licenses attached to the project |
customDependencies | array | — |
plugins | array | A list of plugins to install for Qodana analysis |
dot-netdeprecated | anyOf | Configuration for .NET solutions and projects |
dotnet | anyOf | Configuration for .NET solutions and projects |
cpp | object | Configuration for Qodana for C/C++ |
cpp.cmakePreset | string | Name of a specific CMake preset to use during analysis |
projectJDK | string | The JDK to use for the project |
php | object | Configuration for PHP projects |
php.version | string | The PHP version to use for the code analysis |
disableSanityInspections | boolean | Disable sanity checks for the project default: false |
fixesStrategy | enum | The strategy to apply fixes default: "none"one of: "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 | — |
failureConditions.severityThresholds | object | Configures maximum thresholds for different problem severities. Absent properties are not checked. If a baseline is given, only new results are counted |
failureConditions.severityThresholds.any | integer | The run fails if the total amount of results exceeds this number. default: null |
failureConditions.severityThresholds.critical | integer | The run fails if the amount results with severity CRITICAL exceeds this number. default: null |
failureConditions.severityThresholds.high | integer | The run fails if the amount results with severity HIGH exceeds this number. default: null |
failureConditions.severityThresholds.moderate | integer | The run fails if the amount results with severity MODERATE exceeds this number. default: null |
failureConditions.severityThresholds.low | integer | The run fails if the amount results with severity LOW exceeds this number. default: null |
failureConditions.severityThresholds.info | integer | The run fails if the amount results with severity INFO exceeds this number. default: null |
failureConditions.testCoverageThresholds | object | Configures minimum thresholds for test coverage metrics. Absent properties are not checked |
failureConditions.testCoverageThresholds.total | integer | The run fails if the percentage of total lines covered is lower than this number. default: null |
failureConditions.testCoverageThresholds.fresh | integer | The run fails if the percentage of fresh lines covered is lower than this number default: null |
dependencySbomExclude | array | Which dependencies to exclude from the generated SBOM report |
modulesToAnalyze | array<object> | Which submodules to include. Omitting this key will include all submodules |
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 |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- Has 2 place(s) where keywords sit beside
$ref. Under draft-07 those keywords are silently ignored by every conforming validator — first at#/definitions/failureConditions/properties/severityThresholds. - 81 properties, 89% carrying a description, max nesting depth 7.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$comment | JSON Schema Core, draft 2020-12 | §8.3 — Comments With "$comment" |
$id | JSON Schema Core, draft 2020-12 | §8.2.1 — The "$id" Keyword |
$ref | JSON Schema Core, draft 2020-12 | §8.2.3.1 — Direct References with "$ref" |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
additionalProperties | JSON Schema Core, draft 2020-12 | §10.3.2.3 — "additionalProperties" |
anyOf | JSON Schema Core, draft 2020-12 | §10.2.1.2 — "anyOf" |
default | JSON Schema Validation, draft 2020-12 | §9.2 — "default" |
deprecated | JSON Schema Validation, draft 2020-12 | §9.3 — "deprecated" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
enum | JSON Schema Validation, draft 2020-12 | §6.1.2 — "enum" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
minItems | JSON Schema Validation, draft 2020-12 | §6.4.2 — "minItems" |
minLength | JSON Schema Validation, draft 2020-12 | §6.3.2 — "minLength" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
required | JSON Schema Validation, draft 2020-12 | §6.5.3 — "required" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
format: "uri" | RFC 3986 (STD 66) | §3 — Syntax Components |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.