Sourcetrail

Note importante : Ce projet a été archivé par les auteurs et mainteneurs originaux de Sourcetrail à la fin de l'année 2021. Si vous souhaitez en savoir plus sur cette décision, lisez la suite sur notre blog.

Sourcetrail est un explorateur de code source gratuit et open-source multiplateforme qui vous aide à devenir productif sur un code source inconnu.

Windows:

Linux:

Liens

• Téléchargement
• Guide de démarrage rapide
• Documentation
• Journal des modifications

Sourcetrail est :

• gratuit
• fonctionne hors ligne
• fonctionne sur Windows, macOS et Linux
• prend en charge C, C++, Java et Python
• offre un SDK (SourcetrailDB) pour écrire des extensions de langage personnalisées

Sourcetrail sur Patreon

Le développement open-source et les versions logicielles régulières sont rendus possibles entièrement grâce au soutien de ces formidables mécènes !

Utiliser Sourcetrail

Pour installer Sourcetrail sur votre machine, vous pouvez soit télécharger la version correspondant à votre système d'exploitation depuis notre liste de Versions et l'installer sur votre machine, soit utiliser l'un des gestionnaires de paquets suivants :

• Utilisez le paquet Chocolatey avec choco install sourcetrail

Après l'installation, suivez notre Guide de démarrage rapide pour découvrir Sourcetrail.

Comment signaler des problèmes

Vous pouvez poster toutes vos demandes de fonctionnalités et rapports de bugs sur notre suivi des problèmes.

Signalement

Utilisez le modèle suivant :

• version de la plateforme :
• version de Sourcetrail :
• description du problème :
• étapes pour reproduire le problème :

Soutien

Si vous souhaitez soutenir une demande de fonctionnalité ou si vous avez le même bug qu'un autre utilisateur a déjà signalé, faites-le nous savoir :

• publiez un commentaire avec « +1 » sur le problème
• ou envoyez un email à [email protected] avec l'ID du problème

Comment contribuer

• Veuillez lire et suivre les étapes dans le fichier CONTRIBUTING.md.
• Vous pouvez chercher des problèmes étiquetés good first issue pour trouver des tâches initiales à aborder.
• Si vous cherchez plus d'informations sur le développement de Sourcetrail, veuillez consulter notre wiki.

Comment compiler

La compilation de Sourcetrail nécessite plusieurs dépendances sur votre machine. Cependant, notre configuration basée sur CMake permet de désactiver le support de l'indexation pour des langages spécifiques, ce qui réduit le nombre de dépendances au minimum.

Compilation de l'application de base

Outils requis

• CMake v3.12 (requis pour Windows, Linux et macOS)

  • Raison : Utilisé pour générer une configuration de compilation pour votre système de build.
  • Téléchargement : https://cmake.org/download

• Git (requis pour Windows, Linux et macOS)

  • Raison : Utilisé pour le contrôle de version et pour générer automatiquement le numéro de version de Sourcetrail à partir des commits et des tags.
  • Téléchargement : https://git-scm.com/download
  • Remarques : Assurez-vous que git est ajouté à votre variable d'environnement PATH avant d'exécuter CMake

• Visual Studio (requis pour Windows)

  • Raison : Utilisé pour compiler Sourcetrail.
  • Téléchargement : https://visualstudio.microsoft.com/downloads/

• ccache (optionnel pour Linux et macOS)

  • Raison : Utilisé pour accélérer les recompilations s'il est trouvé dans PATH.
  • Téléchargement : https://ccache.dev/download.html

Dépendances requises

• Boost 1.67

  • Raison : Utilisé pour l'accès au système de fichiers et la communication inter-processus.
  • Téléchargement précompilé pour Windows : https://sourceforge.net/projects/boost/files/boost-binaries/
  • Compilation pour Unix :
    root@kitploit:~

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

• Qt 5.12.3

  • Raison : Utilisé pour le rendu de l'interface graphique et pour lancer des processus supplémentaires (d'indexation).
  • Téléchargement précompilé : http://download.qt.io/official_releases/qt/

Compilation

Sous Windows

• Pour configurer votre environnement de compilation, exécutez :

  root@kitploit:~

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

  Astuce : Si vous utilisez l'interface graphique CMake, nous vous recommandons d'activer le mode avancé. Vous devrez peut-être également ajouter certaines définitions via le bouton "Add Entry".

• Après avoir généré la configuration de compilation, ouvrez simplement le fichier Sourcetrail.sln généré par CMake et compilez le projet Sourcetrail.

Sous Unix

• Pour configurer votre environnement de compilation, exécutez :
  root@kitploit:~

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

• Lancez maintenant la compilation avec :
  root@kitploit:~

  $ make Sourcetrail
  

Exécution

