Sourcetrail

Nota importante: Este proyecto fue archivado por los autores y mantenedores originales de Sourcetrail a finales de 2021. Si quieres saber más sobre esta decisión, lee más en nuestro blog.

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

Windows:

Linux:

Enlaces

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

Sourcetrail es:

• gratis
• funciona sin conexión
• opera en Windows, macOS y Linux
• soporta C, C++, Java y Python
• ofrece un SDK (SourcetrailDB) para escribir extensiones de lenguaje personalizadas

Sourcetrail en Patreon

¡El desarrollo de código abierto y las publicaciones periódicas de software son posibles gracias al apoyo de estos increíbles patrocinadores!

Cómo usar Sourcetrail

Para configurar Sourcetrail en tu máquina, puedes descargar la compilación correspondiente para tu sistema operativo desde nuestra lista de Lanzamientos e instalarla, o usar uno de los siguientes gestores de paquetes:

• Usa el paquete de Chocolatey con choco install sourcetrail

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

Cómo reportar problemas

Puedes publicar todas tus solicitudes de funcionalidades e informes de errores en nuestro rastreador de incidencias.

Reportar

Usa la siguiente plantilla:

• versión de la plataforma:
• versión de Sourcetrail:
• descripción del problema:
• pasos para reproducir el problema:

Apoyo

Si deseas apoyar una solicitud de funcionalidad específica o tienes el mismo error que otro usuario ya reportó, háznoslo saber:

• publica un comentario con "+1" en la incidencia
• o envía un correo electrónico a [email protected] con el ID de la incidencia

Cómo contribuir

• Por favor, lee y sigue los pasos en el archivo CONTRIBUTING.md.
• Puede que quieras buscar incidencias etiquetadas como good first issue para encontrar algunas tareas iniciales.
• Si buscas más información sobre el desarrollo del software Sourcetrail, consulta nuestra wiki.

Cómo compilar

Compilar Sourcetrail requiere que varias dependencias estén presentes en tu máquina. Sin embargo, nuestra configuración basada en CMake permite deshabilitar el soporte de indexación para lenguajes específicos, lo que reduce el número de dependencias al mínimo.

Compilando la aplicación base

Herramientas requeridas

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

  • Motivo: Se utiliza para generar una configuración de compilación para tu sistema de compilación
  • Descarga: 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 commits y etiquetas
  • Descarga: https://git-scm.com/download
  • Observaciones: Asegúrate de que git esté agregado a tu variable de entorno PATH antes de ejecutar CMake

• Visual Studio (requerido para Windows)

  • Motivo: Se utiliza para compilar Sourcetrail
  • Descarga: https://visualstudio.microsoft.com/downloads/

• ccache (opcional para Linux y MacOS)

  • Motivo: Se utiliza para acelerar recompilaciones si se encuentra en PATH
  • Descarga: https://ccache.dev/download.html

Dependencias requeridas

• Boost 1.67

  • Motivo: Se utiliza para acceso al sistema de archivos y comunicación entre procesos
  • Descarga precompilada para Windows: https://sourceforge.net/projects/boost/files/boost-binaries/
  • Compilación para 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

  • Motivo: Se utiliza para renderizar la interfaz gráfica y para iniciar procesos adicionales (indexador).
  • Descarga precompilada: http://download.qt.io/official_releases/qt/

Compilando

En Windows

• Para configurar tu entorno de compilación, ejecuta:

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

  Sugerencia: Si estás usando la interfaz gráfica de CMake, te recomendamos que actives el modo avanzado. Además, es posible que debas agregar algunas de las definiciones mediante el botón "Add Entry".

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

En Unix

• Para configurar tu entorno de compilación, ejecuta:
  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> ../..
  

• Ahora inicia la compilación con:
  root@kitploit:~

  $ make Sourcetrail
  

Ejecución

• Ejecuta 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 accesibles estos directorios.

Habilitar soporte para lenguaje C/C++

