Correct initialisms as suggested by golint

First step to use initialisms that golint suggests,
for example:

    Line 116: func GetHtmlRenderer should be GetHTMLRenderer

as see on http://goreportcard.com/report/spf13/hugo

Thanks to @bep for the idea!

Note that command-line flags (cobra and pflag)
as well as struct fields like .BaseUrl and .Url
that are used in Go HTML templates need more work
to maintain backward-compatibility, and thus
are NOT yet dealt with in this commit.

First step in fixing #959.

commands/hugo.go

@@ -56,8 +56,8 @@ Complete documentation is available at http://gohugo.io`,
 var hugoCmdV *cobra.Command
 
 //Flags that are to be added to commands.
-var BuildWatch, IgnoreCache, Draft, Future, UglyUrls, Verbose, Logging, VerboseLog, DisableRSS, DisableSitemap, PluralizeListTitles, NoTimes bool
-var Source, CacheDir, Destination, Theme, BaseUrl, CfgFile, LogFile, Editor string
+var BuildWatch, IgnoreCache, Draft, Future, UglyURLs, Verbose, Logging, VerboseLog, DisableRSS, DisableSitemap, PluralizeListTitles, NoTimes bool
+var Source, CacheDir, Destination, Theme, BaseURL, CfgFile, LogFile, Editor string
 
 //Execute adds all child commands to the root command HugoCmd and sets flags appropriately.
 func Execute() {
@@ -89,8 +89,8 @@ func init() {
 	HugoCmd.PersistentFlags().StringVarP(&Destination, "destination", "d", "", "filesystem path to write files to")
 	HugoCmd.PersistentFlags().StringVarP(&Theme, "theme", "t", "", "theme to use (located in /themes/THEMENAME/)")
 	HugoCmd.PersistentFlags().BoolVarP(&Verbose, "verbose", "v", false, "verbose output")
-	HugoCmd.PersistentFlags().BoolVar(&UglyUrls, "uglyUrls", false, "if true, use /filename.html instead of /filename/")
-	HugoCmd.PersistentFlags().StringVarP(&BaseUrl, "baseUrl", "b", "", "hostname (and path) to the root eg. http://spf13.com/")
+	HugoCmd.PersistentFlags().BoolVar(&UglyURLs, "uglyUrls", false, "if true, use /filename.html instead of /filename/")
+	HugoCmd.PersistentFlags().StringVarP(&BaseURL, "baseUrl", "b", "", "hostname (and path) to the root eg. http://spf13.com/")
 	HugoCmd.PersistentFlags().StringVar(&CfgFile, "config", "", "config file (default is path/config.yaml|json|toml)")
 	HugoCmd.PersistentFlags().StringVar(&Editor, "editor", "", "edit new content with this editor, if provided")
 	HugoCmd.PersistentFlags().BoolVar(&Logging, "log", false, "Enable Logging")
@@ -127,10 +127,10 @@ func InitializeConfig() {
 	viper.SetDefault("DefaultLayout", "post")
 	viper.SetDefault("BuildDrafts", false)
 	viper.SetDefault("BuildFuture", false)
-	viper.SetDefault("UglyUrls", false)
+	viper.SetDefault("UglyURLs", false)
 	viper.SetDefault("Verbose", false)
 	viper.SetDefault("IgnoreCache", false)
-	viper.SetDefault("CanonifyUrls", false)
+	viper.SetDefault("CanonifyURLs", false)
 	viper.SetDefault("Taxonomies", map[string]string{"tag": "tags", "category": "categories"})
 	viper.SetDefault("Permalinks", make(hugolib.PermalinkOverrides, 0))
 	viper.SetDefault("Sitemap", hugolib.Sitemap{Priority: -1})
@@ -155,7 +155,7 @@ func InitializeConfig() {
 	}
 
 	if hugoCmdV.PersistentFlags().Lookup("uglyUrls").Changed {
-		viper.Set("UglyUrls", UglyUrls)
+		viper.Set("UglyURLs", UglyURLs)
 	}
 
 	if hugoCmdV.PersistentFlags().Lookup("disableRSS").Changed {
@@ -181,14 +181,14 @@ func InitializeConfig() {
 	if hugoCmdV.PersistentFlags().Lookup("logFile").Changed {
 		viper.Set("LogFile", LogFile)
 	}
-	if BaseUrl != "" {
-		if !strings.HasSuffix(BaseUrl, "/") {
-			BaseUrl = BaseUrl + "/"
+	if BaseURL != "" {
+		if !strings.HasSuffix(BaseURL, "/") {
+			BaseURL = BaseURL + "/"
 		}
-		viper.Set("BaseUrl", BaseUrl)
+		viper.Set("BaseURL", BaseURL)
 	}
 
-	if viper.GetString("BaseUrl") == "" {
+	if viper.GetString("BaseURL") == "" {
 		jww.ERROR.Println("No 'baseurl' set in configuration or as a flag. Features like page menus will not work without one.")
 	}
 

commands/server.go

@@ -84,11 +84,11 @@ func server(cmd *cobra.Command, args []string) {
 
 	viper.Set("port", serverPort)
 
-	BaseUrl, err := fixUrl(BaseUrl)
+	BaseURL, err := fixURL(BaseURL)
 	if err != nil {
 		jww.ERROR.Fatal(err)
 	}
-	viper.Set("BaseUrl", BaseUrl)
+	viper.Set("BaseURL", BaseURL)
 
 	if err := memStats(); err != nil {
 		jww.ERROR.Println("memstats error:", err)
@@ -114,9 +114,9 @@ func serve(port int) {
 	httpFs := &afero.HttpFs{SourceFs: hugofs.DestinationFS}
 	fileserver := http.FileServer(httpFs.Dir(helpers.AbsPathify(viper.GetString("PublishDir"))))
 
-	u, err := url.Parse(viper.GetString("BaseUrl"))
+	u, err := url.Parse(viper.GetString("BaseURL"))
 	if err != nil {
-		jww.ERROR.Fatalf("Invalid BaseUrl: %s", err)
+		jww.ERROR.Fatalf("Invalid BaseURL: %s", err)
 	}
 	if u.Path == "" || u.Path == "/" {
 		http.Handle("/", fileserver)
@@ -137,10 +137,10 @@ func serve(port int) {
 
 // fixUrl massages the BaseUrl into a form needed for serving
 // all pages correctly.
-func fixUrl(s string) (string, error) {
+func fixURL(s string) (string, error) {
 	useLocalhost := false
 	if s == "" {
-		s = viper.GetString("BaseUrl")
+		s = viper.GetString("BaseURL")
 		useLocalhost = true
 	}
 	if !strings.HasPrefix(s, "http://") && !strings.HasPrefix(s, "https://") {

commands/server_test.go

@@ -6,11 +6,11 @@ import (
 	"github.com/spf13/viper"
 )
 
-func TestFixUrl(t *testing.T) {
+func TestFixURL(t *testing.T) {
 	type data struct {
 		TestName   string
-		CliBaseUrl string
-		CfgBaseUrl string
+		CLIBaseURL string
+		CfgBaseURL string
 		AppendPort bool
 		Port       int
 		Result     string
@@ -28,11 +28,11 @@ func TestFixUrl(t *testing.T) {
 	}
 
 	for i, test := range tests {
-		BaseUrl = test.CliBaseUrl
-		viper.Set("BaseUrl", test.CfgBaseUrl)
+		BaseURL = test.CLIBaseURL
+		viper.Set("BaseURL", test.CfgBaseURL)
 		serverAppend = test.AppendPort
 		serverPort = test.Port
-		result, err := fixUrl(BaseUrl)
+		result, err := fixURL(BaseURL)
 		if err != nil {
 			t.Errorf("Test #%d %s: unexpected error %s", i, test.TestName, err)
 		}

helpers/content.go

@@ -41,7 +41,7 @@ var SummaryDivider = []byte("<!--more-->")
 type Blackfriday struct {
 	AngledQuotes   bool
 	Fractions      bool
-	PlainIdAnchors bool
+	PlainIDAnchors bool
 	Extensions     []string
 }
 
@@ -50,7 +50,7 @@ func NewBlackfriday() *Blackfriday {
 	return &Blackfriday{
 		AngledQuotes:   false,
 		Fractions:      true,
-		PlainIdAnchors: false,
+		PlainIDAnchors: false,
 	}
 }
 
@@ -113,17 +113,17 @@ func BytesToHTML(b []byte) template.HTML {
 }
 
 // GetHtmlRenderer creates a new Renderer with the given configuration.
-func GetHtmlRenderer(defaultFlags int, ctx *RenderingContext) blackfriday.Renderer {
+func GetHTMLRenderer(defaultFlags int, ctx *RenderingContext) blackfriday.Renderer {
 	renderParameters := blackfriday.HtmlRendererParameters{
 		FootnoteAnchorPrefix:       viper.GetString("FootnoteAnchorPrefix"),
 		FootnoteReturnLinkContents: viper.GetString("FootnoteReturnLinkContents"),
 	}
 
-	b := len(ctx.DocumentId) != 0
+	b := len(ctx.DocumentID) != 0
 
-	if b && !ctx.getConfig().PlainIdAnchors {
-		renderParameters.FootnoteAnchorPrefix = ctx.DocumentId + ":" + renderParameters.FootnoteAnchorPrefix
-		renderParameters.HeaderIDSuffix = ":" + ctx.DocumentId
+	if b && !ctx.getConfig().PlainIDAnchors {
+		renderParameters.FootnoteAnchorPrefix = ctx.DocumentID + ":" + renderParameters.FootnoteAnchorPrefix
+		renderParameters.HeaderIDSuffix = ":" + ctx.DocumentID
 	}
 
 	htmlFlags := defaultFlags
@@ -158,13 +158,13 @@ func getMarkdownExtensions(ctx *RenderingContext) int {
 }
 
 func markdownRender(ctx *RenderingContext) []byte {
-	return blackfriday.Markdown(ctx.Content, GetHtmlRenderer(0, ctx),
+	return blackfriday.Markdown(ctx.Content, GetHTMLRenderer(0, ctx),
 		getMarkdownExtensions(ctx))
 }
 
 func markdownRenderWithTOC(ctx *RenderingContext) []byte {
 	return blackfriday.Markdown(ctx.Content,
-		GetHtmlRenderer(blackfriday.HTML_TOC, ctx),
+		GetHTMLRenderer(blackfriday.HTML_TOC, ctx),
 		getMarkdownExtensions(ctx))
 }
 
@@ -209,7 +209,7 @@ func ExtractTOC(content []byte) (newcontent []byte, toc []byte) {
 type RenderingContext struct {
 	Content    []byte
 	PageFmt    string
-	DocumentId string
+	DocumentID string
 	Config     *Blackfriday
 	configInit sync.Once
 }

helpers/content_test.go

@@ -7,7 +7,7 @@ import (
 	"testing"
 )
 
-const tstHtmlContent = "<!DOCTYPE html><html><head><script src=\"http://two/foobar.js\"></script></head><body><nav><ul><li hugo-nav=\"section_0\"></li><li hugo-nav=\"section_1\"></li></ul></nav><article>content <a href=\"http://two/foobar\">foobar</a>. Follow up</article><p>This is some text.<br>And some more.</p></body></html>"
+const tstHTMLContent = "<!DOCTYPE html><html><head><script src=\"http://two/foobar.js\"></script></head><body><nav><ul><li hugo-nav=\"section_0\"></li><li hugo-nav=\"section_1\"></li></ul></nav><article>content <a href=\"http://two/foobar\">foobar</a>. Follow up</article><p>This is some text.<br>And some more.</p></body></html>"
 
 func TestStripHTML(t *testing.T) {
 	type test struct {
@@ -31,7 +31,7 @@ func TestStripHTML(t *testing.T) {
 func BenchmarkStripHTML(b *testing.B) {
 	b.ResetTimer()
 	for i := 0; i < b.N; i++ {
-		StripHTML(tstHtmlContent)
+		StripHTML(tstHTMLContent)
 	}
 }
 

helpers/url.go

@@ -52,7 +52,7 @@ func (PathBridge) Separator() string {
 
 var pathBridge PathBridge
 
-func sanitizeUrlWithFlags(in string, f purell.NormalizationFlags) string {
+func sanitizeURLWithFlags(in string, f purell.NormalizationFlags) string {
 	s, err := purell.NormalizeURLString(in, f)
 	if err != nil {
 		return in
@@ -88,20 +88,20 @@ func sanitizeUrlWithFlags(in string, f purell.NormalizationFlags) string {
 }
 
 // SanitizeUrl sanitizes the input URL string.
-func SanitizeUrl(in string) string {
-	return sanitizeUrlWithFlags(in, purell.FlagsSafe|purell.FlagRemoveTrailingSlash|purell.FlagRemoveDotSegments|purell.FlagRemoveDuplicateSlashes|purell.FlagRemoveUnnecessaryHostDots|purell.FlagRemoveEmptyPortSeparator)
+func SanitizeURL(in string) string {
+	return sanitizeURLWithFlags(in, purell.FlagsSafe|purell.FlagRemoveTrailingSlash|purell.FlagRemoveDotSegments|purell.FlagRemoveDuplicateSlashes|purell.FlagRemoveUnnecessaryHostDots|purell.FlagRemoveEmptyPortSeparator)
 }
 
 // SanitizeUrlKeepTrailingSlash is the same as SanitizeUrl, but will keep any trailing slash.
-func SanitizeUrlKeepTrailingSlash(in string) string {
-	return sanitizeUrlWithFlags(in, purell.FlagsSafe|purell.FlagRemoveDotSegments|purell.FlagRemoveDuplicateSlashes|purell.FlagRemoveUnnecessaryHostDots|purell.FlagRemoveEmptyPortSeparator)
+func SanitizeURLKeepTrailingSlash(in string) string {
+	return sanitizeURLWithFlags(in, purell.FlagsSafe|purell.FlagRemoveDotSegments|purell.FlagRemoveDuplicateSlashes|purell.FlagRemoveUnnecessaryHostDots|purell.FlagRemoveEmptyPortSeparator)
 }
 
 // Similar to MakePath, but with Unicode handling
 // Example:
 //     uri: Vim (text editor)
 //     urlize: vim-text-editor
-func Urlize(uri string) string {
+func URLize(uri string) string {
 	sanitized := MakePathToLower(uri)
 
 	// escape unicode letters
@@ -148,9 +148,9 @@ func MakePermalink(host, plink string) *url.URL {
 // AddContextRoot adds the context root to an URL if it's not already set.
 // For relative URL entries on sites with a base url with a context root set (i.e. http://example.com/mysite),
 // relative URLs must not include the context root if canonifyUrls is enabled. But if it's disabled, it must be set.
-func AddContextRoot(baseUrl, relativePath string) string {
+func AddContextRoot(baseURL, relativePath string) string {
 
-	url, err := url.Parse(baseUrl)
+	url, err := url.Parse(baseURL)
 	if err != nil {
 		panic(err)
 	}
@@ -164,16 +164,16 @@ func AddContextRoot(baseUrl, relativePath string) string {
 	return newPath
 }
 
-func UrlizeAndPrep(in string) string {
-	return UrlPrep(viper.GetBool("UglyUrls"), Urlize(in))
+func URLizeAndPrep(in string) string {
+	return URLPrep(viper.GetBool("UglyURLs"), URLize(in))
 }
 
-func UrlPrep(ugly bool, in string) string {
+func URLPrep(ugly bool, in string) string {
 	if ugly {
-		x := Uglify(SanitizeUrl(in))
+		x := Uglify(SanitizeURL(in))
 		return x
 	}
-	x := PrettifyUrl(SanitizeUrl(in))
+	x := PrettifyURL(SanitizeURL(in))
 	if path.Ext(x) == ".xml" {
 		return x
 	}
@@ -186,8 +186,8 @@ func UrlPrep(ugly bool, in string) string {
 }
 
 // PrettifyUrl takes a URL string and returns a semantic, clean URL.
-func PrettifyUrl(in string) string {
-	x := PrettifyUrlPath(in)
+func PrettifyURL(in string) string {
+	x := PrettifyURLPath(in)
 
 	if path.Base(x) == "index.html" {
 		return path.Dir(x)
@@ -205,7 +205,7 @@ func PrettifyUrl(in string) string {
 //     /section/name.html       becomes /section/name/index.html
 //     /section/name/           becomes /section/name/index.html
 //     /section/name/index.html becomes /section/name/index.html
-func PrettifyUrlPath(in string) string {
+func PrettifyURLPath(in string) string {
 	return PrettiyPath(in, pathBridge)
 }
 

helpers/url_test.go

@@ -19,7 +19,7 @@ func TestUrlize(t *testing.T) {
 	}
 
 	for _, test := range tests {
-		output := Urlize(test.input)
+		output := URLize(test.input)
 		if output != test.expected {
 			t.Errorf("Expected %#v, got %#v\n", test.expected, output)
 		}
@@ -36,8 +36,8 @@ func TestSanitizeUrl(t *testing.T) {
 	}
 
 	for _, test := range tests {
-		o1 := SanitizeUrl(test.input)
-		o2 := SanitizeUrlKeepTrailingSlash(test.input)
+		o1 := SanitizeURL(test.input)
+		o2 := SanitizeURLKeepTrailingSlash(test.input)
 
 		expected2 := test.expected
 
@@ -88,7 +88,7 @@ func TestUrlPrep(t *testing.T) {
 		{true, "/section/name/index.html", "/section/name.html"},
 	}
 	for i, d := range data {
-		output := UrlPrep(d.ugly, d.input)
+		output := URLPrep(d.ugly, d.input)
 		if d.output != output {
 			t.Errorf("Test #%d failed. Expected %q got %q", i, d.output, output)
 		}
@@ -98,7 +98,7 @@ func TestUrlPrep(t *testing.T) {
 
 func TestAddContextRoot(t *testing.T) {
 	tests := []struct {
-		baseUrl  string
+		baseURL  string
 		url      string
 		expected string
 	}{
@@ -114,30 +114,30 @@ func TestAddContextRoot(t *testing.T) {
 	}
 
 	for _, test := range tests {
-		output := AddContextRoot(test.baseUrl, test.url)
+		output := AddContextRoot(test.baseURL, test.url)
 		if output != test.expected {
 			t.Errorf("Expected %#v, got %#v\n", test.expected, output)
 		}
 	}
 }
 
 func TestPretty(t *testing.T) {
-	assert.Equal(t, PrettifyUrlPath("/section/name.html"), "/section/name/index.html")
-	assert.Equal(t, PrettifyUrlPath("/section/sub/name.html"), "/section/sub/name/index.html")
-	assert.Equal(t, PrettifyUrlPath("/section/name/"), "/section/name/index.html")
-	assert.Equal(t, PrettifyUrlPath("/section/name/index.html"), "/section/name/index.html")
-	assert.Equal(t, PrettifyUrlPath("/index.html"), "/index.html")
-	assert.Equal(t, PrettifyUrlPath("/name.xml"), "/name/index.xml")
-	assert.Equal(t, PrettifyUrlPath("/"), "/")
-	assert.Equal(t, PrettifyUrlPath(""), "/")
-	assert.Equal(t, PrettifyUrl("/section/name.html"), "/section/name")
-	assert.Equal(t, PrettifyUrl("/section/sub/name.html"), "/section/sub/name")
-	assert.Equal(t, PrettifyUrl("/section/name/"), "/section/name")
-	assert.Equal(t, PrettifyUrl("/section/name/index.html"), "/section/name")
-	assert.Equal(t, PrettifyUrl("/index.html"), "/")
-	assert.Equal(t, PrettifyUrl("/name.xml"), "/name/index.xml")
-	assert.Equal(t, PrettifyUrl("/"), "/")
-	assert.Equal(t, PrettifyUrl(""), "/")
+	assert.Equal(t, PrettifyURLPath("/section/name.html"), "/section/name/index.html")
+	assert.Equal(t, PrettifyURLPath("/section/sub/name.html"), "/section/sub/name/index.html")
+	assert.Equal(t, PrettifyURLPath("/section/name/"), "/section/name/index.html")
+	assert.Equal(t, PrettifyURLPath("/section/name/index.html"), "/section/name/index.html")
+	assert.Equal(t, PrettifyURLPath("/index.html"), "/index.html")
+	assert.Equal(t, PrettifyURLPath("/name.xml"), "/name/index.xml")
+	assert.Equal(t, PrettifyURLPath("/"), "/")
+	assert.Equal(t, PrettifyURLPath(""), "/")
+	assert.Equal(t, PrettifyURL("/section/name.html"), "/section/name")
+	assert.Equal(t, PrettifyURL("/section/sub/name.html"), "/section/sub/name")
+	assert.Equal(t, PrettifyURL("/section/name/"), "/section/name")
+	assert.Equal(t, PrettifyURL("/section/name/index.html"), "/section/name")
+	assert.Equal(t, PrettifyURL("/index.html"), "/")
+	assert.Equal(t, PrettifyURL("/name.xml"), "/name/index.xml")
+	assert.Equal(t, PrettifyURL("/"), "/")
+	assert.Equal(t, PrettifyURL(""), "/")
 }
 
 func TestUgly(t *testing.T) {