Add an option to trim trailing slashes from URLs

commands/server.go

@@ -220,6 +220,15 @@ func (c *commandeer) serve(port int) {
 				w.Header().Set("Cache-Control", "no-store, no-cache, must-revalidate, max-age=0")
 				w.Header().Set("Pragma", "no-cache")
 			}
+
+			if c.Cfg.GetBool("trimTrailingSlash") {
+				path := strings.Split(r.URL.Path, "/")
+
+				if !strings.Contains(path[len(path)-1], ".") && !strings.HasSuffix(r.URL.Path, "/") {
+					r.URL.Path += ".html"
+				}
+			}
+
 			h.ServeHTTP(w, r)
 		})
 	}

helpers/pathspec.go

@@ -26,6 +26,7 @@ type PathSpec struct {
 
 	disablePathToLower bool
 	removePathAccents  bool
+	trimTrailingSlash  bool
 	uglyURLs           bool
 	canonifyURLs       bool
 
@@ -77,6 +78,7 @@ func NewPathSpec(fs *hugofs.Fs, cfg config.Provider) (*PathSpec, error) {
 		Cfg:                            cfg,
 		disablePathToLower:             cfg.GetBool("disablePathToLower"),
 		removePathAccents:              cfg.GetBool("removePathAccents"),
+		trimTrailingSlash:              cfg.GetBool("trimTrailingSlash"),
 		uglyURLs:                       cfg.GetBool("uglyURLs"),
 		canonifyURLs:                   cfg.GetBool("canonifyURLs"),
 		multilingual:                   cfg.GetBool("multilingual"),

helpers/pathspec_test.go

@@ -27,6 +27,7 @@ func TestNewPathSpecFromConfig(t *testing.T) {
 	l := NewLanguage("no", v)
 	v.Set("disablePathToLower", true)
 	v.Set("removePathAccents", true)
+	v.Set("trimTrailingSlash", true)
 	v.Set("uglyURLs", true)
 	v.Set("multilingual", true)
 	v.Set("defaultContentLanguageInSubdir", true)
@@ -48,6 +49,7 @@ func TestNewPathSpecFromConfig(t *testing.T) {
 	require.True(t, p.disablePathToLower)
 	require.True(t, p.multilingual)
 	require.True(t, p.removePathAccents)
+	require.True(t, p.trimTrailingSlash)
 	require.True(t, p.uglyURLs)
 	require.Equal(t, "no", p.defaultContentLanguage)
 	require.Equal(t, "no", p.language.Lang)

helpers/url.go

@@ -323,14 +323,18 @@ func (p *PathSpec) URLizeAndPrep(in string) string {
 
 // URLPrep applies misc sanitation to the given URL.
 func (p *PathSpec) URLPrep(in string) string {
-	if p.uglyURLs {
+	if p.uglyURLs && !p.trimTrailingSlash {
 		return Uglify(SanitizeURL(in))
 	}
 	pretty := PrettifyURL(SanitizeURL(in))
 	if path.Ext(pretty) == ".xml" {
 		return pretty
 	}
-	url, err := purell.NormalizeURLString(pretty, purell.FlagAddTrailingSlash)
+	flag := purell.FlagAddTrailingSlash
+	if p.trimTrailingSlash {
+		flag = purell.FlagRemoveTrailingSlash
+	}
+	url, err := purell.NormalizeURLString(pretty, flag)
 	if err != nil {
 		return pretty
 	}

helpers/url_test.go

@@ -241,19 +241,34 @@ func TestMakePermalink(t *testing.T) {
 
 func TestURLPrep(t *testing.T) {
 	type test struct {
-		ugly   bool
-		input  string
-		output string
+		trimTrailingSlash bool
+		uglyURLs          bool
+		input             string
+		output            string
 	}
 
 	data := []test{
-		{false, "/section/name.html", "/section/name/"},
-		{true, "/section/name/index.html", "/section/name.html"},
+		// trimTrailingSlash=false, uglyURLs=false
+		{false, false, "/section/name.html", "/section/name/"},
+		{false, false, "/section/name/index.html", "/section/name/"},
+
+		// trimTrailingSlash=false, uglyURLs=true
+		{false, true, "/section/name.html", "/section/name.html"},
+		{false, true, "/section/name/index.html", "/section/name.html"},
+
+		// trimTrailingSlash=true, uglyURLs=false
+		{true, false, "/section/name.html", "/section/name"},
+		{true, false, "/section/name/index.html", "/section/name"},
+
+		// trimTrailingSlash=true, uglyURLs=true
+		{true, true, "/section/name.html", "/section/name"},
+		{true, true, "/section/name/index.html", "/section/name"},
 	}
 
 	for i, d := range data {
 		v := viper.New()
-		v.Set("uglyURLs", d.ugly)
+		v.Set("trimTrailingSlash", d.trimTrailingSlash)
+		v.Set("uglyURLs", d.uglyURLs)
 		l := NewDefaultLanguage(v)
 		p, _ := NewPathSpec(hugofs.NewMem(v), l)
 

hugolib/config.go

@@ -116,6 +116,7 @@ func loadDefaultSettingsFor(v *viper.Viper) error {
 	v.SetDefault("ignoreCache", false)
 	v.SetDefault("canonifyURLs", false)
 	v.SetDefault("relativeURLs", false)
+	v.SetDefault("trimTrailingSlash", false)
 	v.SetDefault("removePathAccents", false)
 	v.SetDefault("titleCaseStyle", "AP")
 	v.SetDefault("taxonomies", map[string]string{"tag": "tags", "category": "categories"})