git-sv/app/commands/validatecommitmessage.go

package commands

import (
	"errors"
	"fmt"
	"path/filepath"

	"github.com/rs/zerolog/log"
	"github.com/thegeeklab/git-sv/app"
	"github.com/urfave/cli/v2"
)

const laxFilePerm = 0o644

var (
	errReadCommitMessage = errors.New("failed to read commit message")
	errAppendFooter      = errors.New("failed to append meta-informations on footer")
)

func ValidateCommitMessageFlags() []cli.Flag {
	return []cli.Flag{
		&cli.StringFlag{
			Name:     "path",
			Required: true,
			Usage:    "git working directory",
		},
		&cli.StringFlag{
			Name:     "file",
			Required: true,
			Usage:    "name of the file that contains the commit log message",
		},
		&cli.StringFlag{
			Name:     "source",
			Required: true,
			Usage:    "source of the commit message",
		},
	}
}

func ValidateCommitMessageHandler(g app.GitSV) cli.ActionFunc {
	return func(c *cli.Context) error {
		branch := g.Branch()
		detached, derr := g.IsDetached()

		if g.MessageProcessor.SkipBranch(branch, derr == nil && detached) {
			log.Warn().Msg("commit message validation skipped, branch in ignore list or detached...")

			return nil
		}

		if source := c.String("source"); source == "merge" {
			log.Warn().Msgf("commit message validation skipped, ignoring source: %s...", source)

			return nil
		}

		filepath := filepath.Join(c.String("path"), c.String("file"))

		commitMessage, err := readFile(filepath)
		if err != nil {
			return fmt.Errorf("%w: %s", errReadCommitMessage, err.Error())
		}

		if err := g.MessageProcessor.Validate(commitMessage); err != nil {
			return fmt.Errorf("%w: %s", errReadCommitMessage, err.Error())
		}

		msg, err := g.MessageProcessor.Enhance(branch, commitMessage)
		if err != nil {
			log.Warn().Err(err).Msg("could not enhance commit message")

			return nil
		}

		if msg == "" {
			return nil
		}

		if err := appendOnFile(msg, filepath, laxFilePerm); err != nil {
			return fmt.Errorf("%w: %s", errAppendFooter, err.Error())
		}

		return nil
	}
}