Sourcetrail

مصدر

ملاحظة مهمة: تمت أرشفة هذا المشروع من قبل المؤلفين الأصليين والمشرفين على Sourcetrail بحلول نهاية عام 2021. إذا كنت تريد معرفة المزيد عن هذا القرار، فاقرأ المزيد على مدونتنا.

Sourcetrail هو مستكشف مصادر مجاني ومفتوح المصدر عبر الأنظمة الأساسية يساعدك على تحقيق الإنتاجية باستخدام كود مصدر غير مألوف.

ويندوز:

لينكس:

روابط

• تحميل
• دليل البدء السريع
• التوثيق
• سجل التغيير

مسار المصدر هو:

• حر
• العمل دون اتصال
• تعمل على أنظمة التشغيل Windows وmacOS وLinux
• دعم C وC++ وJava وPython
• تقديم SDK (SourcetrailDB) لكتابة ملحقات اللغة المخصصة

المصدر على باتريون

أصبح التطوير مفتوح المصدر وإصدارات البرامج المنتظمة ممكنًا بالكامل بفضل دعم هؤلاء المستفيدين الرائعين!

باستخدام سورس تريل

لإعداد Sourcetrail على جهازك، يمكنك إما تنزيل الإصدار المناسب لنظام التشغيل الخاص بك من قائمة الإصدارات لدينا وتثبيته على جهازك، أو استخدام أحد مديري الحزم التاليين:

• استخدم حزمة Chocolatey مع choco install sourcetrail

بعد اكتمال التثبيت، اتبع دليل البدء السريع الخاص بنا للتعرف على Sourcetrail.

كيفية الإبلاغ عن المشكلات

يمكنك نشر جميع طلبات الميزات وتقارير الأخطاء على أداة تعقب المشكلات الخاصة بنا.

إعداد التقارير

استخدم القالب التالي:

• نسخة المنصة:
• نسخة المصدر:
• وصف المشكلة:
• خطوات إعادة إنتاج المشكلة:

دعم

إذا كنت تريد دعم طلب ميزة معينة أو كان لديك نفس الخطأ الذي أبلغ عنه مستخدم آخر بالفعل، فيرجى إخبارنا بذلك:

• قم بنشر تعليق مع "+1" لهذه المشكلة
• أو أرسل بريدًا إلكترونيًا إلى [email protected] مع معرف المشكلة

كيفية المساهمة

• يرجى قراءة واتباع الخطوات الموجودة في ملف CONTRIBUTING.md.
• قد ترغب في البحث عن المشكلات التي تحمل علامة "الإصدار الأول الجيد" للعثور على بعض المهام الأولية التي يجب معالجتها.
• إذا كنت تبحث عن مزيد من المعلومات حول تطوير برامج Sourcetrail، فيرجى الرجوع إلى الويكي الخاص بنا.

كيفية البناء

يتطلب بناء Sourcetrail وجود العديد من التبعيات على جهازك. ومع ذلك، يسمح الإعداد المستند إلى CMake بتعطيل دعم الفهرسة للغات معينة مما يقلل عدد التبعيات إلى الحد الأدنى.

بناء التطبيق الأساسي

الأدوات المطلوبة

• CMake v3.12 (مطلوب لأنظمة التشغيل Windows، وLinux، وMacOS)

  • السبب : يستخدم لإنشاء تكوين بناء لنظام البناء الخاص بك
  • التحميل : https://cmake.org/download

• Git (مطلوب لأنظمة التشغيل Windows وLinux وMacOS)

  • السبب : يستخدم للتحكم في الإصدار ولإنشاء رقم إصدار Sourcetrail تلقائيًا من الالتزامات والعلامات
  • التحميل : https://git-scm.com/download
  • ملاحظات : تأكد من إضافة git إلى متغير بيئة PATH الخاص بك قبل تشغيل CMake

• Visual Studio (مطلوب لنظام التشغيل Windows)

  • السبب : يستخدم لبناء Sourcetrail
  • التحميل : https://visualstudio.microsoft.com/downloads/

• ccache (اختياري لنظامي التشغيل Linux وMacOS)

  • السبب : يستخدم لتسريع عمليات إعادة البناء إذا وجدت في PATH
  • التحميل : https://ccache.dev/download.html

