Skip to content

Commit c8edd76

Browse files
mascimasci
committed
use a better naming for output functions
1 parent 683e53e commit c8edd76

23 files changed

+56
-29
lines changed

‎cli/board/attach.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ func runAttachCommand(cmd *cobra.Command, args []string) {
6161
BoardUri: args[0],
6262
SketchPath: path,
6363
SearchTimeout: attachFlags.searchTimeout,
64-
}, output.OutputTaskProgress())
64+
}, output.TaskProgress())
6565
if err != nil {
6666
formatter.PrintError(err, "attach board error")
6767
os.Exit(errorcodes.ErrGeneric)

‎cli/board/details.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ func runDetailsCommand(cmd *cobra.Command, args []string) {
5050
formatter.PrintError(err, "Error getting board details")
5151
os.Exit(errorcodes.ErrGeneric)
5252
}
53-
if output.OutputJSONOrElse(res) {
53+
if output.JSONOrElse(res) {
5454
outputDetailsResp(res)
5555
}
5656
}

‎cli/board/list.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ func runListCommand(cmd *cobra.Command, args []string) {
6767
os.Exit(errorcodes.ErrNetwork)
6868
}
6969

70-
if output.OutputJSONOrElse(resp) {
70+
if output.JSONOrElse(resp) {
7171
outputListResp(resp)
7272
}
7373
}

‎cli/board/listall.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ func runListAllCommand(cmd *cobra.Command, args []string) {
5858
os.Exit(errorcodes.ErrGeneric)
5959
}
6060

61-
if output.OutputJSONOrElse(list) {
61+
if output.JSONOrElse(list) {
6262
outputBoardListAll(list)
6363
}
6464
}

‎cli/core/download.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ func runDownloadCommand(cmd *cobra.Command, args []string) {
5858
Architecture: platformRef.Architecture,
5959
Version: platformRef.Version,
6060
}
61-
_, err := core.PlatformDownload(context.Background(), platformDownloadreq, output.OutputProgressBar(),
61+
_, err := core.PlatformDownload(context.Background(), platformDownloadreq, output.ProgressBar(),
6262
globals.HTTPClientHeader)
6363
if err != nil {
6464
formatter.PrintError(err, "Error downloading "+args[i])

‎cli/core/install.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ func runInstallCommand(cmd *cobra.Command, args []string) {
6060
Architecture: platformRef.Architecture,
6161
Version: platformRef.Version,
6262
}
63-
_, err := core.PlatformInstall(context.Background(), plattformInstallReq, output.OutputProgressBar(),
64-
output.OutputTaskProgress(), globals.HTTPClientHeader)
63+
_, err := core.PlatformInstall(context.Background(), plattformInstallReq, output.ProgressBar(),
64+
output.TaskProgress(), globals.HTTPClientHeader)
6565
if err != nil {
6666
formatter.PrintError(err, "Error during install")
6767
os.Exit(errorcodes.ErrGeneric)

‎cli/core/list.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ func runListCommand(cmd *cobra.Command, args []string) {
6464
}
6565
installed := resp.GetInstalledPlatform()
6666
if installed != nil && len(installed) > 0 {
67-
if output.OutputJSONOrElse(installed) {
67+
if output.JSONOrElse(installed) {
6868
outputInstalledCores(installed)
6969
}
7070
}

‎cli/core/search.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ func runSearchCommand(cmd *cobra.Command, args []string) {
6363
}
6464

6565
coreslist := resp.GetSearchOutput()
66-
if output.OutputJSONOrElse(coreslist) {
66+
if output.JSONOrElse(coreslist) {
6767
if len(coreslist) > 0 {
6868
outputSearchCores(coreslist)
6969
} else {

‎cli/core/update_index.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ func runUpdateIndexCommand(cmd *cobra.Command, args []string) {
4949

5050
_, err := commands.UpdateIndex(context.Background(), &rpc.UpdateIndexReq{
5151
Instance: instance,
52-
}, output.OutputProgressBar())
52+
}, output.ProgressBar())
5353
if err != nil {
5454
formatter.PrintError(err, "Error updating index")
5555
os.Exit(errorcodes.ErrGeneric)

‎cli/core/upgrade.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ func runUpgradeCommand(cmd *cobra.Command, args []string) {
6363
Instance: instance,
6464
PlatformPackage: platformRef.Package,
6565
Architecture: platformRef.Architecture,
66-
}, output.OutputProgressBar(), output.OutputTaskProgress(),
66+
}, output.ProgressBar(), output.TaskProgress(),
6767
globals.HTTPClientHeader)
6868
if err != nil {
6969
formatter.PrintError(err, "Error during upgrade")

‎cli/globals/globals.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var (
2626
VersionInfo = version.NewInfo(filepath.Base(os.Args[0]))
2727
// Config FIXMEDOC
2828
Config *configs.Configuration
29-
29+
// YAMLConfigFile contains the path to the config file
3030
YAMLConfigFile string
3131
)
3232

‎cli/instance/instance.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@ func initInstance() *rpc.InitResp {
3737
logrus.Info("Initializing package manager")
3838
req := packageManagerInitReq()
3939

40-
resp, err := commands.Init(context.Background(), req, output.OutputProgressBar(), output.OutputTaskProgress(), globals.HTTPClientHeader)
40+
resp, err := commands.Init(context.Background(), req, output.ProgressBar(), output.TaskProgress(), globals.HTTPClientHeader)
4141
if err != nil {
4242
formatter.PrintError(err, "Error initializing package manager")
4343
os.Exit(errorcodes.ErrGeneric)
4444
}
4545
if resp.GetLibrariesIndexError() != "" {
4646
commands.UpdateLibrariesIndex(context.Background(),
47-
&rpc.UpdateLibrariesIndexReq{Instance: resp.GetInstance()}, output.OutputProgressBar())
47+
&rpc.UpdateLibrariesIndexReq{Instance: resp.GetInstance()}, output.ProgressBar())
4848
rescResp, err := commands.Rescan(context.Background(), &rpc.RescanReq{Instance: resp.GetInstance()})
4949
if rescResp.GetLibrariesIndexError() != "" {
5050
formatter.PrintErrorMessage("Error loading library index: " + rescResp.GetLibrariesIndexError())

‎cli/lib/download.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ func runDownloadCommand(cmd *cobra.Command, args []string) {
5959
Name: library.Name,
6060
Version: library.Version.String(),
6161
}
62-
_, err := lib.LibraryDownload(context.Background(), libraryDownloadReq, output.OutputProgressBar(),
62+
_, err := lib.LibraryDownload(context.Background(), libraryDownloadReq, output.ProgressBar(),
6363
globals.HTTPClientHeader)
6464
if err != nil {
6565
formatter.PrintError(err, "Error downloading "+library.String())

‎cli/lib/install.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ func runInstallCommand(cmd *cobra.Command, args []string) {
5959
Name: library.Name,
6060
Version: library.Version.String(),
6161
}
62-
err := lib.LibraryInstall(context.Background(), libraryInstallReq, output.OutputProgressBar(),
63-
output.OutputTaskProgress(), globals.HTTPClientHeader)
62+
err := lib.LibraryInstall(context.Background(), libraryInstallReq, output.ProgressBar(),
63+
output.TaskProgress(), globals.HTTPClientHeader)
6464
if err != nil {
6565
formatter.PrintError(err, "Error installing "+library.String())
6666
os.Exit(errorcodes.ErrGeneric)

‎cli/lib/list.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ func runListCommand(cmd *cobra.Command, args []string) {
6767
}
6868
if len(res.GetInstalledLibrary()) > 0 {
6969
results := res.GetInstalledLibrary()
70-
if output.OutputJSONOrElse(results) {
70+
if output.JSONOrElse(results) {
7171
if len(results) > 0 {
7272
fmt.Println(outputListLibrary(results))
7373
} else {

‎cli/lib/search.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ func runSearchCommand(cmd *cobra.Command, args []string) {
6464
os.Exit(errorcodes.ErrGeneric)
6565
}
6666

67-
if output.OutputJSONOrElse(searchResp) {
67+
if output.JSONOrElse(searchResp) {
6868
results := searchResp.GetLibraries()
6969
sort.Slice(results, func(i, j int) bool {
7070
return results[i].Name < results[j].Name

‎cli/lib/uninstall.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ func runUninstallCommand(cmd *cobra.Command, args []string) {
5959
Instance: instance,
6060
Name: library.Name,
6161
Version: library.Version.String(),
62-
}, output.OutputTaskProgress())
62+
}, output.TaskProgress())
6363
if err != nil {
6464
formatter.PrintError(err, "Error uninstalling "+library.String())
6565
os.Exit(errorcodes.ErrGeneric)

‎cli/lib/update_index.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ func initUpdateIndexCommand() *cobra.Command {
4141
instance := instance.CreateInstaceIgnorePlatformIndexErrors()
4242
err := commands.UpdateLibrariesIndex(context.Background(), &rpc.UpdateLibrariesIndexReq{
4343
Instance: instance,
44-
}, output.OutputProgressBar())
44+
}, output.ProgressBar())
4545
if err != nil {
4646
formatter.PrintError(err, "Error updating library index")
4747
os.Exit(errorcodes.ErrGeneric)

‎cli/lib/upgrade.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ func runUpgradeCommand(cmd *cobra.Command, args []string) {
5050

5151
err := lib.LibraryUpgradeAll(context.Background(), &rpc.LibraryUpgradeAllReq{
5252
Instance: instance,
53-
}, output.OutputProgressBar(), output.OutputTaskProgress(), globals.HTTPClientHeader)
53+
}, output.ProgressBar(), output.TaskProgress(), globals.HTTPClientHeader)
5454
if err != nil {
5555
formatter.PrintError(err, "Error upgrading libraries")
5656
os.Exit(errorcodes.ErrGeneric)

‎cli/output/output.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ import (
3333
// TODO: Feed text output into colorable stdOut
3434
var _ = colorable.NewColorableStdout()
3535

36-
// OutputJSONOrElse outputs the JSON encoding of v if the JSON output format has been
36+
// JSONOrElse outputs the JSON encoding of v if the JSON output format has been
3737
// selected by the user and returns false. Otherwise no output is produced and the
3838
// function returns true.
39-
func OutputJSONOrElse(v interface{}) bool {
39+
func JSONOrElse(v interface{}) bool {
4040
if !globals.OutputJSON {
4141
return true
4242
}
@@ -49,9 +49,9 @@ func OutputJSONOrElse(v interface{}) bool {
4949
return false
5050
}
5151

52-
// OutputProgressBar returns a DownloadProgressCB that prints a progress bar.
52+
// ProgressBar returns a DownloadProgressCB that prints a progress bar.
5353
// If JSON output format has been selected, the callback outputs nothing.
54-
func OutputProgressBar() commands.DownloadProgressCB {
54+
func ProgressBar() commands.DownloadProgressCB {
5555
if !globals.OutputJSON {
5656
return NewDownloadProgressBarCB()
5757
}
@@ -60,9 +60,9 @@ func OutputProgressBar() commands.DownloadProgressCB {
6060
}
6161
}
6262

63-
// OutputTaskProgress returns a TaskProgressCB that prints the task progress.
63+
// TaskProgress returns a TaskProgressCB that prints the task progress.
6464
// If JSON output format has been selected, the callback outputs nothing.
65-
func OutputTaskProgress() commands.TaskProgressCB {
65+
func TaskProgress() commands.TaskProgressCB {
6666
if !globals.OutputJSON {
6767
return NewTaskProgressCB()
6868
}

‎cli/version/version.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ func NewCommand() *cobra.Command {
3939
}
4040

4141
func run(cmd *cobra.Command, args []string) {
42-
if output.OutputJSONOrElse(globals.VersionInfo) {
42+
if output.JSONOrElse(globals.VersionInfo) {
4343
fmt.Printf("%s\n", globals.VersionInfo)
4444
}
4545
}

‎go.mod

+10
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,19 @@ require (
4141
go.bug.st/downloader v1.1.0
4242
go.bug.st/relaxed-semver v0.0.0-20181022103824-0265409c5852
4343
go.bug.st/serial.v1 v0.0.0-20180827123349-5f7892a7bb45
44+
<<<<<<< HEAD
4445
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2
4546
golang.org/x/net v0.0.0-20190311183353-d8887717615a
4647
golang.org/x/text v0.3.0
48+
=======
49+
golang.org/x/crypto v0.0.0-20190701094942-4def268fd1a4
50+
golang.org/x/lint v0.0.0-20190409202823-959b441ac422 // indirect
51+
golang.org/x/net v0.0.0-20190628185345-da137c7871d7
52+
golang.org/x/sys v0.0.0-20190710143415-6ec70d6a5542 // indirect
53+
golang.org/x/text v0.3.2
54+
golang.org/x/tools v0.0.0-20190710184609-286818132824 // indirect
55+
google.golang.org/appengine v1.4.0 // indirect
56+
>>>>>>> use a better naming for output functions
4757
google.golang.org/genproto v0.0.0-20190327125643-d831d65fe17d // indirect
4858
google.golang.org/grpc v1.21.1
4959
gopkg.in/mgo.v2 v2.0.0-20180705113604-9856a29383ce // indirect

‎go.sum

+17
Original file line numberDiff line numberDiff line change
@@ -125,31 +125,48 @@ go.bug.st/serial.v1 v0.0.0-20180827123349-5f7892a7bb45/go.mod h1:dRSl/CVCTf56CkX
125125
golang.org/x/crypto v0.0.0-20181203042331-505ab145d0a9/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
126126
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2 h1:VklqNMn3ovrHsnt90PveolxSbWFaJdECFbxSq0Mqo2M=
127127
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
128+
golang.org/x/crypto v0.0.0-20190701094942-4def268fd1a4 h1:HuIa8hRrWRSrqYzx1qI49NNxhdi2PrY7gxVSq1JjLDc=
129+
golang.org/x/crypto v0.0.0-20190701094942-4def268fd1a4/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
128130
golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
129131
golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE=
130132
golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU=
131133
golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
134+
golang.org/x/lint v0.0.0-20190409202823-959b441ac422 h1:QzoH/1pFpZguR8NrRHLcO6jKqfv2zpuSqZLgdm7ZmjI=
135+
golang.org/x/lint v0.0.0-20190409202823-959b441ac422/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
132136
golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
133137
golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
134138
golang.org/x/net v0.0.0-20190213061140-3a22650c66bd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
135139
golang.org/x/net v0.0.0-20190311183353-d8887717615a h1:oWX7TPOiFAMXLq8o0ikBYfCJVlRHBcsciT5bXOrH628=
136140
golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
141+
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
142+
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
143+
golang.org/x/net v0.0.0-20190628185345-da137c7871d7 h1:rTIdg5QFRR7XCaK4LCjBiPbx8j4DQRpdYMnGn/bJUEU=
144+
golang.org/x/net v0.0.0-20190628185345-da137c7871d7/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
137145
golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
138146
golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
139147
golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
140148
golang.org/x/sync v0.0.0-20190227155943-e225da77a7e6/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
149+
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
141150
golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
142151
golang.org/x/sys v0.0.0-20181205085412-a5c9d58dba9a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
143152
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
144153
golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
154+
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
145155
golang.org/x/sys v0.0.0-20190422165155-953cdadca894 h1:Cz4ceDQGXuKRnVBDTS23GTn/pU5OE2C0WrNTOYK1Uuc=
146156
golang.org/x/sys v0.0.0-20190422165155-953cdadca894/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
157+
golang.org/x/sys v0.0.0-20190710143415-6ec70d6a5542 h1:6ZQFf1D2YYDDI7eSwW8adlkkavTB9sw5I24FVtEvNUQ=
158+
golang.org/x/sys v0.0.0-20190710143415-6ec70d6a5542/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
147159
golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
148160
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
161+
golang.org/x/text v0.3.2 h1:tW2bmiBqwgJj/UpqtC8EpXEZVYOwU0yG4iWbprSVAcs=
162+
golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
163+
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
149164
golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
150165
golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY=
151166
golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
152167
golang.org/x/tools v0.0.0-20190328211700-ab21143f2384/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
168+
golang.org/x/tools v0.0.0-20190710184609-286818132824 h1:dOGf5KG5e5tnConXcTAnHv2YgmYJtrYjN9b1cMC21TY=
169+
golang.org/x/tools v0.0.0-20190710184609-286818132824/go.mod h1:jcCCGcm9btYwXyDqrUWc6MKQKKGJCWEQ3AfLSRIbEuI=
153170
google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM=
154171
google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4=
155172
google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc=

0 commit comments

Comments
 (0)