cmake init

cmake-init - مُهيئ مشروع Cmake المفقود

cmake-init هو مُهيئ مشروع CMAKE الذي يولد مشاريع CMAKE التي تجلبها جاهزة ، أهداف مستهلك ومطورين منفصلة ، توفر قواعد التثبيت مع حزم CMAKE القابلة للنقل واستخدام CMAKE الحديثة (3.14+).

يرجى الاطلاع على wiki على سبيل المثال مخرجات cmake-init وغيرها من الأمثلة العملية للوظائف التي تم تنفيذها لـ cmake ، مثل مديري الحزم ، واختبار الزغب ، والبناء الفائق ، إلخ.

تكامل VSCODE مع الحد الأدنى من التكوين باستخدام الإعدادات المسبقة:

تكامل CLION مع الحد الأدنى من التكوين باستخدام الإعدادات المسبقة:

إذا كنت ترغب في الاتصال بي للحصول على أي شيء مرتبط بـ Cmake ، فقد تجدني في قناة #cmake لـ C ++ Slack. إذا كان ما ترغب في معرفته هو Cmake-Init محدد ، فيمكنك أيضًا طرح أسئلة في مناقشات هذا المستودع.

الأهداف

• كن بسيطًا للاستخدام
  يتيح لك البرنامج النصي أن تهرس فقط للحصول على مشروع تم إعداده بشكل صحيح للتنفيذ. تريد مكتبة رأس فقط؟ اختر h عند المطالبة. مكتبة ثابتة/مشتركة؟ فقط اختر s عند المطالبة. بسيط وصحيح !
• إنشاء مشاريع جاهزة FetchContent
  هذا أمر مهم ، لأنه في الميزة القريبة قد يسمح هذا لـ CMake باستهلاك مشاريع أخرى بطريقة تافهة مماثلة للغات الأخرى ، على سبيل المثال في حالة JavaScript (NPM).
• أهداف مطور ومستهلك منفصلة بشكل نظيف
  يرتبط هذا في النقطة السابقة أيضًا ، لكن المطورين والمستهلكين في المشروع لديهم احتياجات مختلفة ، ويحقق أهداف الفصل هذا الهدف. يجب أن يكون المطور قادرًا على إجراء الاختبارات ، وإضافة أعلام التحذير ، وتشغيل المعايير ، وما إلى ذلك ، في حين أن المستهلك ، مثل مشرف الحزمة ، يريد عمومًا بناء المكتبة أو القابلة للتنفيذ نفسها ، دون الحاجة إلى التصحيح في نصوص CMake. إظهار بعض الحب لمحافظين على الحزمة!
• استخدم Cmake الحديثة (3.14+)
  هناك الكثير من الأمثلة الخاطئة التي عفا عليها الزمن على الإنترنت ، لقد حان الوقت لتغيير ذلك.
• اجعل استخدام الأدوات سهلة
  تعد تغطية التعليمات البرمجية (GCOV) ، وبطانة الرمز والتنسيق (clang-format) ، والتحليل الثابت (Clang-Tidy) والتحليل الديناميكي (المطهرات ، Valgrind) كلها طرق مفيدة للغاية لتوجيه المطور في إنشاء برنامج أفضل ، لذلك يجب أن تكون سهلة الاستخدام.

محادثات المؤتمر ذات الصلة

• Kenneth Hoste - كيفية جعل مديري الحزم يبكي
• روبرت شوماخر - لا تحزم مكتباتك ، اكتب مكتبات قابلة للحزم! (الجزء 1)
• روبرت شوماخر - لا تحزم مكتباتك ، اكتب مكتبات قابلة للحزم! (الجزء 2)
• كريج سكوت - CMAKE العميق لمؤلفي المكتبات

غير المميزين

• تغطية كل هيكل مشروع ممكن
  إن القيام بذلك أمر لا معنى له كنصي init ، لأن هناك العديد من الطرق التي كان الناس يقومون ببناءها للبرامج ، وإذا كان لديك احتياجات خاصة ، فيجب أن تعرف بالفعل Cmake ويمكنك إعداد المشروع بنفسك.
