From: Cameron Moore <moorereason@gmail.com>
Date: Thu, 6 Sep 2018 16:02:32 +0000 (-0500)
Subject: common: Fix golint errors
X-Git-Tag: v0.49~56
X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=b8b91f550646b2620649c3504e14a441975bea9f;p=brevno-suite%2Fhugo

common: Fix golint errors

common/errors/errors.go:21:1: comment on exported var FeatureNotAvailableErr should be of the form "FeatureNotAvailableErr ..."
common/errors/errors.go:23:5: error var FeatureNotAvailableErr should have name of the form ErrFoo
common/maps/scratch.go:76:1: comment on exported method Scratch.Delete should be of the form "Delete ..."
common/maps/scratch.go:133:1: exported function NewScratch should have comment or be unexported
common/types/types.go:44:1: exported function NewKeyValuesStrings should have comment or be unexported
---

diff --git a/common/errors/errors.go b/common/errors/errors.go
index eff65ff9..673cd23f 100644
--- a/common/errors/errors.go
+++ b/common/errors/errors.go
@@ -18,6 +18,8 @@ import (
 	"errors"
 )
 
+// ErrFeatureNotAvailable denotes that a feature is unavailable.
+//
 // We will, at least to begin with, make some Hugo features (SCSS with libsass) optional,
 // and this error is used to signal those situations.
-var FeatureNotAvailableErr = errors.New("this feature is not available in your current Hugo version")
+var ErrFeatureNotAvailable = errors.New("this feature is not available in your current Hugo version")
diff --git a/common/maps/scratch.go b/common/maps/scratch.go
index d0097143..4b062d13 100644
--- a/common/maps/scratch.go
+++ b/common/maps/scratch.go
@@ -73,7 +73,7 @@ func (c *Scratch) Set(key string, value interface{}) string {
 	return ""
 }
 
-// Reset deletes the given key
+// Delete deletes the given key.
 func (c *Scratch) Delete(key string) string {
 	c.mu.Lock()
 	delete(c.values, key)
@@ -81,7 +81,7 @@ func (c *Scratch) Delete(key string) string {
 	return ""
 }
 
-// Get returns a value previously set by Add or Set
+// Get returns a value previously set by Add or Set.
 func (c *Scratch) Get(key string) interface{} {
 	c.mu.RLock()
 	val := c.values[key]
@@ -104,7 +104,7 @@ func (c *Scratch) SetInMap(key string, mapKey string, value interface{}) string
 	return ""
 }
 
-// GetSortedMapValues returns a sorted map previously filled with SetInMap
+// GetSortedMapValues returns a sorted map previously filled with SetInMap.
 func (c *Scratch) GetSortedMapValues(key string) interface{} {
 	c.mu.RLock()
 
@@ -130,6 +130,7 @@ func (c *Scratch) GetSortedMapValues(key string) interface{} {
 	return sortedArray
 }
 
+// NewScratch returns a new instance Scratch.
 func NewScratch() *Scratch {
 	return &Scratch{values: make(map[string]interface{})}
 }
diff --git a/common/types/types.go b/common/types/types.go
index a5805d07..fca58edc 100644
--- a/common/types/types.go
+++ b/common/types/types.go
@@ -41,6 +41,8 @@ func (k KeyValues) String() string {
 	return fmt.Sprintf("%v: %v", k.Key, k.Values)
 }
 
+// NewKeyValuesStrings takes a given key and slice of values and returns a new
+// KeyValues struct.
 func NewKeyValuesStrings(key string, values ...string) KeyValues {
 	iv := make([]interface{}, len(values))
 	for i := 0; i < len(values); i++ {
diff --git a/resource/postcss/postcss.go b/resource/postcss/postcss.go
index 3b2b4175..202b4c06 100644
--- a/resource/postcss/postcss.go
+++ b/resource/postcss/postcss.go
@@ -111,7 +111,7 @@ func (t *postcssTransformation) Transform(ctx *resource.ResourceTransformationCt
 		binary = binaryName
 		if _, err := exec.LookPath(binary); err != nil {
 			// This may be on a CI server etc. Will fall back to pre-built assets.
-			return errors.FeatureNotAvailableErr
+			return errors.ErrFeatureNotAvailable
 		}
 	}
 
diff --git a/resource/tocss/scss/tocss_notavailable.go b/resource/tocss/scss/tocss_notavailable.go
index 69b4fc65..2ec5a483 100644
--- a/resource/tocss/scss/tocss_notavailable.go
+++ b/resource/tocss/scss/tocss_notavailable.go
@@ -26,5 +26,5 @@ func Supports() bool {
 }
 
 func (t *toCSSTransformation) Transform(ctx *resource.ResourceTransformationCtx) error {
-	return errors.FeatureNotAvailableErr
+	return errors.ErrFeatureNotAvailable
 }
diff --git a/resource/transform.go b/resource/transform.go
index 5c01c712..9e6215b9 100644
--- a/resource/transform.go
+++ b/resource/transform.go
@@ -386,7 +386,7 @@ func (r *transformedResource) transform(setContent bool) (err error) {
 		}
 
 		if err := tr.transformation.Transform(tctx); err != nil {
-			if err == errors.FeatureNotAvailableErr {
+			if err == errors.ErrFeatureNotAvailable {
 				// This transformation is not available in this
 				// Hugo installation (scss not compiled in, PostCSS not available etc.)
 				// If a prepared bundle for this transformation chain is available, use that.