clang-tools 20.0.0git
Public Attributes | List of all members
clang::clangd::config::Fragment::DiagnosticsBlock::ClangTidyBlock Struct Reference

Controls how clang-tidy will run over the code base. More...

#include <ConfigFragment.h>

Public Attributes

std::vector< Located< std::string > > Add
 
std::vector< Located< std::string > > Remove
 List of checks to disable.
 
std::vector< std::pair< Located< std::string >, Located< std::string > > > CheckOptions
 A Key-Value pair list of options to pass to clang-tidy checks These take precedence over options specified in clang-tidy configuration files.
 
std::optional< Located< std::string > > FastCheckFilter
 Whether to run checks that may slow down clangd.
 

Detailed Description

Controls how clang-tidy will run over the code base.

The settings are merged with any settings found in .clang-tidy configuration files with these ones taking precedence.

Definition at line 268 of file ConfigFragment.h.

Member Data Documentation

◆ Add

std::vector<Located<std::string> > clang::clangd::config::Fragment::DiagnosticsBlock::ClangTidyBlock::Add

Definition at line 269 of file ConfigFragment.h.

◆ CheckOptions

std::vector<std::pair<Located<std::string>, Located<std::string> > > clang::clangd::config::Fragment::DiagnosticsBlock::ClangTidyBlock::CheckOptions

A Key-Value pair list of options to pass to clang-tidy checks These take precedence over options specified in clang-tidy configuration files.

Example: CheckOptions: readability-braces-around-statements.ShortStatementLines: 2

Definition at line 283 of file ConfigFragment.h.

◆ FastCheckFilter

std::optional<Located<std::string> > clang::clangd::config::Fragment::DiagnosticsBlock::ClangTidyBlock::FastCheckFilter

Whether to run checks that may slow down clangd.

Strict: Run only checks measured to be fast. (Default) This excludes recently-added checks we have not timed yet. Loose: Run checks unless they are known to be slow. None: Run checks regardless of their speed.

Definition at line 290 of file ConfigFragment.h.

◆ Remove

std::vector<Located<std::string> > clang::clangd::config::Fragment::DiagnosticsBlock::ClangTidyBlock::Remove

List of checks to disable.

Takes precedence over Add. To enable all llvm checks except include order: Add: llvm-* Remove: llvm-include-order

Definition at line 275 of file ConfigFragment.h.


The documentation for this struct was generated from the following file: