chore: fix linter issues #66

cmd/bbsctl/main.go

@@ -1,3 +1,4 @@
+// Binary bbsctl is a command line interface to manage BigBlueSwarm load balancer
 package main
 
 import (

internal/mock/admin_mock.go → internal/mock/admin.mock.go

@@ -1,3 +1,4 @@
+// Package mock provide an internal mock to test
 package mock
 
 import (
@@ -64,7 +65,7 @@ func (a *AdminMock) BBSAPIStatus() (string, error) {
 	return BBSAPIStatusAdminFunc()
 }
 
-// GetConfigurations is a mock implementation returning the configuration
+// GetConfiguration is a mock implementation returning the configuration
 func (a *AdminMock) GetConfiguration() (*bbsconfig.Config, error) {
 	return GetConfigurationFunc()
 }

internal/test/cmd.go

@@ -1,3 +1,4 @@
+// Package test provides utilities to test cli commands
 package test
 
 import (

pkg/admin/admin.go

@@ -1,3 +1,4 @@
+// Package admin provides some api to manage data to and from bigblueswarm
 package admin
 
 import (

pkg/cmd/apply/apply.go

@@ -1,3 +1,4 @@
+// Package apply provides apply command
 package apply
 
 import (

pkg/cmd/apply/definitions.go

@@ -1,3 +1,4 @@
+// Package apply provides apply command
 package apply
 
 // Resource is a resource object

pkg/cmd/apply/flags.go

@@ -1,3 +1,4 @@
+// Package apply provides apply command
 package apply
 
 // Flags contains all apply flags
@@ -8,4 +9,4 @@ type Flags struct {
 // NewFlags initialize a new Flags struct
 func NewFlags() *Flags {
 	return &Flags{}
-}
+}

pkg/cmd/apply/manager.go

@@ -1,3 +1,4 @@
+// Package apply provides apply command
 package apply
 
 import (

pkg/cmd/clusterinfo/clusterinfo.go

@@ -1,3 +1,4 @@
+// Package clusterinfo provides the cluster-info command
 package clusterinfo
 
 import (

pkg/cmd/delete/delete.go

@@ -1,3 +1,4 @@
+// Package delete provides the delete command
 package delete
 
 import "github.com/spf13/cobra"

pkg/cmd/delete/flags.go

@@ -1,3 +1,4 @@
+// Package delete provides the delete command
 package delete
 
 // Flags contains all delete command flags
@@ -9,7 +10,7 @@ func NewFlags() *Flags {
 }
 
 // TenantFlags contains all delete tenant command flags
-type TenantFlags struct{
+type TenantFlags struct {
 	Hostname string
 }
 

pkg/cmd/delete/tenant.go

@@ -1,3 +1,4 @@
+// Package delete provides the delete command
 package delete
 
 import (

pkg/cmd/describe/config.go

@@ -1,3 +1,4 @@
+// Package describe provides the describe command
 package describe
 
 import (

pkg/cmd/describe/describe.go

@@ -1,3 +1,4 @@
+// Package describe provides the describe command
 package describe
 
 import "github.com/spf13/cobra"

pkg/cmd/describe/flags.go

@@ -1,3 +1,4 @@
+// Package describe provides the describe command
 package describe
 
 // Flags contains all config command flags

pkg/cmd/describe/tenant.go

@@ -1,3 +1,4 @@
+// Package describe provides the describe command
 package describe
 
 import (

pkg/cmd/get/flags.go

@@ -1,3 +1,4 @@
+// Package get provides the get command
 package get
 
 // Flags contains all Get command flags
@@ -6,7 +7,7 @@ type Flags struct {
 	JSON bool
 }
 
-// NewGetFlags initialize a new InstancesFlags object
+// NewFlags initialize a new Flags object
 func NewFlags() *Flags {
 	return &Flags{
 		CSV:  false,

pkg/cmd/get/get.go

@@ -1,3 +1,4 @@
+// Package get provides the get command
 package get
 
 import (

pkg/cmd/get/instances.go

@@ -1,3 +1,4 @@
+// Package get provides the get command
 package get
 
 import (

pkg/cmd/get/tenants.go

@@ -1,3 +1,4 @@
+// Package get provides the get command
 package get
 
 import (
@@ -11,6 +12,7 @@ import (
 	"github.com/spf13/cobra"
 )
 
+// TenantsCmd struct represents the get tenants command object
 type TenantsCmd struct {
 	Command *cobra.Command
 	Flags   *Flags

pkg/cmd/init/config.go

@@ -1,3 +1,4 @@
+// Package init provides the init command
 package init
 
 import (

pkg/cmd/init/flags.go

@@ -1,3 +1,4 @@
+// Package init provides the init command
 package init
 
 // ConfigFlags represents `bbsctl init config` flags

pkg/cmd/init/helper.go

@@ -1,3 +1,4 @@
+// Package init provides the init command
 package init
 
 import (

pkg/cmd/init/init.go

@@ -1,9 +1,11 @@
+// Package init provides the init command
 package init
 
 import (
 	"github.com/spf13/cobra"
 )
 
+// NewCmd initialize a new init cobra command
 func NewCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "init <command> [flags]",

pkg/cmd/init/instances.go

@@ -1,3 +1,4 @@
+// Package init provides the init command
 package init
 
 import (

pkg/cmd/init/prerun.go

@@ -1,3 +1,4 @@
+// Package init provides the init command
 package init
 
 import (

pkg/cmd/init/tenant.go

@@ -1,3 +1,4 @@
+// Package init provides the init command
 package init
 
 import (

pkg/cmd/root/flags.go

@@ -1,3 +1,4 @@
+// Package root provide the root bbsctl command
 package root
 
 import (

pkg/cmd/root/root.go

@@ -1,3 +1,4 @@
+// Package root provide the root bbsctl command
 package root
 
 import (

pkg/config/config.go

@@ -1,3 +1,4 @@
+// Package config manages the configuration
 package config
 
 import (

pkg/config/definitions.go

@@ -1,3 +1,4 @@
+// Package config manages the configuration
 package config
 
 // Config represents the config file struct

pkg/render/render.go

@@ -1,3 +1,4 @@
+// Package render provides some renderer to display data
 package render
 
 import (

pkg/system/exit_code.go

@@ -1,3 +1,4 @@
+// Package system provides some system utilities
 package system
 
 // OperationNotPermittedExitCode is the GNU/Linux common exit code for operation not permitted