Confusing naming of struct fields or methods RVV-B0001
Bug risk
Minor
4 months ago
—
3 years old
Method 'run' differs only by capitalization to method 'Run' in the same source file
65 return ok, err
66}
67
68func (step *SetPipelineStep) run(ctx context.Context, state RunState, delegate SetPipelineStepDelegate) (bool, error) { 69 logger := lagerctx.FromContext(ctx)
70 logger = logger.Session("set-pipeline-step", lager.Data{
71 "step-name": step.plan.Name,Method 'isPending' differs only by capitalization to method 'IsPending' in the same source file
39 return p.isPending()
40}
41
42func (p *promise) isPending() bool {43 return p.volume == nil && p.err == nil
44}
45Method 'track' differs only by capitalization to method 'Track' in the same source file
35 t.track(varRef, val)
36}
37
38func (t *Tracker) track(varRef Reference, val interface{}) {39 switch v := val.(type) {
40 case map[interface{}]interface{}:
41 for kk, vv := range v {Method 'resolve' differs only by capitalization to method 'Resolve' in the same source file
43 return resolver.configPayload, nil
44}
45
46func (resolver TemplateResolver) resolve(expectAllKeys bool) ([]byte, error) {47 tpl := NewTemplate(resolver.configPayload)
48 bytes, err := tpl.Evaluate(NewMultiVars(resolver.params), EvaluateOpts{ExpectAllKeys: expectAllKeys})
49 if err != nil {Method 'heartbeat' differs only by capitalization to method 'Heartbeat' in the same source file
170 HeartbeatStatusHealthy
171)
172
173func (heartbeater *Heartbeater) heartbeat(logger lager.Logger) HeartbeatStatus {174 heartbeatData := lager.Data{
175 "worker-platform": heartbeater.registration.Platform,
176 "worker-address": heartbeater.registration.GardenAddr,
Description
Methods or fields of struct that have names different only by capitalization could be confusing.
Bad practice
type SomeType struct {
// actual build system to be inferred, based on the `BuildSystem` passed by user
buildSystem string
// name of the build system to use
BuildSystem string
}
Recommended
type SomeType struct {
// actual build system to be inferred, based on the `BuildSystem` passed by user
internalBuildSystem string
// name of the build system to use
BuildSystem string
}