Sourcetrail

ที่มา

หมายเหตุสำคัญ: โครงการนี้ถูกเก็บถาวรโดยผู้สร้างและผู้ดูแล Sourcetrail ดั้งเดิมภายในสิ้นปี 2564 หากคุณต้องการทราบข้อมูลเพิ่มเติมเกี่ยวกับการตัดสินใจนี้ โปรดอ่านเพิ่มเติมในบล็อกของเรา

Sourcetrail คือโปรแกรมสำรวจซอร์สข้ามแพลตฟอร์มแบบโอเพ่นซอร์สฟรีที่ช่วยให้คุณใช้งานซอร์สโค้ดที่ไม่คุ้นเคยได้อย่างมีประสิทธิภาพ

หน้าต่าง:

ลินุกซ์:

ลิงค์

• ดาวน์โหลด
• คู่มือเริ่มต้นใช้งานฉบับย่อ
• เอกสารประกอบ
• บันทึกการเปลี่ยนแปลง

Sourcetrail คือ:

• ฟรี
• ทำงานแบบออฟไลน์
• ทำงานบน Windows, macOS และ Linux
• รองรับ C, C++, Java และ Python
• เสนอ SDK (SourcetrailDB) เพื่อเขียนส่วนขยายภาษาที่กำหนดเอง

Sourcetrail บน Patreon

การพัฒนาโอเพ่นซอร์สและการเผยแพร่ซอฟต์แวร์เป็นประจำเกิดขึ้นได้อย่างสมบูรณ์โดยการสนับสนุนจากลูกค้าที่ยอดเยี่ยมเหล่านี้!

การใช้ Sourcetrail

หากต้องการตั้งค่า Sourcetrail บนเครื่องของคุณ คุณสามารถดาวน์โหลดบิลด์ที่เกี่ยวข้องสำหรับระบบปฏิบัติการของคุณจากรายการ Releases ของเรา และติดตั้งบนเครื่องของคุณ หรือใช้หนึ่งในตัวจัดการแพ็คเกจต่อไปนี้:

• ใช้แพ็คเกจ Chocolatey พร้อม choco install sourcetrail

หลังจากการติดตั้งของคุณเสร็จสมบูรณ์ ให้ปฏิบัติตามคู่มือเริ่มต้นใช้งานฉบับย่อของเราเพื่อทำความรู้จักกับ 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/
  • การสร้างสำหรับ Unix :

     $ ./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

  • เหตุผล : ใช้สำหรับการเรนเดอร์ GUI และสำหรับการเริ่มต้นกระบวนการเพิ่มเติม (ตัวทำดัชนี)
  • ดาวน์โหลดที่สร้างไว้ล่วงหน้า : 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 GUI เราขอแนะนำให้คุณเปิดใช้งานโหมดขั้นสูง นอกจากนี้ คุณอาจต้องเพิ่มการกำหนดบางส่วนผ่านปุ่ม "เพิ่มรายการ"

• หลังจากสร้างการกำหนดค่าบิลด์แล้ว เพียงเปิดไฟล์ 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 จากภายในไดเร็กทอรี build ในระหว่างการดำเนินการ Sourcetrail ต้องการทรัพยากรจาก bin/app/data และ bin/app/user CMake สร้าง symlink ภายในไดเร็กทอรี build ที่ทำให้ไดเร็กทอรีเหล่านี้สามารถเข้าถึงได้

เปิดใช้งานการสนับสนุนภาษา C/C++

การพึ่งพาที่จำเป็น

• LLVM/เสียงดังกราว 11.0.0
  • เหตุผล : ใช้สำหรับการรันพรีโปรเซสเซอร์บนซอร์สโค้ดที่จัดทำดัชนี สร้างและสำรวจ Abstract Syntax Tree และสร้างข้อความแสดงข้อผิดพลาด
  • อาคาร : ตรวจสอบให้แน่ใจว่าได้ตรวจสอบแท็กที่ถูกต้อง: git checkout llvmorg-11.0.0
  • การสร้างสำหรับ Windows : ทำตามขั้นตอนเหล่านี้เพื่อสร้างโปรเจ็กต์ รันคำสั่ง cmake ทุกประการตามที่อธิบายไว้
  • การสร้างสำหรับ Unix : ปฏิบัติตามคู่มือการติดตั้งนี้เพื่อสร้างโปรเจ็กต์ ตรวจสอบให้แน่ใจว่าได้สร้างด้วย -DLLVM_ENABLE_RTTI=ON

