Sourcetrail

Sendero fuente

Nota importante: este proyecto fue archivado por los autores y mantenedores originales de Sourcetrail a fines de 2021. Si desea saber más sobre esta decisión, lea más en nuestro blog.

Sourcetrail es un explorador de código fuente multiplataforma gratuito y de código abierto que le ayuda a ser productivo con código fuente desconocido.

Ventanas:

Linux:

Campo de golf

• Descargar
• Guía de inicio rápido
• Documentación
• Registro de cambios

El rastro fuente es:

• gratis
• trabajando sin conexión
• operando en Windows, macOS y Linux
• compatible con C, C++, Java y Python
• ofreciendo un SDK (SourcetrailDB) para escribir extensiones de idioma personalizadas

Ruta de origen en Patreon

¡El desarrollo de código abierto y los lanzamientos regulares de software son posibles en su totalidad gracias al apoyo de estos increíbles patrocinadores!

Usando Sourcetrail

Para configurar Sourcetrail en su máquina, puede descargar la compilación respectiva para su sistema operativo de nuestra lista de Versiones e instalarla en su máquina, o usar uno de los siguientes administradores de paquetes:

• Utilice el paquete Chocolatey con choco install sourcetrail

Una vez completada la instalación, siga nuestra Guía de inicio rápido para conocer Sourcetrail.

Cómo informar problemas

Puede publicar todas sus solicitudes de funciones e informes de errores en nuestro rastreador de problemas.

Informes

Utilice la siguiente plantilla:

• versión de plataforma:
• Versión de origen:
• descripción del problema:
• pasos para reproducir el problema:

Secundario

Si desea admitir una determinada solicitud de función o tiene el mismo error que ya informó otro usuario, háganoslo saber:

• publicar un comentario con "+1" en el problema
• o envíe un correo electrónico a [email protected] con el ID del problema

Cómo contribuir

• Lea y siga los pasos del archivo CONTRIBUTING.md.
• Es posible que desees estar atento a los problemas etiquetados como "bueno primer problema" para encontrar algunas tareas iniciales que abordar.
• Si está buscando más información sobre el desarrollo de software Sourcetrail, consulte nuestra wiki.

Cómo construir

La creación de Sourcetrail requiere que existan varias dependencias en su máquina. Sin embargo, nuestra configuración basada en CMake permite deshabilitar el soporte de indexación para idiomas específicos, lo que reduce la cantidad de dependencias al mínimo.

Construyendo la aplicación base

Herramientas necesarias

• CMake v3.12 (requerido para Windows, Linux y MacOS)

  • Motivo : se utiliza para generar una configuración de compilación para su sistema de compilación.
  • Descargar : https://cmake.org/download

• Git (requerido para Windows, Linux y MacOS)

  • Motivo : se utiliza para el control de versiones y para generar automáticamente el número de versión de Sourcetrail a partir de confirmaciones y etiquetas.
  • Descargar : https://git-scm.com/download
  • Observaciones : asegúrese de que git esté agregado a su variable de entorno PATH antes de ejecutar CMake

• Visual Studio (requerido para Windows)

  • Motivo : Se utiliza para construir Sourcetrail.
  • Descargar : https://visualstudio.microsoft.com/downloads/

• ccache (opcional para Linux y MacOS)

  • Motivo : se utiliza para acelerar las reconstrucciones si se encuentra en PATH
  • Descargar : https://ccache.dev/download.html

Dependencias requeridas

• Impulso 1.67

  • Motivo : se utiliza para el acceso al sistema de archivos y la comunicación entre procesos.
  • Descarga prediseñadas para Windows : https://sourceforge.net/projects/boost/files/boost-binaries/
  • Construyendo para Unix :

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

• Cuarto 5.12.3

  • Motivo : se utiliza para representar la GUI y para iniciar procesos adicionales (indexador).
  • Descarga prediseñada : http://download.qt.io/official_releases/qt/

Edificio

En Windows

• Para configurar su entorno de compilación, ejecute:

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

  Sugerencia: si está utilizando la GUI de CMake, le recomendamos que active el modo avanzado. También es posible que deba agregar algunas de las definiciones mediante el botón "Agregar entrada".

• Después de generar la configuración de compilación, simplemente abra el archivo Sourcetrail.sln generado por CMake y cree el proyecto Sourcetrail.

En Unix

• Para configurar su entorno de compilación, ejecute:

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

• Ahora comience la compilación con:

   $ make Sourcetrail
  

Correr

• Ejecute Sourcetrail desde el directorio de compilación. Durante la ejecución, Sourcetrail necesita recursos de bin/app/data y bin/app/user . CMake crea enlaces simbólicos dentro del directorio de compilación que hacen que estos directorios sean accesibles.

