chore: update readme and update some method comments

gookit · Jul 27, 2022 · 517b05e · 517b05e
1 parent 0231311
commit 517b05e
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -3,8 +3,7 @@
 ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/gookit/gcli?style=flat-square)
 [![Actions Status](https://github.com/gookit/gcli/workflows/action-tests/badge.svg)](https://github.com/gookit/gcli/actions)
 [![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/gookit/gcli)](https://github.com/gookit/gcli)
-[![Build Status](https://travis-ci.org/gookit/gcli.svg?branch=master)](https://travis-ci.org/gookit/gcli)
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/60c587f0491748fcabc1b3fe08d98074)](https://app.codacy.com/app/inhere/gcli?utm_source=github.com&utm_medium=referral&utm_content=gookit/gcli&utm_campaign=Badge_Grade_Dashboard)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/4f071e6858fb4117b6c1376c9316d8ef)](https://www.codacy.com/gh/gookit/gcli/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=gookit/gcli&amp;utm_campaign=Badge_Grade)
 [![GoDoc](https://godoc.org/github.com/gookit/gcli?status.svg)](https://pkg.go.dev/github.com/gookit/gcli/v3)
 [![Go Report Card](https://goreportcard.com/badge/github.com/gookit/gcli)](https://goreportcard.com/report/github.com/gookit/gcli)
 [![Coverage Status](https://coveralls.io/repos/github/gookit/gcli/badge.svg?branch=master)](https://coveralls.io/github/gookit/gcli?branch=master)

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -3,8 +3,7 @@
 ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/gookit/gcli?style=flat-square)
 [![Actions Status](https://github.com/gookit/gcli/workflows/action-tests/badge.svg)](https://github.com/gookit/gcli/actions)
 [![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/gookit/gcli)](https://github.com/gookit/gcli)
-[![Build Status](https://travis-ci.org/gookit/gcli.svg?branch=master)](https://travis-ci.org/gookit/gcli)
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/60c587f0491748fcabc1b3fe08d98074)](https://app.codacy.com/app/inhere/gcli?utm_source=github.com&utm_medium=referral&utm_content=gookit/gcli&utm_campaign=Badge_Grade_Dashboard)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/4f071e6858fb4117b6c1376c9316d8ef)](https://www.codacy.com/gh/gookit/gcli/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=gookit/gcli&amp;utm_campaign=Badge_Grade)
 [![GoDoc](https://godoc.org/github.com/gookit/gcli?status.svg)](https://pkg.go.dev/github.com/gookit/gcli/v3)
 [![Go Report Card](https://goreportcard.com/badge/github.com/gookit/gcli)](https://goreportcard.com/report/github.com/gookit/gcli)
 [![Coverage Status](https://coveralls.io/repos/github/gookit/gcli/badge.svg?branch=master)](https://coveralls.io/github/gookit/gcli?branch=master)

diff --git a/interact/README.md b/interact/README.md
@@ -67,3 +67,7 @@ Preview:
 
 ![](images/select.png)
 
+## Refers
+
+- https://github.com/manifoldco/promptui
+- https://github.com/chzyer/readline
diff --git a/interact/base.go b/interact/base.go
@@ -83,8 +83,9 @@ func (v Value) IsEmpty() bool {
 
 // SelectResult data store
 type SelectResult struct {
-	Value       // V the select value(s)
-	K     Value // K the select key(s)
+	Value // V the select value(s)
+	// K the select key(s)
+	K Value
 }
 
 // create SelectResult create

diff --git a/interact/interact.go b/interact/interact.go
@@ -31,6 +31,7 @@ func Unconfirmed(message string, defVal ...bool) bool {
 }
 
 // Ask a question and return the result of the input.
+//
 // Usage:
 // 	answer := Ask("Your name?", "", nil)
 // 	answer := Ask("Your name?", "tom", nil)
@@ -60,12 +61,14 @@ func SingleSelect(title string, options interface{}, defOpt string, allowQuit ..
 }
 
 // SelectOne select one of the options, returns selected option value
+//
 // map options:
 // 	{
 //    // option value => option name
 //    'a' => 'chengdu',
 //    'b' => 'beijing'
 // 	}
+//
 // array options:
 // 	{
 //    // only name, value will use index

diff --git a/interact/select.go b/interact/select.go
@@ -7,6 +7,7 @@ import (
 	"strings"
 
 	"github.com/gookit/color"
+	"github.com/gookit/goutil/arrutil"
 	"github.com/gookit/goutil/strutil"
 )
 
@@ -33,6 +34,7 @@ type Select struct {
 }
 
 // NewSelect instance.
+//
 // Usage:
 // 	s := NewSelect("Your city?", []string{"chengdu", "beijing"})
 // 	r := s.Run()
@@ -99,14 +101,7 @@ func (s *Select) prepare() (keys []string) {
 	// format some field data
 	s.DefOpt = strings.TrimSpace(s.DefOpt)
 	if len(s.DefOpts) > 0 {
-		var ss []string
-		for _, v := range s.DefOpts {
-			if v = strings.TrimSpace(v); v != "" {
-				ss = append(ss, v)
-			}
-		}
-
-		s.DefOpts = ss
+		s.DefOpts = arrutil.StringsFilter(s.DefOpts)
 	}
 	return
 }
@@ -251,6 +246,5 @@ func (s *Select) Run() *SelectResult {
 	if s.MultiSelect {
 		return s.selectMulti()
 	}
-
 	return s.selectOne()
 }