state

package

v0.3.0 Latest Latest Go to latest Published: Jun 15, 2021 License: Apache-2.0 Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/JayceChant/commit-msg

Links

Open Source Insights

Documentation ¶

Index ¶

func Init(language LangPack, typeStr string)
type LangPack
type State

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Init ¶

func Init(language LangPack, typeStr string)

Init ...

Types ¶

type LangPack ¶

type LangPack interface {
	GetHint(state State, v ...interface{}) string
	GetRule(types string) string
}

type State ¶

type State int8

State indicate the state of a commit message

const (
	// normal state
	Validated State = iota
	Merge
	// non format error
	ArgumentMissing
	FileMissing
	ReadError
	// format error
	EmptyMessage
	EmptyHeader
	BadHeaderFormat
	WrongType
	ScopeMissing
	WrongScope
	BodyMissing
	NoBlankLineBeforeBody
	LineOverLong
	UndefindedError
)

message states

func (State) IsFormatError ¶

func (state State) IsFormatError() bool

IsFormatError return if the state a format error

func (State) IsNormal ¶

func (state State) IsNormal() bool

IsNormal return if the state a normal state

func (State) LogAndExit ¶

func (state State) LogAndExit(v ...interface{})

LogAndExit ...

func (State) MarshalText ¶ added in v0.3.0

func (state State) MarshalText() (text []byte, err error)

func (State) String ¶ added in v0.3.0

func (i State) String() string

func (*State) UnmarshalText ¶ added in v0.3.0

func (state *State) UnmarshalText(text []byte) error

Source Files ¶

View all Source files

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