cmd

Documentation

Overview

Package cmd contains commitlint cli

Index

• Constants
• func CreateConfig(onlyEnabled bool) error
• func CreateHook() (retErr error)
• func Init(isGlobal bool) error
• func Lint(confPath, msgPath string) error
• func New() *cli.App
• func NewWith(versionNo, commitHash, builtTime string) *cli.App
• func VerifyConfig(confFlag string) error

Constants

const (
	// ErrExitCode represent error exit code
	ErrExitCode = 1

	// HookDir represent default hook directory
	HookDir = ".commitlint/hooks"
)

Functions

func CreateConfig

func CreateConfig(onlyEnabled bool) error

CreateConfig is the callback function for create config command

func CreateHook

func CreateHook() (retErr error)

CreateHook is the callback function for create hook command

func Init

func Init(isGlobal bool) error

Init is the callback function for init command

func Lint

func Lint(confPath, msgPath string) error

Lint is the callback function for lint command

func New

func New() *cli.App

New returns commitlint cli.App

func NewWith

func NewWith(versionNo, commitHash, builtTime string) *cli.App

NewWith returns commitlint cli.App with version info

func VerifyConfig

func VerifyConfig(confFlag string) error

VerifyConfig is the callback function for verify command