التبعيات المطلوبة

• دفعة 1.67

  • السبب : يستخدم للوصول إلى نظام الملفات والاتصال بين العمليات
  • التنزيل المسبق لنظام التشغيل Windows : https://sourceforge.net/projects/boost/files/boost-binaries/
  • بناء ليونيكس :

     $ ./bootstrap.sh --with-libraries=filesystem,program_options,system,date_time
    $ ./b2 --link=static --variant=release --threading=multi --runtime-link=static --cxxflags=-fPIC
    

• كيو تي 5.12.3

  • السبب : يستخدم لعرض واجهة المستخدم الرسومية ولبدء عمليات (مفهرسة) إضافية.
  • التنزيل المسبق : http://download.qt.io/official_releases/qt/

مبنى

على ويندوز

• لإعداد بيئة البناء الخاصة بك، قم بتشغيل:

   $ git clone https://github.com/CoatiSoftware/Sourcetrail.git
  $ cd Sourcetrail
  $ mkdir -p build/win64
  $ cd build/win64
  $ cmake -G "Visual Studio 15 2017 Win64" -DBOOST_ROOT=<path/to/boost_1_67_0> -DQt5_DIR=<path/to/Qt/version/platform/compiler/lib/cmake/Qt5> ../..
  

  تلميح: إذا كنت تستخدم واجهة المستخدم الرسومية CMake، فنوصيك بتنشيط الوضع المتقدم. قد يُطلب منك أيضًا إضافة بعض التعريفات عبر زر "إضافة إدخال".

• بعد إنشاء تكوين البنية، ما عليك سوى فتح ملف Sourcetrail.sln الذي تم إنشاؤه بواسطة CMake وإنشاء مشروع Sourcetrail.

على يونكس

• لإعداد بيئة البناء الخاصة بك، قم بتشغيل:

   $ cd Sourcetrail
  $ mkdir -p build/Release
  $ cd build/Release
  $ cmake -DCMAKE_BUILD_TYPE="Release" -DBOOST_ROOT=<path/to/boost_1_67_0> -DQt5_DIR=<path/to/Qt/version/platform/compiler/lib/cmake/Qt5> ../..
  

• الآن ابدأ الإنشاء باستخدام:

   $ make Sourcetrail
  

جري

• قم بتشغيل Sourcetrail من داخل دليل البناء. أثناء التنفيذ، يحتاج Sourcetrail إلى موارد من bin/app/data و bin/app/user . يقوم CMake بإنشاء روابط رمزية داخل دليل الإنشاء مما يسهل الوصول إلى هذه الدلائل.

تمكين دعم لغة C/C++

التبعيات المطلوبة

• LLVM/كلانج 11.0.0
  • السبب : يستخدم لتشغيل المعالج المسبق على التعليمات البرمجية المصدر المفهرسة، وبناء شجرة بناء جملة مجردة واجتيازها، وإنشاء رسائل خطأ.
  • المبنى : تأكد من التحقق من العلامة الصحيحة: git checkout llvmorg-11.0.0
  • البناء لنظام التشغيل Windows : اتبع هذه الخطوات لإنشاء المشروع. قم بتشغيل الأمر cmake تمامًا كما هو موضح.
  • Building for Unix : اتبع دليل التثبيت هذا لإنشاء المشروع. تأكد من الإنشاء باستخدام -DLLVM_ENABLE_RTTI=ON .

مبنى

• قم بتشغيل CMake باستخدام هذه الخيارات الإضافية:

   -DClang_DIR=<path/to/llvm_build>/lib/cmake/clang
  -DBUILD_CXX_LANGUAGE_PACKAGE=ON
  

• قم ببناء Sourcetrail كما هو موضح أعلاه.

تمكين دعم لغة جافا

التبعيات المطلوبة

• جى دي كيه 1.8

  • السبب : تم ​​استخدامه لإنشاء مفهرس Java وجعله قابلاً للاستدعاء من كود C++ عبر JNI.
  • ملاحظات : تأكد من توفر <jdk_root>/bin في متغير بيئة PATH الخاص بك ومن تعيين متغير البيئة JAVA_HOME :

     JAVA_HOME=<path/to/Java>/jdk1.x.x_xxx
    

