CoatiSoftware/Sourcetrail

Provide graphml export option

Open

#1,085 opened on Sep 22, 2020

View on GitHub
 (3 comments) (1 reaction) (0 assignees)C++ (14,130 stars) (1,310 forks)batch import
featuregood first issue

Description

In my mind one of the key things (besides visualization) Sourcetrail provides is a useful graph structure for source code that can be used for various types of analysis, without having to go through the pain of writing a clang analyzer yourself. However, since sourcetrail doesn't have plugins (#1076), writing your own analysis tools is a bit of work, and may not let you use other kinds of graph analysis tooling.

I've started on making a graphml exporter at https://gist.github.com/virtuald/95ecfa5047671f008395f5781a359cc7 , but it seems that getGraphForNodeTypes and getGraphForAll don't actually seem to create a full in memory graph.

Contributor guide

Tech stack
cpp
Domain
toolingdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
C++ knowledgegraph data structures
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
The issue requests a graphml export feature. A partial implementation is available in a gist (https://gist.github.com/virtuald/95ecfa5047671f008395f5781a359cc7), but the contributor found that `getGraphForNodeTypes` and `getGraphForAll` do not create a full in memory graph. Investigate the Sourcetrail source code to understand how the graph is built and stored, and determine what modifications are needed to complete the export. Look at the existing graph data structures and the mentioned functions to identify missing pieces.