• Exécutez Sourcetrail depuis le répertoire de compilation. Pendant l'exécution, Sourcetrail a besoin des ressources de bin/app/data et bin/app/user. CMake crée des liens symboliques dans le répertoire de compilation qui rendent ces répertoires accessibles.

Activer le support des langages C/C++

Dépendances requises

• LLVM/Clang 11.0.0
  • Raison : Utilisé pour exécuter le préprocesseur sur le code source indexé, construire et parcourir un arbre syntaxique abstrait et générer des messages d'erreur.
  • Compilation : Assurez-vous de vérifier le bon tag : git checkout llvmorg-11.0.0
  • Compilation sous Windows : Suivez ces étapes pour compiler le projet. Exécutez la commande cmake exactement comme décrit.
  • Compilation sous Unix : Suivez ce guide d'installation pour compiler le projet. Assurez-vous de compiler avec -DLLVM_ENABLE_RTTI=ON.

Compilation

• Exécutez CMake avec ces options supplémentaires :
  root@kitploit:~

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

• Compilez Sourcetrail comme décrit ci-dessus.

Activer le support du langage Java

Dépendances requises

• JDK 1.8

  • Raison : Utilisé pour compiler l'indexeur Java et le rendre appelable depuis le code C++ via JNI.
  • Remarques : Assurez-vous que <jdk_root>/bin est disponible dans votre variable d'environnement PATH et que la variable d'environnement JAVA_HOME est définie :
    root@kitploit:~

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

• Maven

  • RAISON : Utilisé dans les tests automatisés de Sourcetrail.
  • Remarques : Assurez-vous que .../apache-maven-x.x.x/bin est disponible dans votre variable d'environnement PATH et que les variables d'environnement M2_HOME et MAVEN_HOME sont définies :
    root@kitploit:~

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

Compilation

• Exécutez CMake avec ces options supplémentaires :
  root@kitploit:~

  -DBUILD_JAVA_LANGUAGE_PACKAGE=ON
  

• Compilez Sourcetrail comme décrit ci-dessus.

Activer le support du langage Python

Outils requis

• 7z (requis pour Windows)
  • RAISON : Utilisé pour extraire le SourcetrailPythonIndexer précompilé qui est téléchargé automatiquement lors de la compilation.

Compilation

• Exécutez CMake avec ces options supplémentaires :
  root@kitploit:~

  -DBUILD_PYTHON_LANGUAGE_PACKAGE=ON
  

• Compilez Sourcetrail comme décrit ci-dessus.

Création du package de déploiement

Windows

Outils requis

• Visual Studio (requis pour Windows)

  • Raison : Utilisé pour compiler l'installateur Windows de Sourcetrail.
  • Remarques : Assurez-vous d'installer la charge de travail .Net desktop development.
  • Téléchargement : https://visualstudio.microsoft.com/downloads/

• Wix 3.11

  • Raison : Utilisé pour compiler l'installateur Windows sourcetrail.msi.
  • Remarques : Assurez-vous d'ajouter <path/to>/WiX Toolset v3.11/bin à votre variable d'environnement PATH.
  • Téléchargement : https://wixtoolset.org/releases/

• Wix extension for Visual Studio

  • Raison : Utilisé pour exécuter Wix depuis l'environnement de compilation Visual Studio.
  • Téléchargement : https://marketplace.visualstudio.com/items?itemName=WixToolset.WixToolsetVisualStudio2017Extension

• JRE

  • Raison : Utilisé pour indexer le projet d'exemple Java fourni avec le package.

• WinRAR

  • Raison : Utilisé pour créer les fichiers zip finaux pour l'installateur et le package portable.
  • Remarques : Assurez-vous d'ajouter <path/to>/WinRAR à votre variable d'environnement .

Compilation

• Exécutez ./script/deploy_windows.sh depuis votre invite de commandes développeur pour Visual Studio. Le script générera une version 64 bits et l'empaquettera dans un fichier .zip portable et un installateur Windows basé sur Wix, chacun.

macOS

Après la compilation, exécutez le script bundle_install.sh dans le répertoire de compilation, ce qui créera un bundle Sourcetrail.app et générera un conteneur Sourcetrail_<version>.dmg.

Linux

Exécutez ./setup/Linux/createPackages.sh depuis le répertoire principal, ce qui crée à la fois un package .tar.gz et un package .AppImage dans le répertoire principal. L'empaquetage dépend de linuxdeployqt.

Comment exécuter les tests

La suite de tests automatisés de Sourcetrail est propulsée par Catch2. Pour exécuter les tests, exécutez simplement le binaire Sourcetrail_test. Avant d'exécuter, veuillez vous assurer de définir le répertoire de travail sur ./bin/test.

Licence

Sourcetrail est sous licence GNU General Public License Version 3.

Marque commerciale

Le nom "Sourcetrail" est une marque commerciale détenue par Coati Software et n'est pas inclus dans les actifs sous licence GNU GPLv3.