• مخضرم

  • السبب : تم ​​استخدامه ضمن اختبارات Sourcetrail الآلية.
  • ملاحظات : تأكد من توفر .../apache-maven-xxx/bin في متغير بيئة PATH الخاص بك ومن تعيين متغيرات البيئة M2_HOME و MAVEN_HOME :

     M2_HOME=.../apache-maven-x.x.x
    MAVEN_HOME=.../apache-maven-x.x.x
    

مبنى

• قم بتشغيل CMake باستخدام هذه الخيارات الإضافية:

   -DBUILD_JAVA_LANGUAGE_PACKAGE=ON
  

• قم ببناء Sourcetrail كما هو موضح أعلاه.

تمكين دعم لغة بايثون

الأدوات المطلوبة

• 7z (مطلوب لنظام التشغيل Windows)
  • السبب : يستخدم لاستخراج SourcetrailPythonIndexer الذي تم إنشاؤه مسبقًا والذي يتم تنزيله تلقائيًا أثناء تنفيذ الإنشاء.

مبنى

• قم بتشغيل CMake باستخدام هذه الخيارات الإضافية:

   -DBUILD_PYTHON_LANGUAGE_PACKAGE=ON
  

• قم ببناء Sourcetrail كما هو موضح أعلاه.

إنشاء حزمة النشر

ويندوز

الأدوات المطلوبة

• Visual Studio (مطلوب لنظام التشغيل Windows)

  • السبب : تم ​​استخدامه لبناء برنامج تثبيت Sourcetrail Windows.
  • ملاحظات : تأكد من تثبيت عبء عمل .Net desktop development .
  • التحميل : https://visualstudio.microsoft.com/downloads/

• ويكس 3.11

  • السبب : تم ​​استخدامه لإنشاء برنامج تثبيت Windows sourcetrail.msi .
  • ملاحظات : تأكد من إضافة <path/to>/WiX Toolset v3.11/bin إلى متغير بيئة PATH الخاص بك.
  • التحميل : https://wixtoolset.org/releases/

• ملحق Wix لبرنامج Visual Studio

  • السبب : يستخدم لتشغيل Wix من بيئة إنشاء Visual Studio.
  • التنزيل : https://marketplace.visualstudio.com/items?itemName=WixToolset.WixToolsetVisualStudio2017Extension

• جي آر إي

  • السبب : يستخدم لفهرسة مشروع عينة جافا الذي يأتي مع الحزمة.

• وينرار

  • السبب : يُستخدم لإنشاء الملفات المضغوطة النهائية لبرنامج التثبيت والحزمة المحمولة.
  • ملاحظات : تأكد من إضافة <path/to>/WinRAR إلى متغير بيئة PATH الخاص بك.

مبنى

• قم بتشغيل ./script/deploy_windows.sh من موجه أوامر المطور لبرنامج Visual Studio. البرنامج النصي الذي سيقوم بإنشاء إصدار 64 بت ويحزمه في ملف .zip محمول ومثبت Windows يستند إلى Wix.

ماك

بعد البناء، قم بتشغيل البرنامج النصي bundle_install.sh داخل دليل البناء الذي سيؤدي إلى إنشاء حزمة Sourcetrail.app وإنشاء حاوية Sourcetrail_<version>.dmg .

لينكس

قم بتشغيل ./setup/Linux/createPackages.sh من الدليل الرئيسي، مما يؤدي إلى إنشاء حزمة .tar.gz و .AppImage في الدليل الرئيسي. التغليف يعتمد على linuxdeployqt.

كيفية تشغيل الاختبارات

يتم تشغيل مجموعة الاختبار الآلي لـ Sourcetrail بواسطة Catch2. لإجراء الاختبارات، ما عليك سوى تنفيذ الملف الثنائي Sourcetrail_test . قبل التنفيذ، يرجى التأكد من ضبط دليل العمل على ./bin/test .

رخصة

Sourcetrail مرخص بموجب رخصة جنو العامة الإصدار 3.

علامة تجارية

يعد اسم "Sourcetrail" علامة تجارية مملوكة لشركة Coati Software ولا يتم تضمينه ضمن الأصول المرخصة بموجب GNU GPLv3.