อาคาร

• เรียกใช้ CMake ด้วยตัวเลือกเพิ่มเติมเหล่านี้:

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

• สร้าง Sourcetrail ตามที่อธิบายไว้ข้างต้น

เปิดใช้งานการสนับสนุนภาษา Java

การพึ่งพาที่จำเป็น

• เจดีเค 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 ตามที่อธิบายไว้ข้างต้น

เปิดใช้งานการสนับสนุนภาษา Python

เครื่องมือที่จำเป็น

• 7z (จำเป็นสำหรับ Windows)
  • เหตุผล : ใช้เพื่อแยก SourcetrailPythonIndexer ที่สร้างไว้ล่วงหน้าซึ่งจะถูกดาวน์โหลดโดยอัตโนมัติระหว่างการดำเนินการสร้าง

อาคาร

• เรียกใช้ CMake ด้วยตัวเลือกเพิ่มเติมเหล่านี้:

   -DBUILD_PYTHON_LANGUAGE_PACKAGE=ON
  

• สร้าง Sourcetrail ตามที่อธิบายไว้ข้างต้น

การสร้างแพ็คเกจการปรับใช้

หน้าต่าง

เครื่องมือที่จำเป็น

• Visual Studio (จำเป็นสำหรับ Windows)

  • เหตุผล : ใช้สำหรับสร้างตัวติดตั้ง Sourcetrail Windows
  • หมายเหตุ : ตรวจสอบให้แน่ใจว่าได้ติดตั้งภาระงาน .Net desktop development
  • ดาวน์โหลด : https://visualstudio.microsoft.com/downloads/

• Wix3.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

• เจอาร์อี

  • เหตุผล : ใช้สำหรับการจัดทำดัชนีโปรเจ็กต์ตัวอย่าง Java ที่มาพร้อมกับแพ็กเกจ

• WinRAR

  • เหตุผล : ใช้สำหรับสร้างไฟล์ zip สุดท้ายสำหรับตัวติดตั้งและแพ็คเกจพกพา
  • หมายเหตุ : ตรวจสอบให้แน่ใจว่าได้เพิ่ม <path/to>/WinRAR ให้กับตัวแปรสภาพแวดล้อม PATH ของคุณ

อาคาร

• เรียกใช้ ./script/deploy_windows.sh จาก Developer Command Prompt สำหรับ Visual Studio สคริปต์ที่จะสร้างบิลด์ 64 บิตและจัดทำแพ็คเกจเป็นไฟล์ .zip แบบพกพาและตัวติดตั้ง Windows ที่ใช้ Wix ในแต่ละไฟล์

ระบบปฏิบัติการ macOS

หลังจากสร้างแล้ว ให้รันสคริปต์ bundle_install.sh ภายในไดเร็กทอรี build ซึ่งจะสร้างบันเดิล Sourcetrail.app และสร้างคอนเทนเนอร์ Sourcetrail_<version>.dmg

ลินุกซ์

เรียกใช้ ./setup/Linux/createPackages.sh จากไดเร็กทอรีหลัก ซึ่งสร้างทั้งแพ็กเกจ .tar.gz และ .AppImage ในไดเร็กทอรีหลัก บรรจุภัณฑ์ขึ้นอยู่กับ linuxdeployqt

วิธีดำเนินการทดสอบ

ชุดทดสอบอัตโนมัติของ Sourcetrail ขับเคลื่อนโดย Catch2 หากต้องการรันการทดสอบ เพียงดำเนินการไบนารี Sourcetrail_test ก่อนดำเนินการ โปรดตรวจสอบให้แน่ใจว่าได้ตั้งค่าไดเร็กทอรีการทำงานเป็น ./bin/test test

ใบอนุญาต

Sourcetrail ได้รับอนุญาตภายใต้ GNU General Public License เวอร์ชัน 3

เครื่องหมายการค้า

ชื่อ "Sourcetrail" เป็นเครื่องหมายการค้าของ Coati Software และไม่รวมอยู่ในทรัพย์สินที่ได้รับอนุญาตภายใต้ GNU GPLv3