add config to README.md

Author: mrados7

README.md

@@ -1,10 +1,10 @@
 # go-git-commands
 
 ## checkout
+
 Creates a new branch from the current branch using naming strategy `<type>/<ticket-id>/<branch-name>`.
 Supported types are `FEAT`, `FIX`, `IMPR`, `OPS`.
 
-
 ### Install
 
 ```bash
@@ -32,9 +32,44 @@ brew install mrados7/main/commit
 go install github.com/mrados7/go-git-commands/commit@latest
 ```
 
-
 ### Usage
 
 ```bash
 commit
 ```
+
+## Config file
+
+You can add a config file to project directory `.git-commands.json` to override the default values.
+
+```json
+{
+  "branchTypes": [
+    {
+      "type": "FEAT",
+      "description": "A new feature"
+    },
+    {
+      "type": "FIX",
+      "description": "A bug fix"
+    },
+    {
+      "type": "DOCS",
+      "description": "Documentation only changes"
+    },
+    ...
+  ],
+  "boards": [
+    {
+      "name": "PLF",
+      "description": "Platform Team Board"
+    },
+    {
+      "name": "SD",
+      "description": "Support Desk Board"
+    }
+    ...
+  ]
+}
+
+```

cmd/checkout/config.go

@@ -13,14 +13,14 @@ type branchType struct {
 	D string `json:"description"`
 }
 
-type jiraBoard struct {
+type board struct {
 	Name string `json:"name"`
 	D    string `json:"description"`
 }
 
 type config struct {
 	BranchTypes []branchType `json:"branchTypes"`
-	JiraBoards  []jiraBoard  `json:"jiraBoards"`
+	boards      []board      `json:"boards"`
 }
 
 const configFile = ".git-commands.json"
@@ -34,8 +34,8 @@ var defaultBranchTypes = []list.Item{
 }
 
 var defaultJiraBoards = []list.Item{
-	jiraBoard{"EPD", "CPO team board"},
-	jiraBoard{"IB", "Interim billing board"},
+	board{"EPD", "CPO team board"},
+	board{"IB", "Interim billing board"},
 }
 
 func convertBranchTypes(branchTypes []branchType) []list.Item {
@@ -49,7 +49,7 @@ func convertBranchTypes(branchTypes []branchType) []list.Item {
 	return items
 }
 
-func convertBoards(boards []jiraBoard) []list.Item {
+func convertBoards(boards []board) []list.Item {
 	items := []list.Item{}
 	for _, board := range boards {
 		items = append(items, board)
@@ -69,7 +69,7 @@ func loadConfigFile(path string) ([]list.Item, []list.Item, error) {
 	if err := json.Unmarshal(data, &c); err != nil {
 		return nil, nil, fmt.Errorf("error parsing config file: %w", err)
 	}
-	return convertBranchTypes(c.BranchTypes), convertBoards(c.JiraBoards), nil
+	return convertBranchTypes(c.BranchTypes), convertBoards(c.boards), nil
 }
 
 func loadConfig() ([]list.Item, []list.Item, error) {

cmd/checkout/main.go

@@ -15,9 +15,9 @@ const (
 	listHeight   = 35
 )
 
-func (b jiraBoard) Title() string       { return b.Name }
-func (b jiraBoard) Description() string { return b.D }
-func (b jiraBoard) FilterValue() string { return b.Name }
+func (b board) Title() string       { return b.Name }
+func (b board) Description() string { return b.D }
+func (b board) FilterValue() string { return b.Name }
 
 func (p branchType) Title() string       { return p.T }
 func (p branchType) Description() string { return p.D }
@@ -199,8 +199,8 @@ func (m model) UpdateJiraBoardList(msg tea.Msg) (tea.Model, tea.Cmd) {
 		case tea.KeyCtrlC, tea.KeyEsc:
 			return m, tea.Quit
 		case tea.KeyEnter, tea.KeySpace:
-			m.selectedJiraBoard = m.jiraBoardList.SelectedItem().(jiraBoard).Title()
-			m.ticketIdInput.SetValue(m.jiraBoardList.SelectedItem().(jiraBoard).Title() + "-")
+			m.selectedJiraBoard = m.jiraBoardList.SelectedItem().(board).Title()
+			m.ticketIdInput.SetValue(m.jiraBoardList.SelectedItem().(board).Title() + "-")
 			m.shouldEnterTicketId = true
 		}
 	}