cit

CIT - السيطرة عليه

التحكم في رمز C ++ الخاص بك باستخدام قالب التكامل المستمر هذا.

CIT - هو قالب مشروع لتطوير قاعدة كود C ++. يجمع بين المبيدات ، وأدوات التحليل الثابتة والديناميكية في واحد ، جاهزة لاستخدام قالب.

الأهداف الرئيسية للمشروع

• استكشاف قدرات الأدوات التلقائية وتأثيرها على التطوير

• امنح مستخدمي الوصول إلى المشروع الوصول إلى المبيدات وأدوات التحليل

• عرض تقنيات اختبار خصائص مختلفة من قاعدة كودس

• توفير بنيات وبيئات قابلة للتكرار من خلال Docker و Nix

• تشجيع الموقف المسؤول تجاه تطوير برامج الجودة

سمات

• يوفر هذا المستودع بيئات التطوير والاختبار القابلة للتكرار مع إصدار يعلق على Docker و Nix

• دعم المترجمين الرئيسيين C ++ ، مع تمكين جميع عمليات فحص وقت الترجمة

• إعداد إنشاء منصة مألوفة باستخدام Cmake و Conan

• اختبارات وقت التشغيل مع الدكتوراه والمعقدة

• أداة سطر الأوامر لتبسيط استخدام الوظائف

  

• تم دمج الكثير من المبيدات والأدوات التنسيق وأدوات التحليل الثابت وإعدادها لكل جانب من جوانب المشروع مع تقارير إعلامية بفضل التكامل مع إصدار مصحح من MegalInter

  

• لا تحتاج إلى التحديق في سجلات الأدوات الخام ، وذلك بفضل CodeChecker ، يمكنك التحقق من الجداول الملخص والإحصائيات للمشروع والتقارير في متصفحك

• حتى لو لم تتمكن من تشغيله محليًا - فهذه ليست مشكلة. جاهز لاستخدام إعداد Github CI مع نفس الشيكات والتقارير التي تم تحميلها على أنها مصنوعات أثرية

• لن تمر طلبات السحب إذا وجدت المبيدات بعض المشكلات

  

• ReviewDog Comments CPP Binters الإخراج في طلب السحب

  

• يتم أيضًا عرض اقتراحات Binsters وإصلاحات السيارات بواسطة ReviewDog كاقتراحات في طلب السحب

  

• سحب طلبات التغذية المرتدة بنتائج linting كتعليق: مثال. عندما لا توجد مشكلات متبقية مع العلاقات العامة ، سترى رسالة محدثة من الروبوت

  

• تغطية الرمز مع تقارير طلب السحب Codecov

  

• جميع القطع الأثرية مع سجلات متاحة للتنزيل من CI

الوضع الحالي

هذا المشروع قيد التطوير ، ويتوقع تغييرات في API والإعداد والأدوات. ويستخدم مجموعة من القواعد والاتفاقيات للمشروع ، لا تتردد في تغيير ملفات التكوين لتناسب احتياجاتك الشخصية بشكل أفضل. يمكنك أن تتفوق واللعب معها ، والمساهمات في الكود المصدري ، والمشكلات والطلبات موضع ترحيب.

ابدء

يمكنك استخدام هذا القالب في مستويات مختلفة من التكامل مع بيئة المستخدم. من استخدام محرر النصوص وتشغيل جميع عمليات الفحص في CI ، حتى استخدام صورة Docker المعدة أو NIX-Shell وتشغيل التحقق محليًا.

1. شوك هذا المشروع ، تمكين إجراءات github وتحريره إما مع محرر Github أو مع محرر النص المحلي

2. مشروع استخدام Cmake Ninja و Conan. إذا قمت بتثبيتها على نظامك ، فيمكنك إنشاء الاختبارات وتشغيلها كما هو الحال مع أي مشروع CMAKE آخر. أو قم بتشغيل هذا البرنامج النصي Bash من Root of Project لبناء المشروع باستخدام GCC:

      ci/builders/gcc/build.sh

3. لاستخدام هذا المشروع محليًا إلى الإمكانات الكاملة ، لديك خيارات:

• تثبيت Docker مما يمكنك استخدام صورة Docker المعدة. اتصل بهذا البرنامج النصي من Root of Project لتشغيل قذيفة Bash داخل صورة Docker

     ci/docker/run_shell.sh

• تثبيت NIX Package Manager أو استخدم Nixos. في هذه الحالة ، اتصل بـ nix-shell

     nix-shell

الاستخدام

تمام. لقد حصلت على بيئتك إما مع صورة Docker أو مع Nix-Shell ، دعنا نلقي نظرة على ما هو التالي. لتخفيف استخدام المشروع نستخدمه فقط. لذلك يمكننا أن نسميها هكذا:

   just

سترى الوصفات (الإجراءات) المتاحة التي يمكنك القيام بها لاستخدام المشروع:

دعونا نستكشف الوظائف الرئيسية. يمكنك بناء المشروع باستخدام برنامج التحويل البرمجي لـ GCC أو Clang باستخدام الأوامر:

   just build-gcc

   just build-clang

لتشغيل جميع المبيدات في مشروعك استخدام:

   just lint-all

لتشغيل Linter محدد في مشروعك ، استخدم أمر LINT-WITH مع اسم الواصف و LINTER CAPENT CASE CASE CLESS بواسطة Sewrerscores. لذلك إذا أردنا تشغيل clang-tidy من واصف CPP نسميه:

   just lint-with CPP_CLANG_TIDY

