View dependencies (#60)

# Changes

## Primary change

## Supporting changes

- Add `dependency-graph` target to `src/go`
- Add related graphviz tool and documentation

## Future work

Break up the overly-modular CLI and use the idomatic `cobra-cli`
structure instead.

Author: kkrull

doc/task-automation.md

@@ -22,6 +22,11 @@ Manuals are written in Markdown.  This project uses Pandoc to generate `groff` m
 Markdown manuals in `man/groff/` and `man/markdown/`, respectively.  The Markdown manuals are
 included in the repository, for ease of reading on GitHub.
 
+### Targets in `src/go/`
+
+There are a number of tasks to build the Golang code and to assist with development.  Try `make
+help` to see what is available.
+
 ### Targets in `src/zsh`
 
 There isn't anything to build, since the programs are all scripts.  However, there are conventional

etc/macos/Brewfile.developer

@@ -1,4 +1,5 @@
 tap "homebrew/bundle"
+brew "graphviz"
 brew "fswatch"
 brew "pandoc"
 brew "pre-commit"

src/go/.gitignore

@@ -3,6 +3,9 @@ _marmot
 marmot
 marmot.exe
 
+# Dependencies
+dependencies.png
+
 # Testing
 coverage.html
 coverage.out

src/go/Makefile

@@ -103,7 +103,7 @@ all: $(executable) $(autocomplete) #> Build all sources
 
 .PHONY: clean
 clean: #> Remove local build files
-	$(RM) $(autocomplete) coverage.html coverage.out coverage-gaps.out $(executable)
+	$(RM) $(autocomplete) coverage.html coverage.out coverage-gaps.out dependencies.png $(executable)
 
 .PHONY: install
 install: $(executable) | $(bindir) $(datadirpkg) $(libexecdirpkg) #> Install program
@@ -145,6 +145,7 @@ install-autocomplete-zsh: $(autocomplete) | $(datadirzshfn) #> Install autocompl
 
 .PHONY: install-tools
 install-tools: #> Install Go development tools
+	go install github.com/kisielk/godepgraph@latest
 	go install github.com/go-delve/delve/cmd/dlv@latest
 	go install github.com/gregoryv/uncover/cmd/uncover@latest
 	go install github.com/onsi/ginkgo/v2/ginkgo
@@ -162,6 +163,10 @@ test-watch: #> Run tests in watch mode
 
 #. GO TARGETS
 
+.PHONY: dependency-graph
+dependency-graph: dependencies.png #> Make a dependency graph of packages in this module
+	@:
+
 .PHONY: format
 format: #> Format sources
 	gofumpt -l -w .
@@ -191,5 +196,9 @@ coverage.out: $(sources)
 coverage-gaps.out: coverage.out
 	uncover $< > $@
 
+dependencies.png: $(sources)
+	godepgraph -s github.com/kkrull/marmot | dot -Tpng -o $@
+	@echo "Wrote $@"
+
 $(executable): $(sources)
 	go build -o $(executable) $(source_main)

src/go/cmd/root/cli_config_parser.go

@@ -39,25 +39,7 @@ func (parser rootConfigParser) Parse(
 	} else if metaRepoPath, pathErr := metaRepoFlag.GetString(flags); pathErr != nil {
 		return nil, pathErr
 	} else {
-		metaRepoAdmin := svcfs.NewJsonMetaRepoAdmin(parser.version)
-		jsonMetaRepo := svcfs.NewJsonMetaRepo(metaRepoPath)
-		config := &rootCliConfig{
-			args: args,
-			cmdFactory: use.NewCommandFactory().
-				WithLocalRepositorySource(jsonMetaRepo).
-				WithMetaDataAdmin(metaRepoAdmin).
-				WithRemoteRepositorySource(jsonMetaRepo),
-			debug:        debug,
-			flagSet:      flags,
-			inputLines:   make([]string, 0),
-			metaRepoPath: metaRepoPath,
-			queryFactory: use.NewQueryFactory().
-				WithLocalRepositorySource(jsonMetaRepo).
-				WithMetaDataAdmin(metaRepoAdmin).
-				WithRemoteRepositorySource(jsonMetaRepo),
-		}
-
-		return config, nil
+		return parser.assemble(args, debug, flags, make([]string, 0), metaRepoPath), nil
 	}
 }
 
@@ -80,36 +62,53 @@ func (parser rootConfigParser) ParseR(
 			}
 		}
 
-		inputLines := make([]string, 0)
-		if readFromStdin {
-			scanner := bufio.NewScanner(stdin)
-			for scanner.Scan() {
-				line := scanner.Text()
-				inputLines = append(inputLines, line)
-			}
-			if scanErr := scanner.Err(); scanErr != nil {
-				return nil, scanErr
-			}
+		if !readFromStdin {
+			return parser.assemble(argsBeforeDash, debug, flags, make([]string, 0), metaRepoPath), nil
+		} else if inputLines, scanErr := readLines(stdin); scanErr != nil {
+			return nil, scanErr
+		} else {
+			return parser.assemble(argsBeforeDash, debug, flags, inputLines, metaRepoPath), nil
 		}
+	}
+}
 
-		metaRepoAdmin := svcfs.NewJsonMetaRepoAdmin(parser.version)
-		jsonMetaRepo := svcfs.NewJsonMetaRepo(metaRepoPath)
-		config := &rootCliConfig{
-			args: argsBeforeDash,
-			cmdFactory: use.NewCommandFactory().
-				WithLocalRepositorySource(jsonMetaRepo).
-				WithMetaDataAdmin(metaRepoAdmin).
-				WithRemoteRepositorySource(jsonMetaRepo),
-			debug:        debug,
-			flagSet:      flags,
-			inputLines:   inputLines,
-			metaRepoPath: metaRepoPath,
-			queryFactory: use.NewQueryFactory().
-				WithLocalRepositorySource(jsonMetaRepo).
-				WithMetaDataAdmin(metaRepoAdmin).
-				WithRemoteRepositorySource(jsonMetaRepo),
-		}
+func (parser rootConfigParser) assemble(
+	args []string,
+	debug bool,
+	flags *pflag.FlagSet,
+	inputLines []string,
+	metaRepoPath string,
+) CliConfig {
+	metaRepoAdmin := svcfs.NewJsonMetaRepoAdmin(parser.version)
+	jsonMetaRepo := svcfs.NewJsonMetaRepo(metaRepoPath)
+	return &rootCliConfig{
+		args: args,
+		cmdFactory: use.NewCommandFactory().
+			WithLocalRepositorySource(jsonMetaRepo).
+			WithMetaDataAdmin(metaRepoAdmin).
+			WithRemoteRepositorySource(jsonMetaRepo),
+		debug:        debug,
+		flagSet:      flags,
+		inputLines:   inputLines,
+		metaRepoPath: metaRepoPath,
+		queryFactory: use.NewQueryFactory().
+			WithLocalRepositorySource(jsonMetaRepo).
+			WithMetaDataAdmin(metaRepoAdmin).
+			WithRemoteRepositorySource(jsonMetaRepo),
+	}
+}
 
-		return config, nil
+func readLines(stdin io.Reader) ([]string, error) {
+	inputLines := make([]string, 0)
+	scanner := bufio.NewScanner(stdin)
+	for scanner.Scan() {
+		line := scanner.Text()
+		inputLines = append(inputLines, line)
+	}
+
+	if scanErr := scanner.Err(); scanErr != nil {
+		return nil, scanErr
+	} else {
+		return inputLines, nil
 	}
 }