Documentation
¶
Index ¶
- func Get(msg string) (string, error)
- func GetCommitType(printHelp bool) (string, error)
- func GetMultiLineInput(msg string) (string, error)
- func GetNonEmpty(msg string) (string, error)
- func GetWithDefault(msg, defa string) (string, error)
- func WriteState(path string, pair []TeamMember, story string) error
- func WriteTeamMembersConfig(path string, tms []TeamMember) error
- type CommitConfig
- type State
- type TeamMember
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetCommitType ¶
func GetMultiLineInput ¶
GetMultiLineInput lets a user input many lines until two blank lines follow one another.
func GetNonEmpty ¶
GetNonEmpty asks for user-input until the input is not empty.
func GetWithDefault ¶
GetWithDefault asks for user-input and provides a default.
func WriteState ¶
func WriteState(path string, pair []TeamMember, story string) error
WriteState marshalls and saves the new pair and story to filesystem.
func WriteTeamMembersConfig ¶
func WriteTeamMembersConfig(path string, tms []TeamMember) error
WriteTeamMembersConfig writes a list of team-members to the filesystem.
Types ¶
type CommitConfig ¶
type CommitConfig struct {
// Story mode defines if you will be asked for the current story.
CommitStyle string `json:"commitStyle"`
// TeamMembersConfigPath specifies the path to the team-members-configuration-file.
TeamMembersConfigPath string `json:"teamMembersConfigPath"`
}
CommitConfig contains two configuration-parameters.
func InitCommitConfig ¶
func InitCommitConfig(path string) (CommitConfig, error)
InitCommitConfig reads and validates the commit-configuration and returns the corresponding object or error.
func (*CommitConfig) String ¶
func (c *CommitConfig) String() string
type State ¶
type State struct {
// CurrentScope specifies the last saved story.
CurrentScope string `json:"story"`
// CurrentPair specifies the last saved pairing-partner.
CurrentPair []string `json:"pair"`
}
State contains two state-parameters.
type TeamMember ¶
type TeamMember struct {
GithubUserName string `json:"username"`
Email string `json:"mail"`
Abbreviation string `json:"abbreviation"`
}
TeamMember contains all information needed to identify a single team-member.
func InitTeamMembersConfig ¶
func InitTeamMembersConfig(path string) ([]TeamMember, error)
InitTeamMembersConfig reads and parses a TeamMembersConfig. If not found, it creates on.
func (TeamMember) String ¶
func (tm TeamMember) String() string
Source Files