Enhancement: parse comment tag on goroutines to name them in diagram about go-callvis HOT 1 CLOSED

My apologies for not updating this more promptly. I came up with a sufficient solution many months ago, which I neglected to submit here until now.

Rather than some complex addition to the go-callvis codebase, it ultimately seemed best to just use a post-processing script to achieve this, since it is not really the responsibility of go-callvis to name nodes in the graph, but the dot tool beneath, which is language-agnostic.

My solution was to place a formatted comment tag above a goroutine, naming it as desired, eg:

func doShellMode(...) {
        ...
        // #gv:s/label=\"doShellMode\$1\"/label=\"shellRemoteToStdin\"/
        shellRemoteToStdin := func() {
            ...
            ...
        }
        go shellRemoteToStdin()
}

The #gv introduces a sed expression used by the following script, called from a vis build rule in my Makefiles, to patch the .gv files output by graphvis to use the desired name for the node.

fixup-gv.sh

#!/bin/bash

inFile="${1/.go/}"
visFile="${inFile}-vis.gv"

grep -o "#gv:.*" "$inFile.go" | cut -f2 -d: | \
while read -r expr; do sed -i ${expr} "${visFile}"; done

I typically create a 'vis' Makefile target which invokes fixup-gv.sh to generate the graphics for all files in the project.

Example: https://gogs.blitter.com/RLabs/hkexsh/wiki

It might be nice to include the above 'fixup-gv.sh' script as a helper within this project, or as part of an FAQ on how to name goroutines in the go-callvis output. Other than that, it shouldn't be worth effort within the golang codebase of this project.

from go-callvis.