• قم بإنشاء ملفات وإظهار نصائح لمواقع الويب الأخرى غير Github
  على الرغم من أنني أفهم الأشخاص الذين يعارضون GitHub (وبوصي Microsoft) ، إلا أنه إلى حد بعيد موقع الويب الأكثر استخدامًا من نوعه ، والملفات والرسائل الخاصة بها صغيرة في العدد ، ويتم تكييفها بسهولة مع أي خدمة أخرى.

ثَبَّتَ

تأكد من تثبيت هذه البرامج:

• بيثون 3.8 أو الأحدث
• Cmake 3.20 أو الأحدث (3.21 أو أحدث لمشاريع C17 أو أحدث)
• غيت
• Clang Tidy 14 (اختياري)
• CppCheck (اختياري)
• doxygen <1.9 (اختياري)
• LCOV (اختياري)
• clang-format 14 (اختياري)
• Codespell (اختياري)
• مديرو الحزم: كونان أو VCPKG (اختياري)

---

ملحوظة

يمكن استخدام بعض هذه الأدوات على Windows أيضًا إذا كنت ترغب في استخدام Visual Studio ، ولكن عليك تثبيت هذه الإضافات:

• https://clangpowertools.com/
• https://github.com/violetgiraffe/cppcheck-vs-addin

---

هذه الحزمة متاحة للتنزيل من PYPI. يمكنك تثبيت هذه الحزمة باستخدام pip :

pip install cmake-init

clang tidy

Clang Tidy هي أداة تحليل ثابت تساعدك على اكتشاف الأخطاء المنطقية في الكود الخاص بك قبل تجميعها. يمنحك هذا البرنامج النصي خيار ورث الإعداد المسبق لـ clang-tidy في الإعداد dev الخاص بك ، مما يتيح تكامل CMake لهذه الأداة.

سيقوم CI دائمًا بتشغيل Clang-Tidy من أجلك ، لذلك من اختياري تمامًا تثبيته واستخدامه محليًا ، ولكن يوصى به.

بالنسبة لمستخدمي Windows ، إذا كنت ترغب في استخدام Clang-Tidy ، فيجب عليك تثبيت Ninja وتعيين حقل generator في dev Preset الخاص بك إلى Ninja . والسبب في ذلك هو أن Makefiles و Ninja فقط مدعومان مع Cmake للاستخدام مع Clang Tidy. بالنسبة للمولدات الأخرى ، هذه الميزة هي عدم وجود op.

cppcheck

CPPCheck هي أداة تحليل ثابتة تشبه Clang-Tidy ، ومع ذلك فإن التداخل في ما يكتشفونه هو الحد الأدنى ، لذلك من المفيد استخدام كلاهما. يمنحك هذا البرنامج النصي خيار ورث الإعداد المسبق cppcheck في الإعداد dev الخاص بك ، مما يتيح تكامل CMAKE لهذه الأداة.

سيقوم CI دائمًا بتشغيل CPPCHECK بالنسبة لك ، لذلك من اختياري تمامًا تثبيته واستخدامه محليًا ، ولكن يوصى به.

بالنسبة لمستخدمي Windows ، إذا كنت ترغب في استخدام CppCheck ، فيجب عليك تثبيت Ninja وتعيين حقل generator في dev Preset الخاص بك إلى Ninja . والسبب في ذلك هو أن Makefiles و Ninja فقط مدعومون مع Cmake للاستخدام مع CppCheck. بالنسبة للمولدات الأخرى ، هذه الميزة هي عدم وجود op.

Doxygen

Doxygen هي أداة لإنشاء وثائق من رمز المصدر المشروح. بالتزامن معها ، يتم استخدام M.CSS لتقديم الوثائق التي تم إنشاؤها.

سيكون للمشاريع التي تم إنشاؤها هدف docs في وضع المطور ، والذي يمكن استخدامه لإنشاء الوثائق في دليل <binary-dir>/docs/html .

بعد تثبيت Doxygen ، يرجى التأكد من وجود doxygen القابل للتنفيذ في PATH ، وإلا فقد تحصل على رسائل خطأ مربكة.

يمكن نشر هذه الوثائق على صفحات github باستخدام وظيفة docs في سير عمل CI الذي تم إنشاؤه. اتبع التعليقات المتبقية في الوظيفة لتمكين هذا.

