all: fix linter errors

egonelbre · egonelbre · commit 5dff542174b8 · 2020-07-09T14:22:17.000+03:00
Change-Id: I0e4f29eae3c4490dc733e5d04a35e9ad61144077
diff --git a/cfgstruct/bind.go b/cfgstruct/bind.go
@@ -40,7 +40,7 @@ var (
 	}
 )
 
-// BindOpt is an option for the Bind method
+// BindOpt is an option for the Bind method.
 type BindOpt struct {
 	isDev   *bool
 	isSetup *bool
@@ -73,7 +73,7 @@ func SetupMode() BindOpt {
 // UseDevDefaults forces the bind call to use development defaults unless
 // UseReleaseDefaults is provided as a subsequent option.
 // Without either, Bind will default to determining which defaults to use
-// based on version.Build.Release
+// based on version.Build.Release.
 func UseDevDefaults() BindOpt {
 	dev := true
 	return BindOpt{isDev: &dev}
@@ -82,7 +82,7 @@ func UseDevDefaults() BindOpt {
 // UseReleaseDefaults forces the bind call to use release defaults unless
 // UseDevDefaults is provided as a subsequent option.
 // Without either, Bind will default to determining which defaults to use
-// based on version.Build.Release
+// based on version.Build.Release.
 func UseReleaseDefaults() BindOpt {
 	dev := false
 	return BindOpt{isDev: &dev}
@@ -367,22 +367,22 @@ func expand(vars map[string]string, val string) string {
 	return os.Expand(val, func(key string) string { return vars[key] })
 }
 
-// FindConfigDirParam returns '--config-dir' param from os.Args (if exists)
+// FindConfigDirParam returns '--config-dir' param from os.Args (if exists).
 func FindConfigDirParam() string {
 	return FindFlagEarly("config-dir")
 }
 
-// FindIdentityDirParam returns '--identity-dir' param from os.Args (if exists)
+// FindIdentityDirParam returns '--identity-dir' param from os.Args (if exists).
 func FindIdentityDirParam() string {
 	return FindFlagEarly("identity-dir")
 }
 
-// FindDefaultsParam returns '--defaults' param from os.Args (if it exists)
+// FindDefaultsParam returns '--defaults' param from os.Args (if it exists).
 func FindDefaultsParam() string {
 	return FindFlagEarly("defaults")
 }
 
-// FindFlagEarly retrieves the value of a flag before `flag.Parse` has been called
+// FindFlagEarly retrieves the value of a flag before `flag.Parse` has been called.
 func FindFlagEarly(flagName string) string {
 	// workaround to have early access to 'dir' param
 	for i, arg := range os.Args {
@@ -395,7 +395,7 @@ func FindFlagEarly(flagName string) string {
 	return ""
 }
 
-// SetupFlag sets up flags that are needed before `flag.Parse` has been called
+// SetupFlag sets up flags that are needed before `flag.Parse` has been called.
 func SetupFlag(log *zap.Logger, cmd *cobra.Command, dest *string, name, value, usage string) {
 	if foundValue := FindFlagEarly(name); foundValue != "" {
 		value = foundValue
@@ -406,7 +406,7 @@ func SetupFlag(log *zap.Logger, cmd *cobra.Command, dest *string, name, value, u
 	}
 }
 
-// DefaultsType returns the type of defaults (release/dev) this binary should use
+// DefaultsType returns the type of defaults (release/dev) this binary should use.
 func DefaultsType() string {
 	// define a flag so that the flag parsing system will be happy.
 	defaults := strings.ToLower(FindDefaultsParam())
@@ -420,7 +420,7 @@ func DefaultsType() string {
 }
 
 // DefaultsFlag sets up the defaults=dev/release flag options, which is needed
-// before `flag.Parse` has been called
+// before `flag.Parse` has been called.
 func DefaultsFlag(cmd *cobra.Command) BindOpt {
 	// define a flag so that the flag parsing system will be happy.
 	defaults := DefaultsType()
diff --git a/cfgstruct/flags.go b/cfgstruct/flags.go
@@ -9,7 +9,7 @@ import (
 	"github.com/spf13/pflag"
 )
 
-// FlagSet is an interface that matches *pflag.FlagSet
+// FlagSet is an interface that matches *pflag.FlagSet.
 type FlagSet interface {
 	BoolVar(p *bool, name string, value bool, usage string)
 	IntVar(p *int, name string, value int, usage string)
diff --git a/debug/panel.go b/debug/panel.go
@@ -148,7 +148,7 @@ var buttonsTemplate = template.Must(template.New("").Parse(`<!DOCTYPE html>
 </body>
 </html>`))
 
-// slugify converts text to a slug
+// slugify converts text to a slug.
 func slugify(s string) string {
 	return strings.Map(func(r rune) rune {
 		switch {
@@ -164,7 +164,7 @@ func slugify(s string) string {
 	}, s)
 }
 
-// Cycle returns button group for a cycle
+// Cycle returns button group for a cycle.
 func Cycle(name string, cycle *sync2.Cycle) *ButtonGroup {
 	return &ButtonGroup{
 		Name: name,
diff --git a/go.mod b/go.mod
@@ -25,5 +25,6 @@ require (
 	google.golang.org/grpc v1.27.1
 	gopkg.in/yaml.v2 v2.2.4
 	storj.io/common v0.0.0-20200424175742-65ac59022f4f
+	storj.io/drpc v0.0.11
 	storj.io/monkit-jaeger v0.0.0-20200518165323-80778fc3f91b
 )
diff --git a/process/exec.go b/process/exec.go
@@ -26,7 +26,7 @@ func init() {
 	}
 }
 
-// check if file exists, handle error correctly if it doesn't
+// fileExists checks whether file exists, handle error correctly if it doesn't.
 func fileExists(path string) bool {
 	_, err := os.Stat(path)
 	if err != nil {
diff --git a/process/exec_conf.go b/process/exec_conf.go
@@ -92,7 +92,7 @@ func ExecWithCustomConfig(cmd *cobra.Command, debugEnabled bool, loadConfig func
 	}
 }
 
-// Ctx returns the appropriate context.Context for ExecuteWithConfig commands
+// Ctx returns the appropriate context.Context for ExecuteWithConfig commands.
 func Ctx(cmd *cobra.Command) (context.Context, context.CancelFunc) {
 	commandMtx.Lock()
 	defer commandMtx.Unlock()
@@ -122,7 +122,7 @@ func Ctx(cmd *cobra.Command) (context.Context, context.CancelFunc) {
 	return ctx, cancel
 }
 
-// AtomicLevel returns the appropriate zap.AtomicLevel for ExecuteWithConfig commands
+// AtomicLevel returns the appropriate zap.AtomicLevel for ExecuteWithConfig commands.
 func AtomicLevel(cmd *cobra.Command) *zap.AtomicLevel {
 	commandMtx.Lock()
 	defer commandMtx.Unlock()
diff --git a/process/logging.go b/process/logging.go
@@ -57,7 +57,7 @@ func NewLoggerWithOutputPaths(outputPaths ...string) (*zap.Logger, error) {
 }
 
 // NewLoggerWithOutputPathsAndAtomicLevel is the same as NewLoggerWithOutputPaths, but overrides the log output paths
-// and returns the AtomicLevel
+// and returns the AtomicLevel.
 func NewLoggerWithOutputPathsAndAtomicLevel(outputPaths ...string) (*zap.Logger, *zap.AtomicLevel, error) {
 	levelEncoder := zapcore.CapitalLevelEncoder
 	timeKey := "T"
diff --git a/traces/traces.go b/traces/traces.go
@@ -16,12 +16,12 @@ import (
 )
 
 var (
-	// TagDB tags a trace as hitting the database
+	// TagDB tags a trace as hitting the database.
 	TagDB = tracetagger.NewTagRef()
 )
 
-// CollectTraces starts storing all known tagged traces on disk, until cancel
-// is called
+// CollectTraces starts storing all known tagged traces on disk,
+// until cancel is called.
 func CollectTraces() (cancel func()) {
 	path := filepath.Join(os.TempDir(), "storj-traces", fmt.Sprint(os.Getpid()))
 	disable := TagDB.Enable()
@@ -43,12 +43,12 @@ func CollectTraces() (cancel func()) {
 	}
 }
 
-// Tag tags a trace with the given tag
+// Tag tags a trace with the given tag.
 func Tag(ctx context.Context, tag *tracetagger.TagRef) {
 	tracetagger.Tag(ctx, tag)
 }
 
-// TagScope tags all functions on an entire monkit Scope with a given tag
+// TagScope tags all functions on an entire monkit Scope with a given tag.
 func TagScope(tag *tracetagger.TagRef, scope *monkit.Scope) {
 	tracetagger.TagScope(tag, scope)
 }
diff --git a/version/stats.go b/version/stats.go
@@ -10,7 +10,7 @@ import (
 	"github.com/spacemonkeygo/monkit/v3"
 )
 
-// Stats implements the monkit.StatSource interface
+// Stats implements the monkit.StatSource interface.
 func (info *Info) Stats(cb func(key monkit.SeriesKey, field string, val float64)) {
 	key := monkit.NewSeriesKey("version_info")
 
diff --git a/version/version.go b/version/version.go
@@ -30,17 +30,17 @@ var (
 	VerError = errs.Class("version error")
 
 	// the following fields are set by linker flags. if any of them
-	// are set and fail to parse, the program will fail to start
+	// are set and fail to parse, the program will fail to start.
 	buildTimestamp  string // unix seconds since epoch
 	buildCommitHash string
 	buildVersion    string // semantic version format
 	buildRelease    string // true/false
 
-	// Build is a struct containing all relevant build information associated with the binary
+	// Build is a struct containing all relevant build information associated with the binary.
 	Build Info
 )
 
-// Info is the versioning information for a binary
+// Info is the versioning information for a binary.
 type Info struct {
 	// sync/atomic cache
 	commitHashCRC uint32
@@ -52,7 +52,7 @@ type Info struct {
 }
 
 // SemVer represents a semantic version.
-// TODO: replace with semver.Version
+// TODO: replace with semver.Version.
 type SemVer struct {
 	semver.Version
 }
@@ -165,7 +165,7 @@ func (sem *SemVer) Compare(version SemVer) int {
 	return sem.Version.Compare(version.Version)
 }
 
-// String converts the SemVer struct to a more easy to handle string
+// String converts the SemVer struct to a more easy to handle string.
 func (sem *SemVer) String() (version string) {
 	return fmt.Sprintf("v%d.%d.%d", sem.Major, sem.Minor, sem.Patch)
 }
@@ -184,7 +184,7 @@ func (ver *Version) SemVer() (SemVer, error) {
 	return NewSemVer(ver.Version)
 }
 
-// New creates Version_Info from a json byte array
+// New creates Version_Info from a json byte array.
 func New(data []byte) (v Info, err error) {
 	err = json.Unmarshal(data, &v)
 	return v, VerError.Wrap(err)
@@ -195,7 +195,7 @@ func (info Info) IsZero() bool {
 	return reflect.ValueOf(info).IsZero()
 }
 
-// Marshal converts the existing Version Info to any json byte array
+// Marshal converts the existing Version Info to any json byte array.
 func (info Info) Marshal() ([]byte, error) {
 	data, err := json.Marshal(info)
 	if err != nil {

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import (`
`9`	`9`	`"github.com/spf13/pflag"`
`10`	`10`	`)`
`11`	`11`
`12`		`-// FlagSet is an interface that matches *pflag.FlagSet`
	`12`	`+// FlagSet is an interface that matches *pflag.FlagSet.`
`13`	`13`	`type FlagSet interface {`
`14`	`14`	`BoolVar(p *bool, name string, value bool, usage string)`
`15`	`15`	`IntVar(p *int, name string, value int, usage string)`
Original file line number	Diff line number	Diff line change
`@@ -25,5 +25,6 @@ require (`
`25`	`25`	`google.golang.org/grpc v1.27.1`
`26`	`26`	`gopkg.in/yaml.v2 v2.2.4`
`27`	`27`	`storj.io/common v0.0.0-20200424175742-65ac59022f4f`
	`28`	`+ storj.io/drpc v0.0.11`
`28`	`29`	`storj.io/monkit-jaeger v0.0.0-20200518165323-80778fc3f91b`
`29`	`30`	`)`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ func init() {`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`
`29`		`-// check if file exists, handle error correctly if it doesn't`
	`29`	`+// fileExists checks whether file exists, handle error correctly if it doesn't.`
`30`	`30`	`func fileExists(path string) bool {`
`31`	`31`	`_, err := os.Stat(path)`
`32`	`32`	`if err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ func ExecWithCustomConfig(cmd *cobra.Command, debugEnabled bool, loadConfig func`
`92`	`92`	`}`
`93`	`93`	`}`
`94`	`94`
`95`		`-// Ctx returns the appropriate context.Context for ExecuteWithConfig commands`
	`95`	`+// Ctx returns the appropriate context.Context for ExecuteWithConfig commands.`
`96`	`96`	`func Ctx(cmd *cobra.Command) (context.Context, context.CancelFunc) {`
`97`	`97`	`commandMtx.Lock()`
`98`	`98`	`defer commandMtx.Unlock()`
`@@ -122,7 +122,7 @@ func Ctx(cmd *cobra.Command) (context.Context, context.CancelFunc) {`
`122`	`122`	`return ctx, cancel`
`123`	`123`	`}`
`124`	`124`
`125`		`-// AtomicLevel returns the appropriate zap.AtomicLevel for ExecuteWithConfig commands`
	`125`	`+// AtomicLevel returns the appropriate zap.AtomicLevel for ExecuteWithConfig commands.`
`126`	`126`	`func AtomicLevel(cmd cobra.Command) zap.AtomicLevel {`
`127`	`127`	`commandMtx.Lock()`
`128`	`128`	`defer commandMtx.Unlock()`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ func NewLoggerWithOutputPaths(outputPaths ...string) (*zap.Logger, error) {`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`// NewLoggerWithOutputPathsAndAtomicLevel is the same as NewLoggerWithOutputPaths, but overrides the log output paths`
`60`		`-// and returns the AtomicLevel`
	`60`	`+// and returns the AtomicLevel.`
`61`	`61`	`func NewLoggerWithOutputPathsAndAtomicLevel(outputPaths ...string) (zap.Logger, zap.AtomicLevel, error) {`
`62`	`62`	`levelEncoder := zapcore.CapitalLevelEncoder`
`63`	`63`	`timeKey := "T"`
Original file line number	Diff line number	Diff line change
`@@ -16,12 +16,12 @@ import (`
`16`	`16`	`)`
`17`	`17`
`18`	`18`	`var (`
`19`		`- // TagDB tags a trace as hitting the database`
	`19`	`+ // TagDB tags a trace as hitting the database.`
`20`	`20`	`TagDB = tracetagger.NewTagRef()`
`21`	`21`	`)`
`22`	`22`
`23`		`-// CollectTraces starts storing all known tagged traces on disk, until cancel`
`24`		`-// is called`
	`23`	`+// CollectTraces starts storing all known tagged traces on disk,`
	`24`	`+// until cancel is called.`
`25`	`25`	`func CollectTraces() (cancel func()) {`
`26`	`26`	`path := filepath.Join(os.TempDir(), "storj-traces", fmt.Sprint(os.Getpid()))`
`27`	`27`	`disable := TagDB.Enable()`
`@@ -43,12 +43,12 @@ func CollectTraces() (cancel func()) {`
`43`	`43`	`}`
`44`	`44`	`}`
`45`	`45`
`46`		`-// Tag tags a trace with the given tag`
	`46`	`+// Tag tags a trace with the given tag.`
`47`	`47`	`func Tag(ctx context.Context, tag *tracetagger.TagRef) {`
`48`	`48`	`tracetagger.Tag(ctx, tag)`
`49`	`49`	`}`
`50`	`50`
`51`		`-// TagScope tags all functions on an entire monkit Scope with a given tag`
	`51`	`+// TagScope tags all functions on an entire monkit Scope with a given tag.`
`52`	`52`	`func TagScope(tag tracetagger.TagRef, scope monkit.Scope) {`
`53`	`53`	`tracetagger.TagScope(tag, scope)`
`54`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ import (`
`10`	`10`	`"github.com/spacemonkeygo/monkit/v3"`
`11`	`11`	`)`
`12`	`12`
`13`		`-// Stats implements the monkit.StatSource interface`
	`13`	`+// Stats implements the monkit.StatSource interface.`
`14`	`14`	`func (info *Info) Stats(cb func(key monkit.SeriesKey, field string, val float64)) {`
`15`	`15`	`key := monkit.NewSeriesKey("version_info")`
`16`	`16`