cmake tidy

Cmake-Tidy

Оглавление

• 1. Введение
• 2. Использование приложения
  • 2.1. format подкоманда
  • 2.2. analyze подкоманду
• 3. Известные ограничения/ошибки
• 4. Другая информация
  • 4.1. Установка
  • 4.2. Статус CI

1. Введение

Целью проекта является предоставление набора инструментов, которые облегчат процесс разработки для систем сборки, написанный в CMake . Основные идеи инструмента, но не ограничены:

• Форматирование кода CMake - на основе анализа синтаксиса языка

• Современный статический анализ CMake - базовый анализ кода с возможной автоматической фиксированием.

• Большая гибкость конфигурации - как стили кодирования отличаются.

• Легко в использовании-имитируйте использование и параметры с другими современными инструментами для снижения кривой обучения для пользователей.

2. Использование приложения

cmake-tidy -это приложение командной строки, написанное в python3 .

Доступные подкоманды:

 usage: cmake-tidy [-h] {format} ...

optional arguments:
  -h, --help  show this help message and exit

sub-commands:
  {format}    see "cmake-tidy <command> --help" to read more about a specific
              sub-command.
    format    format file to align it to standard

2.1. format подкоманда

2.1.1. Использование

 usage: cmake-tidy format [-h] [--dump-config] [-i] [--diff] [--verbose]
                         [input [input ...]]

positional arguments:
  input          CMake file to be formatted

optional arguments:
  -h, --help     show this help message and exit
  --dump-config  Dump to stdout current settings. Script tries to read
                 settings from `.cmake-tidy.json` or provides default
                 settings. Precedence of searching `.cmake-tidy.json` is
                 described on github
  -i, --inplace  Inplace edit specified <input_data> file
  --diff         Print to stdout unified diff between original file and
                 formatted version.
  --verbose      Print to stdout information about formatted file 

2.1.2. Конфигурация

Пользователь может предоставить альтернативные настройки приложения, предоставив пользовательский файл .cmake-tidy.json . Для получения дополнительной информации о доступных параметрах и значениях посетите здесь .

2.2. analyze подкоманду

Введение продолжается.

3. Известные ограничения/ошибки

• Приложение может форматировать только действительные файлы cmake (синтаксические ошибки приводят к выходу приложения без изменения содержания форматированного файла).

• Поддержка deprecated ключевых слов/свойств для более старой версии CMAKE, чем указанная в команде --version , может быть ограничена. Если вам нужно их поддержать, пожалуйста, предоставьте их запрос или указайте их как пользовательские ключевые слова в файле конфигурации .cmake-tidy.json .

• Продолжение линии обработка не реализована.

4. Другая информация

4.1. Установка

Инструмент доступен через индекс пакетов Python с использованием команды:

python3 -m pip install cmake-tidy

Для подтверждения установки была успешной, вы можете запустить:

cmake-tidy -v

4.2. Статус CI

Автоматизированное тестирование выполняется с рабочими процессами:

• ubuntu-lastest, python-3.8

• windows-lastest, python-3.8