Habilitar la compatibilidad con el lenguaje C/C++

Dependencias requeridas

• LLVM/Clang 11.0.0
  • Motivo : se utiliza para ejecutar el preprocesador en el código fuente indexado, crear y recorrer un árbol de sintaxis abstracta y generar mensajes de error.
  • Edificio : asegúrese de revisar la etiqueta correcta: git checkout llvmorg-11.0.0
  • Compilación para Windows : siga estos pasos para compilar el proyecto. Ejecute el comando cmake exactamente como se describe.
  • Compilación para Unix : siga esta guía de instalación para compilar el proyecto. Asegúrese de compilar con -DLLVM_ENABLE_RTTI=ON .

Edificio

• Ejecute CMake con estas opciones adicionales:

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

• Construya Sourcetrail como se describe arriba.

Habilitar la compatibilidad con el lenguaje Java

Dependencias requeridas

• JDK 1.8

  • Motivo : se utiliza para crear el indexador de Java y hacerlo invocable desde el código C++ a través de JNI.
  • Observaciones : asegúrese de que <jdk_root>/bin esté disponible en su variable de entorno PATH y que la variable de entorno JAVA_HOME esté configurada:

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

• experto

  • MOTIVO : Se utiliza en las pruebas automatizadas de Sourcetrail.
  • Observaciones : asegúrese de que .../apache-maven-xxx/bin esté disponible en su variable de entorno PATH y que las variables de entorno M2_HOME y MAVEN_HOME estén configuradas:

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

Edificio

• Ejecute CMake con estas opciones adicionales:

   -DBUILD_JAVA_LANGUAGE_PACKAGE=ON
  

• Construya Sourcetrail como se describe arriba.

Habilitar la compatibilidad con el lenguaje Python

Herramientas necesarias

• 7z (requerido para Windows)
  • RAZÓN : Se utiliza para extraer el SourcetrailPythonIndexer precompilado que se descarga automáticamente durante la ejecución de la compilación.

Edificio

• Ejecute CMake con estas opciones adicionales:

   -DBUILD_PYTHON_LANGUAGE_PACKAGE=ON
  

• Construya Sourcetrail como se describe arriba.

Creando el paquete de implementación

ventanas

Herramientas necesarias

• Visual Studio (requerido para Windows)

  • Motivo : se utiliza para crear el instalador de Windows Sourcetrail.
  • Observaciones : asegúrese de instalar la carga de trabajo .Net desktop development .
  • Descargar : https://visualstudio.microsoft.com/downloads/

• wix 3.11

  • Motivo : se utiliza para crear el instalador de Windows sourcetrail.msi .
  • Observaciones : asegúrese de agregar <path/to>/WiX Toolset v3.11/bin a su variable de entorno PATH .
  • Descargar : https://wixtoolset.org/releases/

• Extensión Wix para Visual Studio

  • Motivo : se utiliza para ejecutar Wix desde el entorno de compilación de Visual Studio.
  • Descargar : https://marketplace.visualstudio.com/items?itemName=WixToolset.WixToolsetVisualStudio2017Extension

• JRE

  • Motivo : se utiliza para indexar el proyecto de muestra de Java que se incluye con el paquete.

• winrar

  • Motivo : se utiliza para crear los archivos zip finales para el instalador y el paquete portátil.
  • Observaciones : asegúrese de agregar <path/to>/WinRAR a su variable de entorno PATH .

Edificio

• Ejecute ./script/deploy_windows.sh desde el símbolo del sistema del desarrollador para Visual Studio. El script generará una compilación de 64 bits y la empaquetará en un archivo .zip portátil y en un instalador de Windows basado en Wix, cada uno.

macos

Después de compilar, ejecute el script bundle_install.sh dentro del directorio de compilación que creará un paquete Sourcetrail.app y generará un contenedor Sourcetrail_<version>.dmg .

linux

Ejecute ./setup/Linux/createPackages.sh desde el directorio principal, lo que crea un paquete .tar.gz y .AppImage en el directorio principal. El empaquetado depende de linuxdeployqt.

Cómo ejecutar las pruebas

El conjunto de pruebas automatizadas de Sourcetrail funciona con Catch2. Para ejecutar las pruebas, simplemente ejecute el binario Sourcetrail_test . Antes de ejecutar, asegúrese de configurar el directorio de trabajo en ./bin/test .

Licencia

Sourcetrail tiene la licencia GNU General Public License Versión 3.

Marca

El nombre "Sourcetrail" es una marca comercial propiedad de Coati Software y no está incluida dentro de los activos bajo licencia GNU GPLv3.