guard

package

v0.6.0 Latest Latest Go to latest Published: May 26, 2026 License: GPL-3.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/CommitBrief/commitbrief

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Triggers(d diff.Diff) []string
type Options
type Result
- func CheckDiffForLocalConfig(d diff.Diff, opts Options) (Result, error)
- func (r Result) String() string

Constants ¶

View Source

const PathPrefix = ".commitbrief/"

PathPrefix is the trigger condition: any diff file whose path starts with this string (i.e., lives under the .commitbrief/ directory) prompts the user. Root-level COMMITBRIEF.md and .commitbriefignore are intentionally excluded — they are team-shared by design (ADR-0007).

Variables ¶

This section is empty.

Functions ¶

func Triggers ¶

func Triggers(d diff.Diff) []string

Types ¶

type Options ¶

type Options struct {
	AssumeYes      bool
	NonInteractive bool
	Writer         io.Writer
	Reader         io.Reader
}

type Result ¶

type Result int

const (
	Continue Result = iota
	Abort
)

func CheckDiffForLocalConfig ¶

func CheckDiffForLocalConfig(d diff.Diff, opts Options) (Result, error)

func (Result) String ¶

func (r Result) String() string

Source Files ¶

View all Source files

presend.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL