Documentation ¶
Index ¶
- Constants
- func Execute()
- func JustDo(s *ShimConf) (err error)
- type Answer
- type Builder
- type CLI
- type CLIContext
- type CommitGroupOptions
- type CommitMessageFormat
- type CommitOptions
- type Config
- type ConfigBuilder
- type ConfigLoader
- type File
- type FileSystem
- type Generator
- type Info
- type InitContext
- type Initializer
- type IssueOptions
- type Logger
- type NoteOptions
- type Options
- type PatternOptions
- type Previewable
- type ProcessorFactory
- type Questioner
- type RefOptions
- type ShimConf
- type TemplateBuilder
- type TemplateBuilderFactory
- type TemplateStyleFormat
Constants ¶
View Source
const ( ExitCodeOK = iota ExitCodeError )
Status code
View Source
const Version = "0.8.0"
Version of git-chglog cli client
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Answer ¶
type Answer struct { RepositoryURL string `survey:"repository_url"` Style string `survey:"style"` CommitMessageFormat string `survey:"commit_message_format"` Template string `survey:"template"` IncludeMerges bool `survey:"include_merges"` IncludeReverts bool `survey:"include_reverts"` ConfigDir string `survey:"config_dir"` }
Answer ...
type CLI ¶
type CLI struct {
// contains filtered or unexported fields
}
CLI ...
func NewCLI ¶
func NewCLI( ctx *CLIContext, fs FileSystem, configLoader ConfigLoader, generator Generator, ) *CLI
NewCLI ...
type CLIContext ¶
type CLIContext struct { WorkingDir string Stdout io.Writer Stderr io.Writer ConfigPath string OutputPath string Silent bool NoColor bool NoEmoji bool Query string NextTag string }
CLIContext ...
type CommitGroupOptions ¶
type CommitGroupOptions struct { GroupBy string `yaml:"group_by"` SortBy string `yaml:"sort_by"` TitleMaps map[string]string `yaml:"title_maps"` }
CommitGroupOptions ...
type CommitMessageFormat ¶
type CommitMessageFormat struct {
// contains filtered or unexported fields
}
CommitMessageFormat ...
func (*CommitMessageFormat) PatternMapString ¶
func (f *CommitMessageFormat) PatternMapString() string
PatternMapString ...
type CommitOptions ¶
type CommitOptions struct { Filters map[string][]string `yaml:"filters"` SortBy string `yaml:"sort_by"` }
CommitOptions ...
type Config ¶
type Config struct { Bin string `yaml:"bin"` Template string `yaml:"template"` Style string `yaml:"style"` Info Info `yaml:"info"` Options Options `yaml:"options"` }
Config ...
type ConfigLoader ¶
ConfigLoader ...
type File ¶
type File interface { io.Closer io.Reader io.ReaderAt io.Seeker io.Writer Stat() (os.FileInfo, error) }
File ...
type FileSystem ¶
type FileSystem interface { Exists(path string) bool MkdirP(path string) error Create(name string) (File, error) WriteFile(path string, content []byte) error }
FileSystem ...
type Generator ¶
Generator ...
func NewGeneratorSemVer ¶
func NewGeneratorSemVer() Generator
NewGeneratorSemVer : Returns a SemVer safe generator
type InitContext ¶
InitContext ...
type Initializer ¶
type Initializer struct {
// contains filtered or unexported fields
}
Initializer ...
func NewInitializer ¶
func NewInitializer( ctx *InitContext, fs FileSystem, questioner Questioner, configBuilder ConfigBuilder, tplBuilderFactory TemplateBuilderFactory) *Initializer
NewInitializer ...
type Logger ¶
type Logger struct {
// contains filtered or unexported fields
}
Logger ...
type Options ¶
type Options struct { Commits CommitOptions `yaml:"commits"` CommitGroups CommitGroupOptions `yaml:"commit_groups"` Header PatternOptions `yaml:"header"` Issues IssueOptions `yaml:"issues"` Refs RefOptions `yaml:"refs"` Merges PatternOptions `yaml:"merges"` Reverts PatternOptions `yaml:"reverts"` Notes NoteOptions `yaml:"notes"` }
Options ...
type PatternOptions ¶
type PatternOptions struct { Pattern string `yaml:"pattern"` PatternMaps []string `yaml:"pattern_maps"` }
PatternOptions ...
type ProcessorFactory ¶
type ProcessorFactory struct {
// contains filtered or unexported fields
}
ProcessorFactory ...
type Questioner ¶
Questioner ...
func NewQuestioner ¶
func NewQuestioner(client gitcmd.Client, fs FileSystem) Questioner
NewQuestioner ...
type ShimConf ¶
type ShimConf struct { Init bool ConfigPath string OutputPath string Query string NextTag string Silent bool NoColor bool NoEmoji bool SemVerOnly bool }
ShimConf : Conf loader that stores the variables needed to run the library without URFave CLI
type TemplateBuilder ¶
type TemplateBuilder interface { Builder }
TemplateBuilder ...
func NewCustomTemplateBuilder ¶
func NewCustomTemplateBuilder() TemplateBuilder
NewCustomTemplateBuilder ...
type TemplateBuilderFactory ¶
type TemplateBuilderFactory = func(string) TemplateBuilder
TemplateBuilderFactory ...
type TemplateStyleFormat ¶
type TemplateStyleFormat struct {
// contains filtered or unexported fields
}
TemplateStyleFormat ...
Source Files ¶
- bare_commands.go
- builder.go
- cli.go
- config.go
- config_builder.go
- config_builder_mock.go
- config_loader.go
- config_loader_mock.go
- context.go
- custom_template_builder.go
- fs.go
- fs_mock.go
- generator.go
- generator_mock.go
- initializer.go
- kac_template_builder.go
- logger.go
- main.go
- processor_factory.go
- questioner.go
- questioner_mock.go
- status_code.go
- template_builder.go
- template_builder_mock.go
- utils.go
- variables.go
- version.go
Click to show internal directories.
Click to hide internal directories.