Add directory tree generation

Author: ole108

go.mod

@@ -1,6 +1,6 @@
 module github.com/flowdev/spaghetti-cutter
 
-go 1.14
+go 1.16
 
 require (
 	github.com/hjson/hjson-go v3.0.1+incompatible

go.sum

@@ -1,4 +1,3 @@
-github.com/hjson/hjson-go v0.2.3 h1:KhG7/PSxTibbYOzFso5FoiX2gWePcANaCsvM1WE/bTo=
 github.com/hjson/hjson-go v3.0.1+incompatible h1:JwOXblcMiBbiWue7iPkoFK9oXSnW8n+qXh/0Fio6TCo=
 github.com/hjson/hjson-go v3.0.1+incompatible/go.mod h1:qsetwF8NlsTsOTwZTApNlTCerV+b2GjYRRcIk4JMFio=
 github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=

main.go

@@ -37,11 +37,14 @@ func cut(args []string) int {
 		usageNoLinks   = "don't use links in '" + doc.FileName + "' files"
 		defaultStats   = "*"
 		usageStats     = "write '" + stat.FileName + "' for packages (separated by ','; '' for none)"
+		defaultDirTree = false
+		usageDirTree   = "write a directory tree to the 'dirtree.txt' file"
 	)
 	var startDir string
 	var docPkgs string
 	var noLinks bool
 	var statPkgs string
+	var dirTree bool
 	fs := flag.NewFlagSet("spaghetti-cutter", flag.ExitOnError)
 	fs.StringVar(&startDir, "root", defaultRoot, usageRoot)
 	fs.StringVar(&startDir, "r", defaultRoot, usageRoot+usageShort)
@@ -51,6 +54,8 @@ func cut(args []string) int {
 	fs.BoolVar(&noLinks, "l", defaultNoLinks, usageNoLinks+usageShort)
 	fs.StringVar(&statPkgs, "stats", defaultStats, usageStats)
 	fs.StringVar(&statPkgs, "s", defaultStats, usageStats+usageShort)
+	fs.BoolVar(&dirTree, "dirtree", defaultDirTree, usageDirTree)
+	fs.BoolVar(&dirTree, "t", defaultDirTree, usageDirTree+usageShort)
 	err := fs.Parse(args)
 	if err != nil {
 		log.Printf("FATAL - %v", err)
@@ -123,6 +128,10 @@ func cut(args []string) int {
 		log.Print("INFO - No documentation wanted.")
 	}
 
+	if dirTree {
+		writeDirTree(root, ".")
+	}
+
 	return retCode
 }
 
@@ -136,7 +145,7 @@ func writeStatistics(stPkgs, root, rootPkg string, depMap data.DependencyMap) {
 			continue
 		}
 		statFile := filepath.Join(statPkg, stat.FileName)
-		log.Printf("INFO - Write package statistics to file: %s", statFile)
+		log.Printf("INFO - Writeing package statistics to file: %s", statFile)
 		statFile = filepath.Join(root, statFile)
 		err := ioutil.WriteFile(statFile, []byte(statMD), 0644)
 		if err != nil {
@@ -156,6 +165,24 @@ func writeDocumentation(docPkgs, root, rootPkg string, noLinks bool, depMap data
 	doc.WriteDocs(dtPkgs, depMap, linkDocPkgs, rootPkg, root)
 }
 
+var mapEntry = struct{}{}
+
+func writeDirTree(root, name string) error {
+	treeFile := filepath.Join(root, dirs.TreeFile)
+	log.Printf("INFO - Writing directory tree to file: %s", treeFile)
+	tree, err := dirs.Tree(root, name, []string{"vendor", "testdata", ".*"})
+	if err != nil {
+		log.Print("ERROR - Unable to generate directory tree")
+		return err
+	}
+	err = ioutil.WriteFile(treeFile, []byte(tree), 0644)
+	if err != nil {
+		log.Printf("ERROR - Unable to write directory tree to file %s: %v", treeFile, err)
+		return err
+	}
+	return nil
+}
+
 func findPackagesWithFileAsSlice(signalFile, pkgNames, root, pkgType string) []string {
 	var pkgs []string
 	if pkgNames == "*" { // find all existing files

x/dirs/dirs.go

@@ -4,10 +4,20 @@ import (
 	"fmt"
 	"log"
 	"os"
+	"path"
 	"path/filepath"
 	"strings"
 )
 
+const (
+	TreeFile     = "dirtree.txt"
+	newLine      = "\n"
+	emptyItem    = "    "
+	middleItem   = "├── "
+	continueItem = "│   "
+	lastItem     = "└── "
+)
+
 // FindRoot finds the root of a project.
 // It looks for the configuration file: .spaghetti-cutter.json
 func FindRoot(startDir, cfgFile string) (string, error) {
@@ -94,3 +104,47 @@ func FindPkgsWithFile(file string, startPkgs []string, root string, excludeRoot
 	}
 	return retPkgs
 }
+
+func Tree(root, name string, exclude []string) (string, error) {
+	sb := &strings.Builder{}
+
+	err := generateTree(root, name, sb, "", exclude)
+	if err != nil {
+		return "", err
+	}
+	return sb.String(), nil
+}
+
+func generateTree(root, name string, sb *strings.Builder, indent string, exclude []string) error {
+	sb.WriteString(name)
+	sb.WriteString(newLine)
+
+	files, err := os.ReadDir(root)
+	if err != nil {
+		log.Printf("ERROR - Unable to read the directory %q: %v", root, err)
+		return err
+	}
+
+	lastI := len(files) - 1
+	for i, file := range files {
+		if file.IsDir() && includeFile(file.Name(), exclude) {
+			if i == lastI {
+				sb.WriteString(indent + lastItem)
+				generateTree(filepath.Join(root, file.Name()), file.Name(), sb, indent+emptyItem, exclude)
+			} else {
+				sb.WriteString(indent + middleItem)
+				generateTree(filepath.Join(root, file.Name()), file.Name(), sb, indent+continueItem, exclude)
+			}
+		}
+	}
+	return nil
+}
+
+func includeFile(name string, exclude []string) bool {
+	for _, ex := range exclude {
+		if m, _ := path.Match(ex, name); m {
+			return false
+		}
+	}
+	return true
+}