Skip to content
The Chat Archive
mistral-medium-2505· Mistral AI LMArena Human Preference 140K

Я использую clangd и в нём установи параметр --clang-tidy как мне настроить clang-tidy…

  1. User

    Я использую clangd и в нём установи параметр --clang-tidy как мне настроить clang-tidy через clangd и можно ли как-то сделать вообще. Я хотел поставить некоторые флаги clang-tidy

  2. Assistant

    Настройка clang-tidy через clangd возможна, и вы можете передавать флаги clang-tidy через параметры clangd. Вот как это можно сделать:

    1. Настройка clangd для использования clang-tidy

    В конфигурационном файле clangd (обычно .clangd или compile_flags.txt) можно указать параметры clang-tidy.

    Пример файла .clangd:

    CompileFlags:
      Add: [-Wall, -Wextra, -std=c++17]
    ClangTidy:
      Add: [modernize-*, performance-*, readability-*]
      Remove: [modernize-use-trailing-return-type]
      CheckOptions:
        readability-identifier-naming.ClassCase: CamelCase
        readability-identifier-naming.FunctionCase: lower_case
    

    Пример файла compile_flags.txt:

    -Wall
    -Wextra
    -std=c++17
    --clang-tidy
    --clang-tidy-config=path/to/.clang-tidy
    

    2. Использование .clang-tidy

    Вы можете создать файл .clang-tidy в корне проекта и указать его в настройках clangd.

    Пример .clang-tidy:

    Checks: >
      modernize-*,
      performance-*,
      readability-*,
      -modernize-use-trailing-return-type
    CheckOptions:
      readability-identifier-naming.ClassCase: CamelCase
      readability-identifier-naming.FunctionCase: lower_case
    

    3. Передача флагов clang-tidy через clangd

    Если вы хотите передать флаги clang-tidy напрямую через clangd, можно использовать параметр --clang-tidy при запуске clangd:

    clangd --clang-tidy --clang-tidy-config=path/to/.clang-tidy
    

    4. Настройка в VS Code (если используете его)

    Если вы используете VS Code, можно добавить настройки в settings.json:

    {
      "clangd.arguments": [
        "--clang-tidy",
        "--clang-tidy-config=path/to/.clang-tidy"
      ]
    }
    

    5. Проверка работы clang-tidy

    После настройки откройте файл в редакторе и проверьте, что clang-tidy работает. В VS Code можно посмотреть вывод clangd в панели "Output" (выберите clangd в списке).

    Примечания:

    • Убедитесь, что clang-tidy установлен и доступен в PATH.
    • Если clangd не видит .clang-tidy, попробуйте указать полный путь к файлу.
    • Некоторые флаги clang-tidy могут конфликтовать с настройками clangd, поэтому тестируйте изменения постепенно.

    Если у вас есть конкретные флаги clang-tidy, которые вы хотите добавить, укажите их, и я помогу с настройкой.

  3. User

    Какие флаги есть у clang-tidy?

  4. Assistant

    clang-tidy предоставляет множество проверок (checks), которые можно включать или отключать с помощью флагов. Эти проверки делятся на категории, и каждая категория содержит набор правил для анализа кода.

    Основные категории проверок clang-tidy

    КатегорияОписание
    abseil-*Проверки для кода, использующего библиотеку Abseil
    android-*Проверки для Android-разработки
    boost-*Проверки для кода, использующего Boost
    bugprone-*Обнаружение потенциальных багов
    cert-*Проверки, соответствующие стандартам CERT
    clang-analyzer-*Проверки, основанные на статическом анализаторе Clang
    concurrency-*Проверки многопоточности и параллелизма
    cppcoreguidelines-*Проверки, соответствующие C++ Core Guidelines
    darwin-*Проверки для macOS/iOS-разработки
    fuchsia-*Проверки для Fuchsia OS
    google-*Проверки, соответствующие Google C++ Style Guide
    hicpp-*Проверки, соответствующие High Integrity C++ Coding Standard
    linuxkernel-*Проверки для ядра Linux
    llvm-*Проверки для кода LLVM
    modernize-*Проверки для модернизации кода (C++11/14/17/20)
    mpc-*Проверки для MISRA C++
    objc-*Проверки для Objective-C
    openmp-*Проверки для OpenMP
    performance-*Оптимизация производительности
    portability-*Проверки переносимости кода
    readability-*Проверки читаемости кода
    zircon-*Проверки для Zircon OS

    Примеры популярных проверок

    ПроверкаОписание
    modernize-use-autoЗаменяет явные типы на auto
    modernize-loop-convertПреобразует for-циклы в range-based
    modernize-use-nullptrЗаменяет NULL на nullptr
    modernize-use-overrideДобавляет override к переопределённым методам
    readability-braces-around-statementsПроверяет наличие фигурных скобок
    readability-identifier-namingПроверяет стиль именования переменных
    performance-unnecessary-copy-initializationОбнаруживает лишние копирования
    bugprone-exception-escapeПроверяет утечку исключений
    cppcoreguidelines-avoid-magic-numbersЗапрещает "магические числа"
    clang-analyzer-*Включает статический анализ Clang

    Как включить/отключить проверки?

    1. Через .clang-tidy файл (рекомендуется):
      Checks: >
        modernize-*,
        performance-*,
        readability-*,
        -modernize-use-trailing-return-type,  # отключение конкретной проверки
        -readability-braces-around-statements  # отключение проверки
      
    2. Через командную строку:
      clang-tidy file.cpp --checks='modernize-*,performance-*,-modernize-use-trailing-return-type'
      
    3. Через clangd (если он интегрирован в IDE):
      # В .clangd
      ClangTidy:
        Add: [modernize-*, performance-*]
        Remove: [modernize-use-trailing-return-type]
      

    Как узнать все доступные проверки?

    Выполните команду:

    clang-tidy --list-checks
    

    Это выведет полный список всех доступных проверок.

    Примеры настройки .clang-tidy

    1. Базовая настройка

    Checks: >
      modernize-*,
      performance-*,
      readability-*,
      -modernize-use-trailing-return-type
    

    2. С настройками именования

    Checks: 'readability-identifier-naming'
    CheckOptions:
      readability-identifier-naming.ClassCase: CamelCase
      readability-identifier-naming.FunctionCase: lower_case
    

    3. С настройками для C++ Core Guidelines

    Checks: 'cppcoreguidelines-*'
    CheckOptions:
      cppcoreguidelines-avoid-magic-numbers.IgnoredNumbers: '0,1,2,3,4,5,6,7,8,9,10'
    

    Вывод

    clang-tidy предоставляет гибкие настройки для анализа кода. Вы можете включать/отключать проверки, настраивать их параметры и адаптировать под свой стиль кодирования. Если вам нужны конкретные проверки, уточните, и я помогу с настройкой! 🚀

  5. User

    -header-filter=... как добавить это? Я использую clangd и vscode

  6. Assistant

    В clangd и clang-tidy параметр --header-filter используется для ограничения анализа только определёнными заголовочными файлами. Это полезно, если вы хотите, чтобы clang-tidy проверял только ваши собственные файлы, а не системные или сторонние библиотеки.

    Как добавить --header-filter в clangd + VS Code?

    1. Через .clang-tidy файл (рекомендуется)

    Создайте файл .clang-tidy в корне проекта и укажите HeaderFilterRegex:

    Checks: 'modernize-*,performance-*,readability-*'
    HeaderFilterRegex: '.*'  # Проверять все файлы (по умолчанию)
    # Или более строгий фильтр, например:
    HeaderFilterRegex: '^((?!/usr/include|/usr/local/include).)*$'  # Исключить системные пути
    

    2. Через settings.json в VS Code

    Если вы используете clangd в VS Code, можно передать параметры clang-tidy через настройки:

    {
      "clangd.arguments": [
        "--clang-tidy",
        "--clang-tidy-config=./.clang-tidy",
        "--header-filter=.*"  // Или более сложный regex
      ]
    }
    

    Пример с исключением системных путей:

    {
      "clangd.arguments": [
        "--clang-tidy",
        "--clang-tidy-config=./.clang-tidy",
        "--header-filter=^((?!/usr/include|/usr/local/include).)*$"
      ]
    }
    

    3. Через compile_flags.txt (если используется)

    Если у вас есть compile_flags.txt, можно добавить:

    --clang-tidy
    --header-filter=.*  # Или более сложный regex
    

    Примеры HeaderFilterRegex

    Регулярное выражениеОписание
    .*Проверять все файлы (по умолчанию)
    ^((?!/usr/include).)*$Исключить системные заголовочные файлы (/usr/include)
    ^((?!/usr/local/include).)*$Исключить /usr/local/include
    ^.*/src/.*Проверять только файлы в папке src
    ^.*/include/.*Проверять только файлы в папке include

    Проверка работы

    1. Откройте файл в VS Code.
    2. Проверьте вывод clangd в панели "Output" (выберите clangd в списке).
    3. Убедитесь, что clang-tidy применяется только к нужным файлам.

    Вывод

    • Лучший способ – использовать .clang-tidy с HeaderFilterRegex.
    • Альтернатива – передать --header-filter через clangd.arguments в VS Code.
    • Регулярные выражения позволяют гибко настраивать фильтрацию файлов.

    Если у вас есть конкретные пути, которые нужно исключить, уточните, и я помогу с настройкой! 🚀

  7. User

    Checks: | , -cppcoreguidelines-non-private-member-variables-in-classes, -readability-math-missing-parentheses, -readability-convert-member-functions-to-static, -misc-non-private-member-variables-in-classes, -cppcoreguidelines-owning-memory, -readability-implicit-bool-conversion, -readability-identifier-length, -cppcoreguidelines-avoid-magic-numbers, -readability-magic-numbers, -readability-redundant-member-init, -readability-redundant-access-specifiers, -readability-redundant-string-init, -misc-use-anonymous-namespace, -cppcoreguidelines-pro-type-union-access, -cppcoreguidelines-pro-bounds-array-to-pointer-decay, -hicpp-no-array-decay, -hicpp-signed-bitwise, -hicpp-named-parameter, -readability-named-parameter, -misc-no-recursion, -performance-no-automatic-move, -cppcoreguidelines-pro-type-vararg, -hicpp-vararg, -google-runtime-references, -fuchsia-default-arguments-, -performance-enum-size, -modernize-use-trailing-return-type, -abseil-, -altera-, -android-, -boost-, -linuxkernel-, -llvm-, -llvmlibc-, -mpi-, -objc-, -openmp-, -zircon-* HeaderFilterRegex: '.*' Правильно?

  8. Assistant

    Ваш конфигурационный файл .clang-tidy выглядит почти правильно, но есть несколько моментов, которые стоит уточнить.

    1. Форматирование Checks

    В YAML-формате важно соблюдать отступы и синтаксис. Ваш вариант с | (многострочный литерал) корректен, но можно сделать его более читаемым:

    Checks: >
      *,
      -cppcoreguidelines-non-private-member-variables-in-classes,
      -readability-math-missing-parentheses,
      -readability-convert-member-functions-to-static,
      -misc-non-private-member-variables-in-classes,
      -cppcoreguidelines-owning-memory,
      -readability-implicit-bool-conversion,
      -readability-identifier-length,
      -cppcoreguidelines-avoid-magic-numbers,
      -readability-magic-numbers,
      -readability-redundant-member-init,
      -readability-redundant-access-specifiers,
      -readability-redundant-string-init,
      -misc-use-anonymous-namespace,
      -cppcoreguidelines-pro-type-union-access,
      -cppcoreguidelines-pro-bounds-array-to-pointer-decay,
      -hicpp-no-array-decay,
      -hicpp-signed-bitwise,
      -hicpp-named-parameter,
      -readability-named-parameter,
      -misc-no-recursion,
      -performance-no-automatic-move,
      -cppcoreguidelines-pro-type-vararg,
      -hicpp-vararg,
      -google-runtime-references,
      -fuchsia-default-arguments-*,
      -performance-enum-size,
      -modernize-use-trailing-return-type,
      -abseil-*,
      -altera-*,
      -android-*,
      -boost-*,
      -linuxkernel-*,
      -llvm-*,
      -llvmlibc-*,
      -mpi-*,
      -objc-*,
      -openmp-*,
      -zircon-*
    

    2. HeaderFilterRegex

    Ваш вариант HeaderFilterRegex: '.*' корректен, но он означает, что clang-tidy будет проверять все файлы, включая системные заголовочные файлы (/usr/include, /usr/local/include и т. д.).

    Если вы хотите исключить системные файлы, лучше использовать:

    HeaderFilterRegex: '^((?!/usr/include|/usr/local/include|/opt/homebrew/include).)*$'
    

    (замените пути на те, которые используются в вашей системе).

    3. Проверка корректности YAML

    Убедитесь, что файл .clang-tidy имеет правильный формат YAML. Например, если у вас есть дополнительные настройки (например, CheckOptions), они должны быть на том же уровне отступа:

    Checks: >
      *,
      -some-check
    HeaderFilterRegex: '.*'
    CheckOptions:
      readability-identifier-naming.ClassCase: CamelCase
    

    4. Проверка работы

    1. Откройте файл в VS Code.
    2. Проверьте вывод clangd в панели "Output" (выберите clangd в списке).
    3. Убедитесь, что clang-tidy применяется только к нужным файлам.

    Вывод

    • Ваш .clang-tidy корректен, но можно улучшить форматирование.
    • HeaderFilterRegex: '.*' работает, но лучше ограничить проверку только своими файлами.
    • Убедитесь, что YAML-синтаксис правильный (отступы, отсутствие лишних символов).

    Если у вас есть дополнительные настройки, уточните, и я помогу их добавить! 🚀

Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.