Merge pull request #53 from jbreckmckye/jbmk-local-mermaid

Author: kisielk

README.md

@@ -15,15 +15,19 @@ argument:
 
     godepgraph github.com/kisielk/godepgraph
 
-If you intent to graph a go mod project, your package should be passed as a relative path:
+If you intend to graph a go mod project, your package should be passed as a relative path:
 
     godepgraph ./pkg/api
 
-The output is a graph in [Graphviz][graphviz] dot format. If you have the
+The default output is a graph in [Graphviz][graphviz] dot format. If you have the
 graphviz tools installed you can render it by piping the output to dot:
 
     godepgraph github.com/kisielk/godepgraph | dot -Tpng -o godepgraph.png
 
+You can also generate [Mermaid](https://mermaid.js.org/) graphs:
+
+    godepgraph github.com/kisielk/godepgraph -format mermaid > graph.mmd
+
 By default godepgraph will display packages in the standard library in the
 graph, though it will not delve in to their dependencies.
 

graphviz_lang.go

@@ -0,0 +1,68 @@
+package main
+
+import (
+	"fmt"
+	"go/build"
+)
+
+// graphvizPrinter implements graphPrinter for the DOT / GraphViz diagramming language.
+type graphvizPrinter struct {
+	ids map[string]string
+}
+
+func newGraphvizPrinter() *graphvizPrinter {
+	p := new(graphvizPrinter)
+	p.ids = make(map[string]string)
+	return p
+}
+
+func (p *graphvizPrinter) writeHeader(hLayout bool) {
+	fmt.Println("digraph godep {")
+	if hLayout {
+		fmt.Println(`rankdir="LR"`)
+	}
+	fmt.Println(`splines=ortho
+nodesep=0.4
+ranksep=0.8
+node [shape="box",style="rounded,filled"]
+edge [arrowsize="0.5"]`)
+}
+
+func (p *graphvizPrinter) writeNode(pkgName string, attrs *build.Package) {
+	id := p.getId(pkgName)
+
+	var color string
+	switch {
+	case attrs.Goroot:
+		color = "palegreen"
+	case len(attrs.CgoFiles) > 0:
+		color = "darkgoldenrod1"
+	case isVendored(attrs.ImportPath):
+		color = "palegoldenrod"
+	case hasBuildErrors(attrs):
+		color = "red"
+	default:
+		color = "paleturquoise"
+	}
+
+	fmt.Printf("%s [label=\"%s\" color=\"%s\" URL=\"%s\" target=\"_blank\"];\n", id, pkgName, color, pkgDocsURL(pkgName))
+}
+
+func (p *graphvizPrinter) writeEdge(u string, v string) {
+	uId := p.getId(u)
+	vId := p.getId(v)
+	fmt.Printf("%s -> %s;\n", uId, vId)
+}
+
+func (p *graphvizPrinter) getId(pkgName string) string {
+	id, ok := p.ids[pkgName]
+	if !ok {
+		id = "\"" + pkgName + "\""
+		p.ids[pkgName] = id
+	}
+	return id
+}
+
+func (p *graphvizPrinter) writeEnd() {
+	fmt.Println("}")
+}

main.go

@@ -10,10 +10,16 @@ import (
 	"strings"
 )
 
+type graphPrinter interface {
+	writeHeader(hLayout bool)
+	writeNode(pkgName string, attrs *build.Package)
+	writeEdge(u string, v string)
+	writeEnd()
+}
+
 var (
 	pkgs        map[string]*build.Package
 	erroredPkgs map[string]bool
-	ids         map[string]string
 
 	ignored = map[string]bool{
 		"C": true,
@@ -32,6 +38,7 @@ var (
 	horizontal     = flag.Bool("horizontal", false, "lay out the dependency graph horizontally instead of vertically")
 	withTests      = flag.Bool("withtests", false, "include test packages")
 	maxLevel       = flag.Int("maxlevel", 256, "max level of go dependency graph")
+	format         = flag.String("format", "dot", "output format of graph (dot, mermaid)")
 
 	buildTags    []string
 	buildContext = build.Default
@@ -50,7 +57,6 @@ func init() {
 func main() {
 	pkgs = make(map[string]*build.Package)
 	erroredPkgs = make(map[string]bool)
-	ids = make(map[string]string)
 	flag.Parse()
 
 	args := flag.Args()
@@ -75,6 +81,11 @@ func main() {
 	}
 	buildContext.BuildTags = buildTags
 
+	printer, err := getPrinter()
+	if err != nil {
+		log.Fatal(err)
+	}
+
 	cwd, err := os.Getwd()
 	if err != nil {
 		log.Fatalf("failed to get cwd: %s", err)
@@ -85,16 +96,7 @@ func main() {
 		}
 	}
 
-	fmt.Println("digraph godep {")
-	if *horizontal {
-		fmt.Println(`rankdir="LR"`)
-	}
-	fmt.Print(`splines=ortho
-nodesep=0.4
-ranksep=0.8
-node [shape="box",style="rounded,filled"]
-edge [arrowsize="0.5"]
-`)
+	printer.writeHeader(*horizontal)
 
 	// sort packages
 	pkgKeys := []string{}
@@ -105,27 +107,12 @@ edge [arrowsize="0.5"]
 
 	for _, pkgName := range pkgKeys {
 		pkg := pkgs[pkgName]
-		pkgId := getId(pkgName)
 
 		if isIgnored(pkg) {
 			continue
 		}
 
-		var color string
-		switch {
-		case pkg.Goroot:
-			color = "palegreen"
-		case len(pkg.CgoFiles) > 0:
-			color = "darkgoldenrod1"
-		case isVendored(pkg.ImportPath):
-			color = "palegoldenrod"
-		case hasBuildErrors(pkg):
-			color = "red"
-		default:
-			color = "paleturquoise"
-		}
-
-		fmt.Printf("%s [label=\"%s\" color=\"%s\" URL=\"%s\" target=\"_blank\"];\n", pkgId, pkgName, color, pkgDocsURL(pkgName))
+		printer.writeNode(pkgName, pkg)
 
 		// Don't render imports from packages in Goroot
 		if pkg.Goroot && !*withGoroot {
@@ -138,11 +125,11 @@ edge [arrowsize="0.5"]
 				continue
 			}
 
-			impId := getId(imp)
-			fmt.Printf("%s -> %s;\n", pkgId, impId)
+			printer.writeEdge(pkgName, imp)
 		}
 	}
-	fmt.Println("}")
+
+	printer.writeEnd()
 }
 
 func pkgDocsURL(pkgName string) string {
@@ -212,21 +199,6 @@ func getImports(pkg *build.Package) []string {
 	return imports
 }
 
-func deriveNodeID(packageName string) string {
-	//TODO: improve implementation?
-	id := "\"" + packageName + "\""
-	return id
-}
-
-func getId(name string) string {
-	id, ok := ids[name]
-	if !ok {
-		id = deriveNodeID(name)
-		ids[name] = id
-	}
-	return id
-}
-
 func hasPrefixes(s string, prefixes []string) bool {
 	for _, p := range prefixes {
 		if strings.HasPrefix(s, p) {
@@ -259,14 +231,6 @@ func hasBuildErrors(pkg *build.Package) bool {
 	return v
 }
 
-func debug(args ...interface{}) {
-	fmt.Fprintln(os.Stderr, args...)
-}
-
-func debugf(s string, args ...interface{}) {
-	fmt.Fprintf(os.Stderr, s, args...)
-}
-
 func isVendored(path string) bool {
 	return strings.Contains(path, "/vendor/")
 }
@@ -275,3 +239,14 @@ func normalizeVendor(path string) string {
 	pieces := strings.Split(path, "vendor/")
 	return pieces[len(pieces)-1]
 }
+
+func getPrinter() (graphPrinter, error) {
+	switch *format {
+	case "dot":
+		return newGraphvizPrinter(), nil
+	case "mermaid":
+		return newMermaidPrinter(), nil
+	default:
+		return nil, fmt.Errorf("invalid format flag %q, must be: dot, mermaid", *format)
+	}
+}

mermaid_lang.go

@@ -0,0 +1,74 @@
+package main
+
+import (
+	"fmt"
+	"go/build"
+)
+
+// mermaidPrinter implements graphPrinter for the Mermaid diagramming language.
+type mermaidPrinter struct {
+	ids    map[string]string
+	nextId int
+}
+
+func newMermaidPrinter() *mermaidPrinter {
+	p := new(mermaidPrinter)
+	p.ids = make(map[string]string)
+	return p
+}
+
+func (p *mermaidPrinter) writeHeader(hLayout bool) {
+	if hLayout {
+		fmt.Println("flowchart LR")
+	} else {
+		fmt.Println("flowchart TD")
+	}
+
+	fmt.Println()
+	fmt.Println("classDef goroot fill:#1D4,color:white")
+	fmt.Println("classDef cgofiles fill:#D52,color:white")
+	fmt.Println("classDef vendored fill:#D90,color:white")
+	fmt.Println("classDef buildErrs fill:#C10,color:white")
+}
+
+func (p *mermaidPrinter) writeNode(pkgName string, attrs *build.Package) {
+	id := p.getId(pkgName)
+
+	var classname string
+	switch {
+	case attrs.Goroot:
+		classname = "goroot"
+	case len(attrs.CgoFiles) > 0:
+		classname = "cgofiles"
+	case isVendored(attrs.ImportPath):
+		classname = "vendored"
+	case hasBuildErrors(attrs):
+		classname = "buildErrs"
+	}
+
+	fmt.Println()
+	fmt.Printf("%s[%s]\n", id, pkgName)
+	fmt.Printf("click %s href %q\n", id, pkgDocsURL(pkgName))
+
+	if classname != "" {
+		fmt.Printf("class %s %s\n", id, classname)
+	}
+}
+
+func (p *mermaidPrinter) writeEdge(u string, v string) {
+	uId := p.getId(u)
+	vId := p.getId(v)
+	fmt.Printf("%s --> %s\n", uId, vId)
+}
+
+func (p *mermaidPrinter) getId(pkgName string) string {
+	id, ok := p.ids[pkgName]
+	if !ok {
+		p.nextId = p.nextId + 1
+		id = fmt.Sprintf("%d", p.nextId)
+		p.ids[pkgName] = id
+	}
+	return id
+}
+
+func (p *mermaidPrinter) writeEnd() {}