Unduh cmake tidy - cmake tidy CMake

cmake tidy

Kategori lainnya

Official beta release

Unduh

cmake-ridy

Daftar isi

1. Pendahuluan
2. Penggunaan aplikasi
- 2.1. Sub -perintah format
- 2.2. analyze sub -perintah
3. Keterbatasan/Bug yang Diketahui
4. Informasi lainnya
- 4.1. Instalasi
- 4.2. Status CI

1. Pendahuluan

Tujuan proyek adalah untuk menyediakan serangkaian alat yang akan memudahkan proses pengembangan untuk kode sistem build yang ditulis dalam CMake . Gagasan utama alat ini tetapi tidak terbatas pada:

Format Kode CMake - Berdasarkan analisis sintaksis bahasa
Analisis Statis CMake Modern - Analisis Kode Dasar dengan kemungkinan pengikat otomatis.
Fleksibilitas konfigurasi yang besar - karena gaya pengkodean sangat berbeda.
Mudah digunakan-Penggunaan dan parameter meniru dengan alat canggih lainnya untuk mengurangi kurva pembelajaran bagi pengguna.

2. Penggunaan aplikasi

cmake-tidy adalah aplikasi baris perintah yang ditulis dalam python3 .

Sub -perintah yang tersedia:

 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. Sub -perintah `format`

2.1.1. Penggunaan

 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. Konfigurasi

Pengguna dapat memberikan pengaturan alternatif ke aplikasi dengan menyediakan file .cmake-tidy.json khusus. Untuk informasi lebih lanjut tentang parameter dan nilai yang tersedia, kunjungi di sini .

2.2. `analyze` sub -perintah

Pendahuluan sedang berlangsung.

3. Keterbatasan/Bug yang Diketahui

Aplikasi hanya dapat memformat file cmake yang valid (kesalahan sintaksis menyebabkan aplikasi keluar tanpa memodifikasi konten file yang diformat).
Dukungan untuk kata kunci/properti deprecated untuk versi CMake yang lebih lama dari yang ditentukan dalam perintah --version mungkin terbatas. Jika Anda perlu mendukungnya, berikan permintaan tarik atau tentukan sebagai kata kunci khusus di file konfigurasi .cmake-tidy.json .
Lining Continuation Handling tidak diimplementasikan.