Clang-Tidy integration

General Clang-Tidy settings

Clang-Tidy checks are enabled by default, and you can see them as warnings (or messages of another severity level) in the editor.

Note that not all the checks are enabled by default. Here you can find details of the Clang-Tidy default configuration in CLion.

To change the Clang-Tidy configuration, go to Settings/Preferences | Editor | Inspections, C/C++ | General | Clang-Tidy:

tip

You can set the desired severity level and scope for Clang-Tidy checks by selecting from the drop-down lists.

Options for particular checks

Some Clang-Tidy checks have options, which are either additional or substantial for the check (like those for readability-identifier-naming).

To configure options for a particular check, use the Configure Clang-Tidy Checks Options dialog. For example, you can force the modernize-use-nullptr check to replace any NULL-like macros with nullptr:

Tuning checks in the editor

In addition to the Inspections Settings dialog, you can disable a single check, a group of checks, or the entire Clang-Tidy inspection from the editor. These actions respectively update the Clang-Tidy command line.

To suppress a Clang-Tidy check for a particular line, use the Suppress "check_name" for line option. CLion will add a // NOLINT comment at the end of the selected line.

tip

The editor's menu for Clang-Tidy inspection is not available when .clang-tidy configuration files are used instead of CLion settings.

Configuration files

With .clang-tidy files, you can set per-directory configurations: for each source file, Clang-Tidy will attempt to read configuration from .clang-tidy in the closest parent directory.

To open the .clang-tidy configuration file used by the current source file, select Edit clang-tidy file for <current file> in the widget on the status bar:

If there's no .clang-tidy configuration available for the currently opened source file, you can create one by selecting Create .clang-tidy file in the widget:

The new file will include settings configured in Settings/Preferences | Editor | Inspections | C/C++ | Static Analysis Tools | Clang-Tidy.

note

The widget is available only if the Prefer .clang-tidy files over IDE settings checkbox is selected in Settings/Preferences | Editor | Inspections | C/C++ | Static Analysis Tools | Clang-Tidy.

.clang-tidy files are in the YAML format. For a syntax example, let's enable all the Clang-Tidy checks and provide the additional option to modernize-use-nullptr:

Checks: '*'
CheckOptions:
- key:             modernize-use-nullptr.NullMacros
value:           NULL,CUSTOM_NULL

By default, .clang-tidy files take precedence over the IDE settings. When analyzing a source file, CLion uses the settings from a reachable configuration file (located in the current directory or in one of the parent directories). If there is no such file, CLion relies on its own settings.

To change this behavior, clear the Prefer .clang-tidy files over IDE settings checkbox in Settings/Preferences | Editor | Inspections, C/C++ | General | Clang-Tidy.

Custom Clang-Tidy executable

You can work with your own Clang-Tidy executable instead of the bundled one (for example, when you want to create custom checks and use them in CLion).

Provide the path to your custom Clang-Tidy binary in Settings/Preferences | Languages & Frameworks | C/C++ (or click Specify Clang-Tidy executable in the Inspections Settings dialog).

This setting is IDE-wide: your custom Clang-Tidy binary will be used for all projects.

Notification on Clang-Tidy updates

CLion bundles Clang-Tidy from the corresponding LLVM revision, so when CLion releases a Clang update, the bundled Clang-Tidy executable gets updated to a newer version, and the IDE shows a notification:

Click Review to open a list of the available new checks and their activation state according to the Clang-Tidy inspection settings. You can enable or disable the checks in this dialog, and Clang-Tidy settings will change accordingly.

If you use a custom configuration file instead of the IDE settings, this notification will also warn you that clang-tidy files may overwrite your IDE settings.

note

Currently, the notification is shown only once per new IDE version launch.