feat(conf/branchs): add branch enums in configuration which will replace builtin branch enums when it is configured.

Author: yeqown

cmd/gitlab-flow/support.go

@@ -92,23 +92,23 @@ func getOpFeatureContext(c *cli.Context) *types.OpFeatureContext {
 
 func getFlow(c *cli.Context) internal.IFlow {
 	flags := parseGlobalFlags(c)
-	ctx := setEnviron(flags)
+	ctx := resolveFlags(flags)
 	return internal.NewFlow(ctx)
 }
 
 func getDash(c *cli.Context) internal.IDash {
 	flags := parseGlobalFlags(c)
-	ctx := setEnviron(flags)
+	ctx := resolveFlags(flags)
 	return internal.NewDash(ctx)
 }
 
-// setEnviron set global environment of debug mode.
+// resolveFlags set global environment of debug mode.
 // DONE(@yeqown): apply project name from CLI and CWD.
 // DONE(@yeqown): CWD could be configured from CLI.
-func setEnviron(flags globalFlags) *types.FlowContext {
+func resolveFlags(flags globalFlags) *types.FlowContext {
 	log.
 		WithField("flags", flags).
-		Debugf("setEnviron called")
+		Debugf("resolveFlags called")
 
 	// get absolute path of current working directory.
 	cwd, err := filepath.Abs(flags.CWD)
@@ -119,26 +119,28 @@ func setEnviron(flags globalFlags) *types.FlowContext {
 	}
 
 	// prepare configuration
-	cfg, err := conf.Load(flags.ConfPath, nil)
-	if err != nil {
+	var c *types.Config
+	if c, err = conf.Load(flags.ConfPath, nil); err != nil {
 		log.
 			WithField("path", flags.ConfPath).
 			Fatalf("could not load config file: %v", err)
 	}
 
 	// pass flags parameters into configuration
 	if flags.DebugMode {
-		cfg.DebugMode = flags.DebugMode
+		c.DebugMode = flags.DebugMode
 	}
 	if flags.OpenBrowser {
-		cfg.OpenBrowser = flags.OpenBrowser
+		c.OpenBrowser = flags.OpenBrowser
 	}
 
-	if err = cfg.Valid(); err != nil {
+	if err = c.Valid(); err != nil {
 		log.
-			WithField("cfg", cfg).
+			WithField("config", c).
 			Fatalf("config is invalid")
 	}
 
-	return types.NewContext(cwd, flags.ConfPath, flags.ProjectName, cfg, flags.ForceRemote)
+	types.SyncBranchSetting(c.Branch.Master, c.Branch.Dev, c.Branch.Test)
+
+	return types.NewContext(cwd, flags.ConfPath, flags.ProjectName, c, flags.ForceRemote)
 }

internal/conf/conf.go

@@ -35,7 +35,14 @@ func Load(confPath string, parser ConfigParser) (cfg *types.Config, err error) {
 	var (
 		r io.Reader
 	)
-	cfg = new(types.Config)
+	cfg = &types.Config{
+		OAuth:        new(types.OAuth),
+		Branch:       new(types.BranchSetting),
+		GitlabAPIURL: "",
+		GitlabHost:   "",
+		DebugMode:    false,
+		OpenBrowser:  false,
+	}
 	p := precheckConfigDirectory(confPath)
 	r, err = os.OpenFile(p, os.O_RDONLY, 0777)
 	if err != nil {
@@ -69,6 +76,11 @@ func Save(confPath string, cfg *types.Config, parser ConfigParser) error {
 
 var (
 	defaultConf = &types.Config{
+		Branch: &types.BranchSetting{
+			Master: types.MasterBranch,
+			Dev:    types.DevBranch,
+			Test:   types.TestBranch,
+		},
 		OAuth: &types.OAuth{
 			AccessToken:  "",
 			RefreshToken: "",

internal/types/config.go

@@ -12,9 +12,15 @@ type OAuth struct {
 	RefreshToken string `toml:"refresh_token"`
 }
 
+// BranchSetting contains some personal setting of git branch.
+type BranchSetting struct {
+	Master, Dev, Test BranchTyp
+}
+
 // Config contains all fields can be specified by user.
 type Config struct {
-	OAuth *OAuth
+	OAuth  *OAuth         `toml:"oauth"`
+	Branch *BranchSetting `toml:"branch"`
 
 	// Deprecated: use oauth as instead
 	//AccessToken string `toml:"access_token"`

internal/types/enums.go

@@ -7,9 +7,22 @@ func (b BranchTyp) String() string {
 	return string(b)
 }
 
-// TODO(@yeqown) MasterBranch, DevBranch and TestBranch could be customized.
+// DONE(@yeqown) MasterBranch, DevBranch and TestBranch could be customized.
 var (
 	MasterBranch BranchTyp = "master"
 	DevBranch    BranchTyp = "develop"
 	TestBranch   BranchTyp = "test"
 )
+
+// SyncBranchSetting reset builtin branch enums manually.
+func SyncBranchSetting(master, dev, test BranchTyp) {
+	if master != "" {
+		MasterBranch = master
+	}
+	if dev != "" {
+		DevBranch = dev
+	}
+	if test != "" {
+		TestBranch = test
+	}
+}