Custom YAML profiles

groups.groupId

Unique group identifier.

In case two groups are defined under the same groupId, the latest group met in the file will be employed. This rule also works for all included files because the settings contained in the included files are considered prior to the settings laid out in the current file.

groups.inspections

The list of inspections included in the group.

groups.groups

The list of group IDs with possible exclamation mark character (!):

Here, groups lists several values:

By default, Qodana uses severity levels inherited from the JetBrains IDEs shown in this table:

Example

Suppose, you have the foo.yaml and bar.yaml profiles.

The foo.yaml profile enables the Inspection1, Inspection2 and Inspection3 inspections:

The bar.yaml profile disables the Inspection1 inspection:

You can include these two files in the custom profile and disable Inspection2:

In this case, the effective profile configuration read by Qodana will look like this:

Exclude an inspection

This sample shows how you can exclude the PhpDeprecationInspection inspection from the Qodana for PHP linter:

Alternatively, you can exclude the PhpDeprecationInspection inspection using groups:

Exclude paths

You can use the ignore block to ignore specific scopes and paths while inspecting your code.

In the sample below, the vendor/** value employs glob patterns for ignoring the contents of the vendor directory contained in your project root.

The scope definition scope#file:*.js:testData//* ignores all files with the .js extension recursively contained in the testData/ directory.

Create a profile from scratch

Using baseProfile, this configuration defines the empty profile, and then it includes only the Java/Data flow inspection group from the Qodana for JVM linter.

As an alternative to baseProfile, you can use ALL in the groups property:

Override the existing profile

You can exclude inspection categories from the qodana.starter profile that are not related to the Qodana for .NET linter.

Filter by severity

This sample includes all inspections with the WEAK WARNING severity level while inspecting Java code:

Override inspection severity

You can override the severity levels for existing inspections. Here’s how you can assign the WARNING severity level to the JavadocReference inspection:

Configure inspection options

Several inspections provide configuration options. You can find the list of available options on GitHub.

For example, in case of the MissingOverrideAnnotation inspection you can find the ignoreObjectMethods and ignoreAnonymousClassMethods options:

This is how you can override these options in your profile: