feat: generator subcommand implementation

implement the base set of functionality for the
generator command
TODO: should improve the naming of the internal structs

Author: barelyhuman

.gitignore

@@ -1,4 +1,5 @@
 CHANGELOG.md
 ./commitlog
 .DS_Store
-dist
+dist
+commitlog

commands/commitlog.go

@@ -1,7 +1,70 @@
 package commands
 
-import "github.com/urfave/cli/v2"
+import (
+	"github.com/barelyhuman/commitlog/pkg"
+	"github.com/urfave/cli/v2"
+)
 
 func Commitlog(c *cli.Context) (err error) {
-	return
+	path := c.String("path")
+	addPromo := c.Bool("promo")
+	out := c.String("out")
+	stdio := c.Bool("stdio")
+	startRef := c.String("start")
+	endRef := c.String("end")
+	categories := c.String("categories")
+
+	gOptions := []pkg.GeneratorConfigMod{}
+
+	if addPromo {
+		gOptions = append(gOptions,
+			pkg.WithPromo(),
+		)
+	}
+
+	// either write to a file or to the stdio with true by default
+	if len(out) > 0 {
+		gOptions = append(gOptions,
+			pkg.WithOutputToFile(out),
+		)
+	} else if stdio {
+		gOptions = append(gOptions,
+			pkg.WithOutputToStdio(),
+		)
+	}
+
+	if len(startRef) > 0 {
+		gOptions = append(gOptions,
+			pkg.WithStartReference(startRef),
+		)
+	}
+
+	if len(endRef) > 0 {
+		gOptions = append(gOptions,
+			pkg.WithEndReference(endRef),
+		)
+	}
+
+	if len(categories) > 0 {
+		gOptions = append(gOptions,
+			pkg.WithCategories(categories),
+		)
+	}
+
+	generator := pkg.CreateGenerator(path,
+		gOptions...)
+
+	err = generator.ReadCommmits()
+
+	if err != nil {
+		return err
+	}
+
+	err = generator.Classify()
+
+	if err != nil {
+		return err
+	}
+
+	return generator.Generate()
 }

lib/commits.go

@@ -0,0 +1,51 @@
+package lib
+
+import (
+	"log"
+	"strings"
+
+	"github.com/go-git/go-git/v5"
+	"github.com/go-git/go-git/v5/plumbing"
+	"github.com/go-git/go-git/v5/plumbing/object"
+)
+
+func IsHashATag(currentRepository *git.Repository, hash plumbing.Hash) bool {
+	isTag := false
+	tags, _ := currentRepository.Tags()
+	tags.ForEach(func(tagRef *plumbing.Reference) error {
+		revHash, err := currentRepository.ResolveRevision(plumbing.Revision(tagRef.Name()))
+		if err != nil {
+			return err
+		}
+		if *revHash == hash {
+			isTag = true
+		}
+		return nil
+	})
+	return isTag
+}
+
+func GetCommitFromString(repo *git.Repository, commitString string) *object.Commit {
+	if commitString == "" {
+		return nil
+	}
+
+	hash, err := repo.ResolveRevision(plumbing.Revision(commitString))
+	if err != nil {
+		log.Fatal("Unable to get Repo head:", err)
+	}
+
+	commitRef, err := repo.CommitObject(*hash)
+	if err != nil {
+		log.Fatal("Unable to get resolve commit:", err)
+	}
+	return commitRef
+}
+
+func CommitToLog(c *object.Commit) string {
+	var commitMsg strings.Builder
+	commitMsg.WriteString(c.Hash.String())
+	commitMsg.WriteString(" ")
+	commitMsg.WriteString(strings.Split(c.Message, "\n")[0])
+	return commitMsg.String()
+}

main.go

@@ -33,25 +33,40 @@ func main() {
 					return commands.Commitlog(c)
 				},
 				Flags: []cli.Flag{
+					&cli.StringFlag{
+						Name:    "path",
+						Value:   ".",
+						Aliases: []string{"p"},
+						Usage:   "root with the '.git' folder `PATH`",
+					},
 					&cli.BoolFlag{
 						Name:  "promo",
 						Usage: "add promo text to the end of output",
 					},
 					&cli.StringFlag{
-						Name:  "out",
-						Usage: "path to the output `FILE`",
+						Name:    "out",
+						Aliases: []string{"o"},
+						Usage:   "path to the output `FILE`",
 					},
 					&cli.BoolFlag{
 						Name:  "stdio",
+						Value: true,
 						Usage: "print to the stdout",
 					},
 					&cli.StringFlag{
-						Name: "start",
+						Name:  "categories",
+						Value: "",
+						Usage: "categories to use, includes all commits by default. any text you add here will be used to create categories out of the commits",
+					},
+					&cli.StringFlag{
+						Name:    "start",
+						Aliases: []string{"s"},
 						Usage: "`START` reference for the commit to include commits from," +
 							"This is inclusive of the given commit reference",
 					},
 					&cli.StringFlag{
-						Name: "end",
+						Name:    "end",
+						Aliases: []string{"e"},
 						Usage: "`END` reference for the commit to stop including commits at." +
 							"This is exclusive of the given commit reference",
 					},