internal

package

v0.0.3 Latest Latest Go to latest Published: Jul 18, 2021 License: Apache-2.0 Imports: 12 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/Makepad-fr/concom

Documentation ¶

Index ¶

func Blue(title string, message string)
func Commit(projectPath, message string) error
func Error(message string)
func Green(title string, message string)
func HasStagedChanges(p string) bool
func Info(message string)
func IsGitRepository(p string) bool
func Red(title string, message string)
func Success(message string)
func SuggestOtherCommand(useCase, command, helpCommand string)
func Warning(message string)
func YNQuestion(defaultValue *bool, message string)
func Yellow(title string, message string)
type CommitMessage
- func (c *CommitMessage) String() string
type ConfigItem
- func AddConfigItem(it string) (scope *ConfigItem, err error)
type Project
- func LoadProject() (p *Project, err error)
- func (p *Project) AddConventions() (err error)
- func (p *Project) AddScopes() (err error)
- func (p *Project) Commit() (err error)
- func (p *Project) CreateCommitMessage() (commit *CommitMessage, err error)
- func (p *Project) CreateGitCommand() error
- func (p *Project) New(version string) (err error)
- func (p *Project) ResetScopes()
- func (p *Project) ScopeFromString(typeString string) *ConfigItem
- func (p *Project) ScopeString() []string
- func (p *Project) TypeFromString(typeString string) *ConfigItem
- func (p *Project) TypesString() []string
- func (p *Project) WriteConfigFile() (err error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Blue ¶

func Blue(title string, message string)

func Commit ¶

func Commit(projectPath, message string) error

func Error ¶

func Error(message string)

func Green ¶

func Green(title string, message string)

func HasStagedChanges ¶

func HasStagedChanges(p string) bool

func Info ¶

func Info(message string)

func IsGitRepository ¶

func IsGitRepository(p string) bool

func Red ¶

func Red(title string, message string)

func Success ¶

func Success(message string)

func SuggestOtherCommand ¶

func SuggestOtherCommand(useCase, command, helpCommand string)

func Warning ¶

func Warning(message string)

func YNQuestion ¶

func YNQuestion(defaultValue *bool, message string)

func Yellow ¶

func Yellow(title string, message string)

Types ¶

type CommitMessage ¶

type CommitMessage struct {
	Type        ConfigItem
	Scope       *ConfigItem
	Description string
	Body        string
	Footers     string
}

func (*CommitMessage) String ¶

func (c *CommitMessage) String() string

type ConfigItem ¶

type ConfigItem struct {
	Name        string
	Description string
}

func AddConfigItem ¶

func AddConfigItem(it string) (scope *ConfigItem, err error)

type Project ¶

type Project struct {
	ConfigFilePath string
	Path           string
	Version        string
	Scopes         []ConfigItem
	Conventions    []ConfigItem
}

func LoadProject ¶

func LoadProject() (p *Project, err error)

func (*Project) AddConventions ¶

func (p *Project) AddConventions() (err error)

func (*Project) AddScopes ¶

func (p *Project) AddScopes() (err error)

func (*Project) Commit ¶

func (p *Project) Commit() (err error)

func (*Project) CreateCommitMessage ¶

func (p *Project) CreateCommitMessage() (commit *CommitMessage, err error)

func (*Project) CreateGitCommand ¶

func (p *Project) CreateGitCommand() error

func (*Project) New ¶

func (p *Project) New(version string) (err error)

func (*Project) ResetScopes ¶

func (p *Project) ResetScopes()

func (*Project) ScopeFromString ¶

func (p *Project) ScopeFromString(typeString string) *ConfigItem

func (*Project) ScopeString ¶

func (p *Project) ScopeString() []string

func (*Project) TypeFromString ¶

func (p *Project) TypeFromString(typeString string) *ConfigItem

func (*Project) TypesString ¶

func (p *Project) TypesString() []string

func (*Project) WriteConfigFile ¶

func (p *Project) WriteConfigFile() (err error)

Source Files ¶

View all Source files

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