ملاحظة : لا يعمل M.CSS مع doxygen> = 1.9. يمكنك تثبيت 1.8.20 لاستخدام هدف docs . انظر القضايا رقم 41 و #48.

LCOV

LCOV هي أداة لمعالجة معلومات التغطية التي تم إنشاؤها بواسطة Healformables التي تم صكها مع gcov من GCC. يمكن استخدام معلومات التغطية هذه لمعرفة أجزاء البرنامج التي تم تنفيذها.

سيكون للمشاريع التي تم إنشاؤها هدف coverage في وضع المطور إذا تم تمكين متغير ENABLE_COVERAGE . السبب في استخدام هدف منفصل بدلاً من خطوة coverage المدمجة لـ CTEST هو أنه يفتقر إلى التخصيص اللازم. يجب تشغيل هذا الهدف بعد الاختبارات بشكل افتراضي ، سيقوم بإنشاء تقرير على <binary-dir>/coverage.info وتقرير HTML في دليل <binary-dir>/coverage_html .

بالنسبة لمستخدمي Windows ، يمكنك استخدام أداة مماثلة تسمى OpenCPpCoverage ، والتي يوجد نصي مثال في دليل cmake الذي تم إنشاؤه. يتم ترك هذا البرنامج النصي كمثال ، لأن Linux VM يطلق ويعمل بشكل أسرع في إجراءات GitHub وبالتالي يتم استخدامه لتقديم التغطية.

clang-format

يعد Clang-Format جزءًا من مجموعة Tool LLVM مماثلة لـ Clang-Tidy. إنه رمز Linter و Code Formatter ، والذي يمكن استخدامه لفرض أدلة النمط.

يتم توفير هدفين للتحقق من الرمز وإصلاحه في وضع المطور باستخدام أهداف format-check format-fix على التوالي.

ملاحظة : يقوم المشروع بإنشاء ملفات تم تنسيقها وفقًا لـ Clang-Format 14. قد تقوم الإصدارات الأحدث أو الأقدم بتنسيق المشروع بشكل مختلف.

Codespell

CodeSpell هي أداة للعثور على أخطاء الإملاء وإصلاحها بشكل رئيسي في رمز المصدر.

يتم توفير هدفين للتحقق من أخطاء الإملاء وإصلاحها في وضع المطور باستخدام أهداف spell-check spell-fix على التوالي.

مديري الحزم

يمكن استخدام علامة -p لتحديد مدير الحزمة للمشروع. يمكن أن تكون الحجج الخاصة بالعلم:

• none : لا يوجد تكامل مدير الحزمة (افتراضي)
• conan : تكامل كونان
• vcpkg : تكامل VCPKG

عند استخدام مدير الحزمة ، يتم استخدام الحزم التالية في المشروع الذي تم إنشاؤه:

• FMT لـ C ++ و JSON-C و Hedley (EXE فقط) لمشاريع C
• catch2 كاعتماد DEV لمشاريع C ++ و C

تأكد من قراءة وثيقة القرصنة التي تم إنشاؤها لمعرفة ما يجب القيام به لجلب التبعيات.

الاستخدام

• cmake-init [--c] <path>
  سيقوم هذا الأمر بإنشاء مشروع CMAKE في الموقع المقدم ووفقًا للإجابات المقدمة للمطالبات. يمكنك تمرير أعلام -s أو -e أو -h بعد إنشاء مكتبة مشتركة أو قابلة للتنفيذ أو رأس فقط على التوالي. سيقوم مفتاح --c بتعيين نوع المشروع الذي تم إنشاؤه على C بدلاً من C ++.
• cmake-init --help
  يعرض شاشة المساعدة لمزيد من العلامات والمفاتيح.

الترخيص

cmake-init هو برنامج مجاني: يمكنك استخدام ودراسة ومشاركة وتحسين إرادتك. على وجه التحديد ، يمكنك إعادة توزيع و/أو تعديله بموجب شروط ترخيص GNU العام العام كما تم نشره بواسطة مؤسسة البرمجيات المجانية ، إما الإصدار 3 من الترخيص ، أو (وفقًا لخيارك) أي إصدار لاحق.

يتم ترخيص محتويات الدليل cmake-init/templates باستخدام ترخيص UNLINENS. انظر الترخيص في هذا الدليل لمزيد من التفاصيل.