sourcetrail-cls

Generate Sourcetrail project for CLS (Common Language Syntax)

Build Status

Linux

Demo

Sourcetrail project created from CLS JSON file

Installation

• For Ubuntu/WSL

  • Run scripts/linux/bootstrap.sh

• For Visual Studio

  • Install Visual Studio 2019 with below Workloads
    • Desktop development for C++
    • Linux development for C++
  • Install Windows Subsystem for Linux
  • Launch Ubuntu bash shell and execute scripts/linux/bootstrap.sh

Build

• For Ubuntu/WSL

  • Run scripts/linux/build.sh

• For Visual Studio

  • Right click on sourcetrail-cls folder
  • Choose Open in Visual Studio
  • Build > Build All

Usage

• For Ubuntu/WSL

  • Run scripts/linux/run.sh
  • This runs the cls2srctrl app with example CLS input data/cls.json. Modify run.sh according to your need

• For Visual Studio

  • Select Configuration WSL-Debug
  • Select Start Item sourcetrail-cls.cls2srctrl (src\\cls2srctrl\\sourcetrail-cls.cls2srctrl) from drop down
  • Launch using F5 or Green Play Button

Code Format

Both C++ and CMake files can be formatted using scripts/linux/code_format.sh

Static Analysis

Run scripts/linux/quality.sh to perform code quality checks

Known Issues

• Output file will always be project.srctrldb
  • Original idea is to parametrize output file by taking the output path as argument
  • If you run the app sourcetrail-cls.cls2srctrl, parameter --srctrldb_output has no effect
  • It is possible to create .srctrldb file using this idea. But the created file fails to load in Sourcetrail. This needs to be investigated.
  • Output path is hard-coded in file, src/cls2srctrl/cls2srctrl.cpp, function cls2st::cls2srctrl::create_srctrldb