cit

CIT - Kontrolnya

Kontrol kode C ++ Anda menggunakan template integrasi kontinu ini.

CIT - adalah templat proyek untuk pengembangan basis kode C ++. Ini agregat linter, alat analisis statis dan dinamis dalam template tunggal, siap digunakan.

Tujuan Utama Proyek

• Jelajahi kemampuan alat otomatis dan dampaknya terhadap pengembangan

• Berikan pengguna akses terpadu proyek ke linter dan alat analisis

• Teknik showcase untuk menguji berbagai properti basis kode

• Menyediakan build dan lingkungan yang dapat direproduksi melalui Docker dan Nix

• Mendorong sikap yang bertanggung jawab terhadap pengembangan perangkat lunak berkualitas

Fitur

• Repositori ini menyediakan lingkungan pengembangan dan pengujian yang dapat direproduksi dengan versi yang disematkan berkat Docker dan Nix

• Dukungan kompiler C ++ utama, dengan semua pemeriksaan waktu kompilasi diaktifkan

• Pengaturan build lintas platform yang sudah dikenal menggunakan cmake dan conan

• Tes runtime dengan dokter dan pembersih

• Alat baris perintah untuk menyederhanakan penggunaan fungsionalitas

  

• Banyak Linters, Formatters dan Static Analysis Tools Terpadu dan Setup Untuk Setiap Aspek Proyek dengan Laporan Informatif Berkat Integrasi Dengan Versi Patched Megalinter

  

• Anda tidak perlu menatap log alat mentah, terima kasih kepada Codechecker Anda dapat memeriksa tabel ringkasan, statistik untuk proyek dan laporan di browser Anda

• Bahkan jika Anda tidak dapat menjalankannya secara lokal - itu bukan masalah. Siap Menggunakan Pengaturan GitHub CI dengan cek yang sama dan laporan diunggah sebagai artefak

• Permintaan tarik tidak akan lewat jika linters menemukan beberapa masalah

  

• ReviewDog Komentar CPP Linters Output Dalam Permintaan Tarik

  

• Saran Linters dan Perbaikan Otomatis juga ditampilkan oleh ReviewDog sebagai saran dalam permintaan tarik

  

• Tarik meminta umpan balik dengan hasil serat sebagai komentar: contoh. Ketika tidak ada masalah tersisa dengan PR Anda akan melihat pesan yang diperbarui dari bot

  

• Cakupan Kode dengan Laporan Codecov Permintaan Tarik

  

• Semua artefak dengan log tersedia untuk diunduh dari CI

Status saat ini

Proyek ini sedang dikembangkan, mengharapkan perubahan API, pengaturan, dan alat. Ini menggunakan serangkaian aturan dan konvensi yang opinial untuk proyek, jangan ragu untuk mengubah file konfigurasi yang paling sesuai dengan kebutuhan pribadi Anda. Anda dapat membayar dan bermain dengannya, kontribusi untuk kode sumber, masalah dan permintaan dipersilakan.

Memulai

Anda dapat menggunakan templat ini dalam berbagai tingkat integrasi dengan lingkungan pengguna. Dari menggunakan editor teks dan menjalankan semua cek di CI, hingga menggunakan gambar Docker yang disiapkan atau nix-shell dan menjalankan periksa secara lokal.

1. Fork Project ini, aktifkan tindakan github dan edit dengan editor github atau dengan editor teks lokal

2. Proyek menggunakan cmake ninja dan conan. Jika Anda menginstalnya di sistem Anda, Anda dapat membangun dan menjalankan tes seperti halnya proyek CMake lainnya. Atau jalankan skrip pesta ini dari root proyek untuk membangun proyek dengan GCC:

      ci/builders/gcc/build.sh

3. Untuk menggunakan proyek ini secara lokal ke potensi penuh Anda memiliki opsi:

• Instal Docker daripada Anda dapat menggunakan gambar Docker yang sudah disiapkan. Panggil skrip ini dari root proyek untuk menjalankan Bash Shell di dalam gambar Docker

     ci/docker/run_shell.sh

• Instal Nix Package Manager atau gunakan Nixos. Dalam hal ini panggilan nix-shell

     nix-shell

Penggunaan

Oke. Anda mendapatkan lingkungan Anda dengan gambar Docker atau dengan nix-shell, mari kita lihat apa yang akan terjadi selanjutnya. Untuk memudahkan penggunaan proyek yang kami gunakan adil. Jadi kita bisa menyebutnya seperti itu:

   just

Anda akan melihat resep (tindakan) yang tersedia yang dapat Anda lakukan untuk menggunakan proyek:

Mari kita menjelajahi fungsi utama. Anda dapat membangun proyek dengan gcc atau clang compiler menggunakan perintah:

   just build-gcc

   just build-clang

Untuk menjalankan semua linter pada penggunaan proyek Anda:

   just lint-all

