golangci-lint

cache/cache.go

@@ -29,6 +29,8 @@ import (
 
 var defaultCachePath = "/tmp/bk-bscp"
 var instance *Cache
+
+// Enable define whether to enable local cache
 var Enable bool
 
 // Cache is the bscp sdk cache

cli/cmd/common.go

@@ -18,9 +18,10 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/spf13/viper"
+
 	"github.com/TencentBlueKing/bscp-go/cli/config"
 	"github.com/TencentBlueKing/bscp-go/cli/constant"
-	"github.com/spf13/viper"
 )
 
 var (

cli/cmd/pull.go

@@ -32,6 +32,7 @@ import (
 )
 
 var (
+	// PullCmd command to pull app files
 	PullCmd = &cobra.Command{
 		Use:   "pull",
 		Short: "pull",

cli/cmd/version.go

@@ -19,6 +19,7 @@ import (
 )
 
 var (
+	// VersionCmd command to show version info
 	VersionCmd = &cobra.Command{
 		Use:   "version",
 		Short: "show version of the bscp-go cli.",

cli/cmd/watch.go

@@ -38,6 +38,7 @@ import (
 )
 
 var (
+	// WatchCmd command to watch app files
 	WatchCmd = &cobra.Command{
 		Use:   "watch",
 		Short: "watch",

cli/constant/constant.go

@@ -14,7 +14,7 @@
 package constant
 
 const (
-	// !important: promise of compatibility
 	// DefaultTempDir is the bscp cli default temp dir.
+	// !important: promise of compatibility
 	DefaultTempDir = "/data/bscp"
 )

cli/main.go

@@ -15,6 +15,7 @@ package main
 
 import (
 	"bscp.io/pkg/logs"
+
 	"github.com/TencentBlueKing/bscp-go/cli/cmd"
 )
 

cli/util/hook.go

@@ -30,12 +30,12 @@ const (
 	// executePythonCmd python script executor
 	executePythonCmd = "python3"
 
-	// !important: promise of compatibility
 	// EnvAppTempDir bscp app temp dir env
+	// !important: promise of compatibility
 	EnvAppTempDir = "bk_bscp_app_temp_dir"
 	// EnvTempDir bscp temp dir env
 	EnvTempDir = "bk_bscp_temp_dir"
-	// EnvApp bscp biz id env
+	// EnvBiz bscp biz id env
 	EnvBiz = "bk_bscp_biz"
 	// EnvApp bscp app name env
 	EnvApp = "bk_bscp_app"

cli/util/hook_test.go

@@ -21,6 +21,7 @@ import (
 
 	"bscp.io/pkg/dal/table"
 	pbhook "bscp.io/pkg/protocol/core/hook"
+
 	"github.com/TencentBlueKing/bscp-go/cli/util"
 )
 

downloader/downloader.go

@@ -46,13 +46,16 @@ const (
 	defaultDownloadSemaphoreWight      = 10
 )
 
+// DownloadTo defines the download target.
 type DownloadTo string
 
 var (
 	instance *downloader
 
+	// DownloadToBytes download file content to bytes.
 	DownloadToBytes DownloadTo = "bytes"
-	DownloadToFile  DownloadTo = "file"
+	// DownloadToFile download file content to file.
+	DownloadToFile DownloadTo = "file"
 )
 
 // Downloader implements all the supported operations which used to download

option/watch.go

@@ -15,6 +15,7 @@ package option
 
 import (
 	pbhook "bscp.io/pkg/protocol/core/hook"
+
 	"github.com/TencentBlueKing/bscp-go/types"
 )
 
@@ -32,6 +33,5 @@ type WatchOptions struct {
 	BizID uint32
 }
 
-// TODO: how to wrapper file, kv, table types in one watch result
 // Callback watch callback
 type Callback func(releaseID uint32, files []*types.ConfigItemFile, pre *pbhook.HookSpec, post *pbhook.HookSpec) error

types/types.go

@@ -36,8 +36,6 @@ func (rs ReconnectSignal) String() string {
 	return rs.Reason
 }
 
-type OnAppReleaseChange func(event *sfs.ReleaseChangeEvent)
-
 // ConfigItemFile defines config item file
 type ConfigItemFile struct {
 	// Config file name

watch/heartbeat.go

@@ -21,6 +21,7 @@ import (
 	"bscp.io/pkg/logs"
 	sfs "bscp.io/pkg/sf-share"
 	"bscp.io/pkg/tools"
+
 	"github.com/TencentBlueKing/bscp-go/types"
 )
 

watch/reconnect.go

@@ -19,6 +19,7 @@ import (
 	"bscp.io/pkg/criteria/uuid"
 	"bscp.io/pkg/logs"
 	"bscp.io/pkg/tools"
+
 	"github.com/TencentBlueKing/bscp-go/types"
 )
 

watch/watch.go

@@ -26,12 +26,13 @@ import (
 	pbfs "bscp.io/pkg/protocol/feed-server"
 	"bscp.io/pkg/runtime/jsoni"
 	sfs "bscp.io/pkg/sf-share"
+	"go.uber.org/atomic"
+	"google.golang.org/grpc"
+
 	"github.com/TencentBlueKing/bscp-go/cache"
 	"github.com/TencentBlueKing/bscp-go/option"
 	"github.com/TencentBlueKing/bscp-go/types"
 	"github.com/TencentBlueKing/bscp-go/upstream"
-	"go.uber.org/atomic"
-	"google.golang.org/grpc"
 )
 
 // Watcher is the main watch stream for instance