Dependencias requeridas

• LLVM/Clang 11.0.0
  • Motivo: Se utiliza para ejecutar el preprocesador en el código fuente indexado, construir y recorrer un Árbol de Sintaxis Abstracta y generar mensajes de error.
  • Compilación: Asegúrate de verificar la etiqueta correcta: git checkout llvmorg-11.0.0
  • Compilación para Windows: Sigue estos pasos para compilar el proyecto. Ejecuta el comando cmake exactamente como se describe.
  • Compilación para Unix: Sigue esta guía de instalación para compilar el proyecto. Asegúrate de compilar con -DLLVM_ENABLE_RTTI=ON.

Compilando

• Ejecuta CMake con estas opciones adicionales:
  root@kitploit:~

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

• Compila Sourcetrail como se describe arriba.

Habilitar soporte para lenguaje Java

Dependencias requeridas

• JDK 1.8

  • Motivo: Se utiliza para compilar el indexador de Java y hacerlo invocable desde el código C++ a través de JNI.
  • Observaciones: Asegúrate de que <jdk_root>/bin esté disponible en tu variable de entorno PATH y que la variable de entorno JAVA_HOME esté configurada:
    root@kitploit:~

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

• Maven

  • Motivo: Se utiliza dentro de las pruebas automatizadas de Sourcetrail.
  • Observaciones: Asegúrate de que .../apache-maven-x.x.x/bin esté disponible en tu variable de entorno PATH y que ambas variables de entorno M2_HOME y MAVEN_HOME estén configuradas:
    root@kitploit:~

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

Compilando

• Ejecuta CMake con estas opciones adicionales:
  root@kitploit:~

  -DBUILD_JAVA_LANGUAGE_PACKAGE=ON
  

• Compila Sourcetrail como se describe arriba.

Habilitar soporte para lenguaje Python

Herramientas requeridas

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

Compilando

• Ejecuta CMake con estas opciones adicionales:
  root@kitploit:~

  -DBUILD_PYTHON_LANGUAGE_PACKAGE=ON
  

• Compila Sourcetrail como se describe arriba.

Creando el paquete de despliegue

Windows

Herramientas requeridas

• Visual Studio (requerido para Windows)

  • Motivo: Se utiliza para compilar el instalador de Windows de Sourcetrail.
  • Observaciones: Asegúrate de instalar la carga de trabajo .Net desktop development.
  • Descarga: https://visualstudio.microsoft.com/downloads/

• Wix 3.11

  • Motivo: Se utiliza para compilar el instalador de Windows sourcetrail.msi.
  • Observaciones: Asegúrate de agregar <path/to>/WiX Toolset v3.11/bin a tu variable de entorno PATH.
  • Descarga: 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.
  • Descarga: https://marketplace.visualstudio.com/items?itemName=WixToolset.WixToolsetVisualStudio2017Extension

• JRE

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

• WinRAR

  • Motivo: Se utiliza para crear los archivos zip finales para el instalador y el paquete portátil.
  • Observaciones: Asegúrate de agregar <path/to>/WinRAR a tu variable de entorno .

Compilando

• Ejecuta ./script/deploy_windows.sh desde tu Símbolo del sistema para desarrolladores de Visual Studio. El script generará una compilación de 64 bits y la empaquetará en un archivo .zip portátil y un instalador de Windows basado en Wix, respectivamente.

macOS

Después de compilar, ejecuta 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

Ejecuta ./setup/Linux/createPackages.sh desde el directorio principal, que crea tanto un paquete .tar.gz como un .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 ejecuta el binario Sourcetrail_test. Antes de ejecutar, asegúrate de establecer el directorio de trabajo en ./bin/test.

Licencia

Sourcetrail está licenciado bajo la GNU General Public License Version 3.

Marca registrada

El nombre "Sourcetrail" es una marca registrada propiedad de Coati Software y no está incluida en los activos licenciados bajo GNU GPLv3.