Untuk menjalankan linter spesifik pada proyek Anda, gunakan perintah lint-with dengan nama deskriptor dan linter semua capital case dibagi oleh garis bawah. Jadi jika kami ingin menjalankan clang-redy dari deskriptor CPP kami menelepon:

   just lint-with CPP_CLANG_TIDY

Dan kita akan melihat laporan satu linter:

Setelah berbaris, Anda dapat memeriksa folder laporan dengan semua log dari linters.

Dari gambar Nix-Shell atau Docker Anda juga dapat membangun gambar Docker sendiri. Nix digunakan untuk membangun arsip tar secara reproduksi dengan gambar Docker yang berisi semua linter

   just docker-build

Anda dapat memeriksa bahwa hasil yang diproduksi memiliki jumlah hash yang sama dengan hasil yang dihasilkan oleh CI:

   sha256sum result

Gambar docker dari dimuat dari hasil:

   just docker-load

Atau Anda dapat menjalankan Docker-update-secara lokal untuk melakukan pembuatan gambar, sha256sum dan memuat dalam perintah tunggal:

   just docker-update-locally

Perintah Docker-update akan membangun gambar dan mengunggahnya ke Docker-Hub:

   just docker-update

Untuk melihat semua pekerjaan dalam, lihatlah di justfile untuk skrip bash konkret untuk setiap tindakan. Periksa file alur kerja GitHub untuk pengaturan GitHub CI.

Alat yang tersedia

• layanan online

  • Tindakan GitHub - Periksa/Bangun/Jalankan Tes
  • Codecov - Verifikasi Cakupan Kode Tes
  • LGTM - Bangun dan analisis kode sumber
  • Dependabot - Periksa Dependensi

• Perintah Konsol Terpadu

  • Just - CC0 1.0 Universal

• git

  • git - gplv2, lgplv2.1
  • Git -Sizer - MIT
  • Conerv - mpl2.0
  • Commitlint - MIT
  • Gitlint - MIT
  • Git -Lint - Apache 2.0
  • Gitleaks - MIT

• lisensi

  • Reuse - Apache -2.0

• file dan direktori

  • LS -Lint - MIT

• ejaan

  • CSPELL - MIT
  • Codespell - GPLV.2.0

• Analisis statis CPP

  • Clang - Peringatan sebagai Periksa Kesalahan - Apache 2.0
  • Cloat -format - NCSA
  • Clang -Tidy - NCSA
  • CPPCHECK - GPLV3.0
  • CPPLINT - BSD 3 Clause
  • GCC - Peringatan sebagai Periksa Kesalahan - GPLV3.0

• Analisis Dinamis CPP

  • Clang - Sanitizers - Apache 2.0
  • GCC - Sanitizers - GPLV3.0
  • GRCOV - Cakupan Kode - MPL -2.0

• Contoh CPP tentang Penggunaan Perpustakaan

  • Doctest - MIT
  • Hasil - Apache -2.0

• cmake

  • CMAKE-FALMAT GPLV3.0
  • cmake-lint gplv3.0

• kerang

  • Shellcheck - GPLV3.0

• nix

  • nixpkgs-fmt-Apache-2.0
  • NIX-LINTER-BSD 3 Clause
  • Lisensi Nix-Shell-LGPL-2.1

• file MD

  • Komentar - MIT
  • TextLint - MIT

• yaml

  • Yamllint - GPLV3.0

Berencana

• Alat CPP

  • JSCPD - MIT
  • Valgrind - GPLV2.0
  • Libfuzzer - NCSA
  • doxygen - gplv2.0
  • Standardese - MIT
  • MULL - Apache -2.0
  • mutate_cpp - mit
  • RapidCheck-BSD-2-Clause
  • Clazy - LGPLV2
  • infer - mit
  • Studio PVS

• Kompiler CPP

  • MSVC - Microsoft Eula
  • Mingw - GNU GPL

• lingkungan CI

  • MacOS
  • Windows

• Contoh Penggunaan Perpustakaan

  • qt6
  • OpenSSL - Apache -2.0
  • GSL -Lite - MIT

• Pengujian GUI

  • Sikulix1 - MIT

• pengujian build yang dapat direproduksi

  • SHA256SUM - GPL -3.0

• Perintah Konsol Terpadu

  • Husky - MIT

• pengujian persetujuan

  • Persetujuantests.cpp - Apache -2.0

• Microbenchmarking

• Kompilasi pembandingan waktu

• wiki tentang proyek

• logo dan ilustrasi

• Versi dan tag rilis yang stabil

• peta jalan

Kredit

Terima kasih banyak kepada kontributor. Anda dapat melihat kontributor dalam kredit.

Lisensi

Template CIT dirilis berdasarkan ketentuan lisensi MIT. Lihat lisensi untuk informasi lebih lanjut.