Apply some more Golint suggestions

diff --git a/commands/hugo.go b/commands/hugo.go
index 1b19c34a4b8dfcf35e6234f0790eb622398de59c..b16f7806fe3e7c5b9acb67ecdcf6b35b0aee12f0 100644 (file)
--- a/commands/hugo.go
+++ b/commands/hugo.go
@@ -379,9 +379,9 @@ func NewWatcher(port int) error {
                        case evs := <-watcher.Event:
                                jww.INFO.Println("File System Event:", evs)
 
-                               static_changed := false
-                               dynamic_changed := false
-                               static_files_changed := make(map[string]bool)
+                               staticChanged := false
+                               dynamicChanged := false
+                               staticFilesChanged := make(map[string]bool)
 
                                for _, ev := range evs {
                                        ext := filepath.Ext(ev.Name)
@@ -395,12 +395,12 @@ func NewWatcher(port int) error {
                                        }
 
                                        isstatic := strings.HasPrefix(ev.Name, helpers.GetStaticDirPath()) || strings.HasPrefix(ev.Name, helpers.GetThemesDirPath())
-                                       static_changed = static_changed || isstatic
-                                       dynamic_changed = dynamic_changed || !isstatic
+                                       staticChanged = staticChanged || isstatic
+                                       dynamicChanged = dynamicChanged || !isstatic
 
                                        if isstatic {
                                                if staticPath, err := helpers.MakeStaticPathRelative(ev.Name); err == nil {
-                                                       static_files_changed[staticPath] = true
+                                                       staticFilesChanged[staticPath] = true
                                                }
                                        }
 
@@ -412,7 +412,7 @@ func NewWatcher(port int) error {
                                        }
                                }
 
-                               if static_changed {
+                               if staticChanged {
                                        jww.FEEDBACK.Println("Static file changed, syncing\n")
                                        utils.StopOnErr(copyStatic(), fmt.Sprintf("Error copying static files to %s", helpers.AbsPathify(viper.GetString("PublishDir"))))
 
@@ -420,8 +420,8 @@ func NewWatcher(port int) error {
                                                // Will block forever trying to write to a channel that nobody is reading if livereload isn't initalized
 
                                                // force refresh when more than one file
-                                               if len(static_files_changed) == 1 {
-                                                       for path := range static_files_changed {
+                                               if len(staticFilesChanged) == 1 {
+                                                       for path := range staticFilesChanged {
                                                                livereload.RefreshPath(path)
                                                        }
 
@@ -431,7 +431,7 @@ func NewWatcher(port int) error {
                                        }
                                }
 
-                               if dynamic_changed {
+                               if dynamicChanged {
                                        fmt.Print("\nChange detected, rebuilding site\n")
                                        const layout = "2006-01-02 15:04 -0700"
                                        fmt.Println(time.Now().Format(layout))

diff --git a/helpers/content.go b/helpers/content.go
index a34159a148560906ebe376edf2ab54d6ea6d38f2..d37d9dd286273cd1b6f88df5b7c978956d875d6a 100644 (file)
--- a/helpers/content.go
+++ b/helpers/content.go
@@ -37,6 +37,7 @@ var SummaryLength = 70
 // Custom divider <!--more--> let's user define where summarization ends.
 var SummaryDivider = []byte("<!--more-->")
 
+// Blackfriday holds configuration values for Blackfriday rendering.
 type Blackfriday struct {
        AngledQuotes   bool
        Fractions      bool
@@ -44,6 +45,7 @@ type Blackfriday struct {
        Extensions     []string
 }
 
+// NewBlackfriday creates a new Blackfriday with some sane defaults.
 func NewBlackfriday() *Blackfriday {
        return &Blackfriday{
                AngledQuotes:   false,
@@ -77,28 +79,27 @@ func StripHTML(s string) string {
        // Shortcut strings with no tags in them
        if !strings.ContainsAny(s, "<>") {
                return s
-       } else {
-               s = stripHTMLReplacer.Replace(s)
-
-               // Walk through the string removing all tags
-               b := bp.GetBuffer()
-               defer bp.PutBuffer(b)
-
-               inTag := false
-               for _, r := range s {
-                       switch r {
-                       case '<':
-                               inTag = true
-                       case '>':
-                               inTag = false
-                       default:
-                               if !inTag {
-                                       b.WriteRune(r)
-                               }
+       }
+       s = stripHTMLReplacer.Replace(s)
+
+       // Walk through the string removing all tags
+       b := bp.GetBuffer()
+       defer bp.PutBuffer(b)
+
+       inTag := false
+       for _, r := range s {
+               switch r {
+               case '<':
+                       inTag = true
+               case '>':
+                       inTag = false
+               default:
+                       if !inTag {
+                               b.WriteRune(r)
                        }
                }
-               return b.String()
        }
+       return b.String()
 }
 
 // StripEmptyNav strips out empty <nav> tags from content.
@@ -111,6 +112,7 @@ func BytesToHTML(b []byte) template.HTML {
        return template.HTML(string(b))
 }
 
+// GetHtmlRenderer creates a new Renderer with the given configuration.
 func GetHtmlRenderer(defaultFlags int, ctx *RenderingContext) blackfriday.Renderer {
        renderParameters := blackfriday.HtmlRendererParameters{
                FootnoteAnchorPrefix:       viper.GetString("FootnoteAnchorPrefix"),
@@ -141,7 +143,7 @@ func GetHtmlRenderer(defaultFlags int, ctx *RenderingContext) blackfriday.Render
        return blackfriday.HtmlRendererWithParameters(htmlFlags, "", "", renderParameters)
 }
 
-func GetMarkdownExtensions(ctx *RenderingContext) int {
+func getMarkdownExtensions(ctx *RenderingContext) int {
        flags := 0 | blackfriday.EXTENSION_NO_INTRA_EMPHASIS |
                blackfriday.EXTENSION_TABLES | blackfriday.EXTENSION_FENCED_CODE |
                blackfriday.EXTENSION_AUTOLINK | blackfriday.EXTENSION_STRIKETHROUGH |
@@ -155,15 +157,15 @@ func GetMarkdownExtensions(ctx *RenderingContext) int {
        return flags
 }
 
-func MarkdownRender(ctx *RenderingContext) []byte {
+func markdownRender(ctx *RenderingContext) []byte {
        return blackfriday.Markdown(ctx.Content, GetHtmlRenderer(0, ctx),
-               GetMarkdownExtensions(ctx))
+               getMarkdownExtensions(ctx))
 }
 
-func MarkdownRenderWithTOC(ctx *RenderingContext) []byte {
+func markdownRenderWithTOC(ctx *RenderingContext) []byte {
        return blackfriday.Markdown(ctx.Content,
                GetHtmlRenderer(blackfriday.HTML_TOC, ctx),
-               GetMarkdownExtensions(ctx))
+               getMarkdownExtensions(ctx))
 }
 
 // ExtractTOC extracts Table of Contents from content.
@@ -202,6 +204,8 @@ func ExtractTOC(content []byte) (newcontent []byte, toc []byte) {
        return
 }
 
+// RenderingContext holds contextual information, like content and configuration,
+// for a given content renderin.g
 type RenderingContext struct {
        Content    []byte
        PageFmt    string
@@ -219,23 +223,25 @@ func (c *RenderingContext) getConfig() *Blackfriday {
        return c.Config
 }
 
+// RenderBytesWithTOC renders a []byte with table of contents included.
 func RenderBytesWithTOC(ctx *RenderingContext) []byte {
        switch ctx.PageFmt {
        default:
-               return MarkdownRenderWithTOC(ctx)
+               return markdownRenderWithTOC(ctx)
        case "markdown":
-               return MarkdownRenderWithTOC(ctx)
+               return markdownRenderWithTOC(ctx)
        case "rst":
                return []byte(GetRstContent(ctx.Content))
        }
 }
 
+// RenderBytes renders a []byte.
 func RenderBytes(ctx *RenderingContext) []byte {
        switch ctx.PageFmt {
        default:
-               return MarkdownRender(ctx)
+               return markdownRender(ctx)
        case "markdown":
-               return MarkdownRender(ctx)
+               return markdownRender(ctx)
        case "rst":
                return []byte(GetRstContent(ctx.Content))
        }
@@ -250,7 +256,7 @@ func TotalWords(s string) int {
 func WordCount(s string) map[string]int {
        m := make(map[string]int)
        for _, f := range strings.Fields(s) {
-               m[f] += 1
+               m[f]++
        }
 
        return m