Emit a warning that can be turned off when overwriting built-in .Params values - hugo - [fork] hugo port for 9front
HTML git clone git@git.drkhsh.at/hugo.git
DIR Log
DIR Files
DIR Refs
DIR Submodules
DIR README
DIR LICENSE
---
DIR commit afee781f03df4305698bf4b6991cd10e996515c5
DIR parent 4e84f57efb57f5c8a850e4c1d562a0bcc7bd1700
HTML Author: Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Date: Tue, 30 Jan 2024 10:07:28 +0100
Emit a warning that can be turned off when overwriting built-in .Params values
Fixes #11941
Diffstat:
M common/constants/constants.go | 4 +++-
M hugolib/page__meta.go | 4 ++++
M hugolib/params_test.go | 22 ++++++++++++++++++++++
3 files changed, 29 insertions(+), 1 deletion(-)
---
DIR diff --git a/common/constants/constants.go b/common/constants/constants.go
@@ -13,12 +13,14 @@
package constants
-// Error IDs.
+// Error/Warning IDs.
// Do not change these values.
const (
// IDs for remote errors in tpl/data.
ErrRemoteGetJSON = "error-remote-getjson"
ErrRemoteGetCSV = "error-remote-getcsv"
+
+ WarnFrontMatterParamsOverrides = "warning-frontmatter-params-overrides"
)
// Field/method names with special meaning.
DIR diff --git a/hugolib/page__meta.go b/hugolib/page__meta.go
@@ -31,6 +31,7 @@ import (
"github.com/gohugoio/hugo/source"
+ "github.com/gohugoio/hugo/common/constants"
"github.com/gohugoio/hugo/common/hugo"
"github.com/gohugoio/hugo/common/maps"
"github.com/gohugoio/hugo/common/paths"
@@ -621,6 +622,9 @@ func (p *pageState) setMetaPostParams() error {
}
for k, v := range userParams {
+ if _, found := params[k]; found {
+ p.s.Log.Warnidf(constants.WarnFrontMatterParamsOverrides, "Hugo front matter key %q is overridden in params section.", k)
+ }
params[strings.ToLower(k)] = v
}
DIR diff --git a/hugolib/params_test.go b/hugolib/params_test.go
@@ -133,6 +133,28 @@ RegularPages: {{ range site.RegularPages }}{{ .Path }}|{{ .RelPermalink }}|{{ .T
)
}
+func TestFrontMatterTitleOverrideWarn(t *testing.T) {
+ t.Parallel()
+
+ files := `
+-- hugo.toml --
+baseURL = "https://example.org/"
+disableKinds = ["taxonomy", "term"]
+-- content/p1.md --
+---
+title: "My title"
+params:
+ title: "My title from params"
+---
+
+
+`
+
+ b := Test(t, files, TestOptWarn())
+
+ b.AssertLogContains("ARN Hugo front matter key \"title\" is overridden in params section", "You can suppress this warning")
+}
+
func TestFrontMatterParamsLangNoCascade(t *testing.T) {
t.Parallel()