omissis/goarkitect

package expect

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

    "github.com/omissis/goarkitect/internal/arch/rule"
)

func BeGitignored(opts ...Option) *gitIgnoredExpression {
    expr := &gitIgnoredExpression{}

    expr.applyOptions(opts)

    return expr
}

type gitIgnoredExpression struct {
    baseExpression
}

func (e gitIgnoredExpression) Evaluate(rb rule.Builder) []rule.CoreViolation {
    return e.evaluate(rb, e.doEvaluate, e.getViolation)
}

func (e gitIgnoredExpression) doEvaluate(rb rule.Builder, filePath string) bool {
    cmd := exec.Command("git", "check-ignore", "-q", filePath)
    if err := cmd.Run(); err != nil {
        var terr *exec.ExitError
        if errors.As(err, &terr) {
            return terr.ExitCode() != 0
        }

        rb.AddError(err)

        return true
    }

    return false
}

func (e gitIgnoredExpression) getViolation(filePath string) rule.CoreViolation {
    format := "file '%s' is not gitignored"

    if e.options.negated {
        format = "file '%s' is gitignored"
    }

    return rule.NewCoreViolation(
        fmt.Sprintf(format, filepath.Base(filePath)),
    )
}