check

Documentation

Index

• Variables
• func IsCommitConventional(commitMessage string) bool
• type Options
  • func NewCmdCheckSemantics() (*cobra.Command, *Options)
  • func (o *Options) Run() error
  • func (o *Options) Validate() error

Variables

var (
	ConventionalCommitTypes = []string{"feat", "fix", "perf", "refactor", "docs", "test", "revert", "style", "chore", "build"}
)

Functions

func IsCommitConventional

func IsCommitConventional(commitMessage string) bool

IsCommitConventional checks whether a commit message follows the conventions by comparing its prefix to those in ConventionalCommitTypes

Types

type Options

type Options struct {
	options.BaseOptions

	ScmFactory    scmhelpers.Options
	GitClient     gitclient.Interface
	CommandRunner cmdrunner.CommandRunner
	// contains filtered or unexported fields
}

Options contains the command line flags

func NewCmdCheckSemantics

func NewCmdCheckSemantics() (*cobra.Command, *Options)

NewCmdCheckSemantics creates a command object for the command

func (*Options) Run

func (o *Options) Run() error

func (*Options) Validate

func (o *Options) Validate() error

Validate checks that all the variables required to run are present