More TODOs

Author: bep

config/allconfig/allconfig.go

@@ -934,7 +934,7 @@ func (c *Configs) Init(logger loggers.Logger) error {
 	}
 
 	// Apply default project mounts.
-	if err := modules.ApplyProjectConfigDefaults(c.Modules[0], c.configLangs...); err != nil {
+	if err := modules.ApplyProjectConfigDefaults(logger.Logger(), c.Modules[0], c.configLangs...); err != nil {
 		return err
 	}
 

config/allconfig/alldecoders.go

@@ -309,7 +309,7 @@ var allDecoderSetups = map[string]decodeWeight{
 		key: "module",
 		decode: func(d decodeWeight, p decodeConfig) error {
 			var err error
-			p.c.Module, err = modules.DecodeConfig(p.p)
+			p.c.Module, err = modules.DecodeConfig(p.logger.Logger(), p.p)
 			return err
 		},
 	},

hugolib/filesystems/basefs.go

@@ -709,10 +709,10 @@ func (b *sourceFilesystemsBuilder) createOverlayFs(
 
 			patterns, hasLegacyIncludes, hasLegacyExcludes := mount.FilesToFilter()
 			if hasLegacyIncludes {
-				hugo.Deprecate("module.mounts.includeFiles", "Replaced by the simpler 'files' setting, see https://gohugo.io/configuration/module/#files", "v0.152.0")
+				hugo.Deprecate("module.mounts.includeFiles", "Replaced by the simpler 'files' setting, see https://gohugo.io/configuration/module/#files", "v0.153.0")
 			}
 			if hasLegacyExcludes {
-				hugo.Deprecate("module.mounts.excludeFiles", "Replaced by the simpler 'files' setting, see https://gohugo.io/configuration/module/#files", "v0.152.0")
+				hugo.Deprecate("module.mounts.excludeFiles", "Replaced by the simpler 'files' setting, see https://gohugo.io/configuration/module/#files", "v0.153.0")
 			}
 
 			inclusionFilter, err := hglob.NewFilenameFilterV2(patterns)

hugolib/page.go

@@ -18,6 +18,7 @@ import (
 	"fmt"
 	"iter"
 	"path/filepath"
+	"slices"
 	"strconv"
 	"strings"
 	"sync/atomic"
@@ -495,8 +496,7 @@ func (ps *pageState) AllTranslations() page.Pages {
 		if ps.m.pageConfig.TranslationKey != "" {
 			// translationKey set by user.
 			pas, _ := ps.s.h.translationKeyPages.Get(ps.m.pageConfig.TranslationKey)
-			pasc := make(page.Pages, len(pas))
-			copy(pasc, pas)
+			pasc := slices.Clone(pas)
 			page.SortByLanguage(pasc)
 			return pasc, nil
 		}
@@ -537,7 +537,6 @@ func (ps *pageState) siteVectors() sitesmatrix.VectorIterator {
 
 // TODO1 name.
 func (ps *pageState) Rotate(dimensionStr string) (page.Pages, error) {
-	// TODO1: For language, consider the special case with translationKey.
 	dimensionStr = strings.ToLower(dimensionStr)
 	key := ps.Path() + "/" + "rotate-" + dimensionStr
 	d, err := sitesmatrix.ParseDimension(dimensionStr)
@@ -557,6 +556,17 @@ func (ps *pageState) Rotate(dimensionStr string) (page.Pages, error) {
 			},
 		)
 
+		if dimensionStr == "language" && ps.m.pageConfig.TranslationKey != "" {
+			// translationKey set by user.
+			// This is an old construct back from when languages were introduced.
+			// We keep it for backward compatibility.
+			// ALso see AllTranslations.
+			pas, _ := ps.s.h.translationKeyPages.Get(ps.m.pageConfig.TranslationKey)
+			pasc := slices.Clone(pas)
+			page.SortByLanguage(pasc)
+			return pasc, nil
+		}
+
 		pas = pagePredicates.ShouldLink.Filter(pas)
 		page.SortByDims(pas)
 		return pas, nil
@@ -858,7 +868,6 @@ func (ps *pageState) posOffset(offset int) text.Position {
 // shiftToOutputFormat is serialized. The output format idx refers to the
 // full set of output formats for all sites.
 // This is serialized.
-// TODO1 with the added dimensions, we need to compress the pageOutputs slice.
 func (ps *pageState) shiftToOutputFormat(isRenderingSite bool, idx int) error {
 	if err := ps.initPage(); err != nil {
 		return err

hugolib/page__paths.go

@@ -15,6 +15,7 @@ package hugolib
 
 import (
 	"net/url"
+	"path"
 	"strings"
 
 	"github.com/gohugoio/hugo/output"
@@ -185,11 +186,7 @@ func createTargetPathDescriptor(p *pageState) (page.TargetPathDescriptor, error)
 
 	if opath != "" {
 		opath, _ = url.QueryUnescape(opath)
-		if strings.HasSuffix(opath, "//") {
-			// When rewriting the _index of the section the permalink config is applied to,
-			// we get double slashes at the end sometimes; clear them up here
-			opath = strings.TrimSuffix(opath, "/")
-		}
+		opath = path.Clean(opath)
 
 		desc.ExpandedPermalink = opath
 

hugolib/page_test.go

@@ -1403,6 +1403,41 @@ Resources: {{ range .Resources }}{{ .RelPermalink }}|{{ .Content }}|{{ end }}|
 	)
 }
 
+func TestTranslationKeyRotate(t *testing.T) {
+	t.Parallel()
+
+	files := `
+-- hugo.toml --
+disableKinds = ['home','rss','section','sitemap','taxonomy']
+defaultContentLanguage = 'en'
+defaultContentLanguageInSubdir = true
+[languages]
+[languages.en]
+weight = 1
+[languages.pt]
+weight = 2
+-- content/foo.md --
+---
+title: Foo
+translationkey: "mykey"
+---
+-- content/bar.md --
+---
+title: Bar
+translationkey: "mykey"
+---
+-- layouts/all.html --
+Rotate(language): {{ with .Rotate "language" }}{{ range . }}{{ template "printp" . }}|{{ end }}{{ end }}$
+{{ define "printp" }}{{ .RelPermalink }}:{{ with .Site }}{{ template "prints" . }}{{ end }}{{ end }}
+{{ define "prints" }}/l:{{ .Language.Name }}/v:{{ .Version.Name }}/r:{{ .Role.Name }}{{ end }}
+`
+
+	b := Test(t, files)
+
+	b.AssertFileContent("public/en/foo/index.html", "Rotate(language): /en/bar/:/l:en/v:v1/r:guest|/en/foo/:/l:en/v:v1/r:guest|$")
+	b.AssertFileContent("public/en/bar/index.html", "Rotate(language): /en/bar/:/l:en/v:v1/r:guest|/en/foo/:/l:en/v:v1/r:guest|$")
+}
+
 func TestChompBOM(t *testing.T) {
 	t.Parallel()
 	c := qt.New(t)

hugolib/segments/segments.go

@@ -151,7 +151,7 @@ func (s *segmentsBuilder) buildOne(f []SegmentMatcherFields) (predicate.PR[Segme
 			}
 		}
 		if fields.Lang != "" {
-			hugo.DeprecateWithLogger("config segments.[...]lang ", "Use sites.matrix instead, see https://gohugo.io/configuration/segments/#segment-definition", "v0.152.0", s.logger.Logger())
+			hugo.DeprecateWithLogger("config segments.[...]lang ", "Use sites.matrix instead, see https://gohugo.io/configuration/segments/#segment-definition", "v0.153.0", s.logger.Logger())
 			fields.Sites.Matrix.Languages = []string{fields.Lang}
 		}
 		if !fields.Sites.Matrix.IsZero() {

hugolib/site.go

@@ -523,9 +523,8 @@ func newHugoSites(
 						tplimpl.StoreOptions{
 							Fs:                     s.BaseFs.Layouts.Fs,
 							Log:                    s.Log,
-							DefaultContentLanguage: s.Conf.DefaultContentLanguage(),
 							Watching:               s.Conf.Watching(),
-							PathHandler:            s.Conf.PathParser(),
+							PathParser:             s.Conf.PathParser(),
 							Metrics:                d.Metrics,
 							OutputFormats:          s.conf.OutputFormats.Config,
 							MediaTypes:             s.conf.MediaTypes.Config,

modules/collect.go

@@ -531,7 +531,7 @@ LOOP:
 		}
 	}
 
-	config, err := decodeConfig(tc.cfg, c.moduleConfig.replacementsMap)
+	config, err := decodeConfig(c.logger.Logger(), tc.cfg, c.moduleConfig.replacementsMap)
 	if err != nil {
 		return err
 	}
@@ -796,7 +796,7 @@ func (c *collector) normalizeMounts(owner *moduleAdapter, mounts []Mount) ([]Mou
 			return nil, fmt.Errorf("%s: mount target must be one of: %v", errMsg, files.ComponentFolders)
 		}
 
-		if err := mnt.init(); err != nil {
+		if err := mnt.init(c.logger.Logger()); err != nil {
 			return nil, fmt.Errorf("%s: %w", errMsg, err)
 		}
 

modules/config.go

@@ -20,6 +20,7 @@ import (
 	"slices"
 	"strings"
 
+	"github.com/bep/logg"
 	"github.com/gohugoio/hugo/common/hstrings"
 	"github.com/gohugoio/hugo/common/hugo"
 	"github.com/gohugoio/hugo/common/types"
@@ -63,7 +64,7 @@ var DefaultModuleConfig = Config{
 
 // ApplyProjectConfigDefaults applies default/missing module configuration for
 // the main project.
-func ApplyProjectConfigDefaults(mod Module, cfgs ...config.AllProvider) error {
+func ApplyProjectConfigDefaults(logger logg.Logger, mod Module, cfgs ...config.AllProvider) error {
 	moda := mod.(*moduleAdapter)
 
 	// To bridge between old and new configuration format we need
@@ -157,7 +158,7 @@ func ApplyProjectConfigDefaults(mod Module, cfgs ...config.AllProvider) error {
 
 			if dir != "" {
 				mnt := Mount{Lang: lang, Source: dir, Target: component}
-				if err := mnt.init(); err != nil {
+				if err := mnt.init(logger); err != nil {
 					return fmt.Errorf("failed to init mount %q %d: %w", lang, i, err)
 				}
 				mounts = append(mounts, mnt)
@@ -173,11 +174,11 @@ func ApplyProjectConfigDefaults(mod Module, cfgs ...config.AllProvider) error {
 }
 
 // DecodeConfig creates a modules Config from a given Hugo configuration.
-func DecodeConfig(cfg config.Provider) (Config, error) {
-	return decodeConfig(cfg, nil)
+func DecodeConfig(logger logg.Logger, cfg config.Provider) (Config, error) {
+	return decodeConfig(logger, cfg, nil)
 }
 
-func decodeConfig(cfg config.Provider, pathReplacements map[string]string) (Config, error) {
+func decodeConfig(logger logg.Logger, cfg config.Provider, pathReplacements map[string]string) (Config, error) {
 	c := DefaultModuleConfig
 	c.replacementsMap = pathReplacements
 
@@ -228,7 +229,7 @@ func decodeConfig(cfg config.Provider, pathReplacements map[string]string) (Conf
 		for i, mnt := range c.Mounts {
 			mnt.Source = filepath.Clean(mnt.Source)
 			mnt.Target = filepath.Clean(mnt.Target)
-			if err := mnt.init(); err != nil {
+			if err := mnt.init(logger); err != nil {
 				return c, fmt.Errorf("failed to init mount %d: %w", i, err)
 			}
 			c.Mounts[i] = mnt
@@ -492,11 +493,13 @@ func (m Mount) ComponentAndName() (string, string) {
 	return c, n
 }
 
-func (m *Mount) init() error {
+func (m *Mount) init(logger logg.Logger) error {
 	if m.Lang != "" {
 		// We moved this to a more flixeble setup in Hugo 0.148.0.
 		m.Sites.Matrix.Languages = append(m.Sites.Matrix.Languages, m.Lang)
-		m.Lang = "" // TODO1 deprecate.
+		m.Lang = ""
+
+		hugo.DeprecateWithLogger("module.mounts.lang", "Replaced by the more powerful 'sites.matrix' setting, see https://gohugo.io/configuration/module/#mounts", "v0.153.0", logger)
 	}
 
 	if len(m.Sites.Matrix.Languages) == 0 {