وسنرى تقريرًا عن Linter واحد:

بعد الابتكار ، يمكنك التحقق من مجلد التقرير مع جميع السجلات من المبيدات.

من صورة Nix-Shell أو Docker ، يمكنك أيضًا إنشاء صورة Docker بنفسك. يستخدم Nix لبناء أرشيف القطران بشكل مستنسخ مع صورة Docker التي تحتوي

   just docker-build

يمكنك التحقق

   sha256sum result

صورة Docker من التحميل من النتيجة:

   just docker-load

أو يمكنك تشغيل Docker-update-Locally للقيام بإنشاء الصور ، SHA256SUM وتحميله في أمر واحد:

   just docker-update-locally

سيقوم الأمر Docker-update ببناء الصورة وتحميلها إلى Docker-Hub:

   just docker-update

لمشاهدة جميع الأعمال الداخلية ، ألقِ نظرة في Justfile على البرامج النصية الملموسة لكل إجراء. تحقق من ملف GitHub Workflows لإعداد GitHub CI.

الأدوات المتاحة

• الخدمات عبر الإنترنت

  • إجراءات github - فحص/إنشاء/تشغيل الاختبارات
  • Codecov - تحقق من تغطية الكود من الاختبارات
  • LGTM - بناء وتحليل رمز المصدر
  • تعتمد على التبعيات - تحقق من التبعيات

• أوامر وحدة التحكم الموحدة

  • فقط - CC0 1.0 Universal

• غيت

  • GIT - GPLV2 ، LGPLV2.1
  • Git -Sizer - MIT
  • مطابق - MPL2.0
  • الالتزام - معهد ماساتشوستس للتكنولوجيا
  • Gitlint - معهد ماساتشوستس للتكنولوجيا
  • Git -Lint - Apache 2.0
  • Gitleaks - معهد ماساتشوستس للتكنولوجيا

• التراخيص

  • إعادة الاستخدام - Apache -2.0

• الملفات والأدلة

  • LS -Lint - معهد ماساتشوستس للتكنولوجيا

• تهجئة

  • Cspell - معهد ماساتشوستس للتكنولوجيا
  • Codespell - GPLV.2.0

• CPP تحليل ثابت

  • Clang - تحذيرات كما تحقق الأخطاء - Apache 2.0
  • clang -format - NCSA
  • Clang Tidy - NCSA
  • CPPCHECK - GPLV3.0
  • CPPLINT - BSD 3 -CAUSE
  • GCC - تحذيرات كما تحكي الأخطاء - GPLV3.0

• CPP التحليل الديناميكي

  • Clang - المطهرات - Apache 2.0
  • GCC - المطهرات - GPLV3.0
  • GRCOV - تغطية الكود - MPL -2.0

• أمثلة CPP على استخدام المكتبة

  • Doctest - معهد ماساتشوستس للتكنولوجيا
  • النتيجة - Apache -2.0

• cmake

  • cmake-format gplv3.0
  • Cmake-Lint GPLV3.0

• صدَفَة

  • Shellcheck - GPLV3.0

• نيكس

  • Nixpkgs-FMT-Apache-2.0
  • NIX-LINTER-BSD 3-CAUSE
  • ترخيص Nix-Shell-LGPL-2.1

• ملفات MD

  • ملاحظة - معهد ماساتشوستس للتكنولوجيا
  • textlint - معهد ماساتشوستس للتكنولوجيا

• يامل

  • Yamllint - GPLV3.0

المخطط

• أدوات CPP

  • JSCPD - معهد ماساتشوستس للتكنولوجيا
  • Valgrind - GPLV2.0
  • Libfuzzer - NCSA
  • Doxygen - GPLV2.0
  • المعيار - معهد ماساتشوستس للتكنولوجيا
  • مول - أباتشي -2.0
  • mutate_cpp - معهد ماساتشوستس للتكنولوجيا
  • Rapidcheck-BSD-2-CAUSE
  • Clazy - LGPLV2
  • استنتاج - معهد ماساتشوستس للتكنولوجيا
  • PVS Studio

• المترجمين CPP

  • MSVC - Microsoft Eula
  • Mingw - GNU GPL

• بيئات CI

  • ماكوس
  • النوافذ

• أمثلة على استخدام المكتبة

  • QT6
  • Openssl - Apache -2.0
  • GSL -Lite - معهد ماساتشوستس للتكنولوجيا

• اختبار واجهة المستخدم الرسومية

  • Sikulix1 - معهد ماساتشوستس للتكنولوجيا

• يبني القابلة للتكرار اختبار

  • SHA256SUM - GPL -3.0

• أوامر وحدة التحكم الموحدة

  • أجش - معهد ماساتشوستس للتكنولوجيا

• اختبار الموافقة

  • موافقة

• Microbenchmarking

• ترجمة وقت القياس

• ويكي عن المشروع

• الشعار والرسوم التوضيحية

• إصدارات الإصدار المستقر والعلامات

• خريطة الطريق

الاعتمادات

شكرا جزيلا للمساهمين. يمكنك رؤية المساهمين في الاعتمادات.

رخصة

قالب CIT الذي تم إصداره بموجب شروط ترخيص معهد ماساتشوستس للتكنولوجيا. انظر الترخيص لمزيد من المعلومات.