aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJoe Mooring <[email protected]>2023-12-03 11:06:33 -0800
committerBjørn Erik Pedersen <[email protected]>2023-12-04 11:39:27 +0100
commitd24da1712f2e5b4caeb3349d4e5d3c6cec09c6fe (patch)
tree2bc48e4bab0e676e093a3a07052c43dd92e9213e
parent4583b4130516dfc97c13b2336740e333bcca66de (diff)
downloadhugo-d24da1712f2e5b4caeb3349d4e5d3c6cec09c6fe.tar.gz
hugo-d24da1712f2e5b4caeb3349d4e5d3c6cec09c6fe.zip
tpl/fmt: Print suppression help with erroridf
Closes #11506
-rw-r--r--tpl/fmt/fmt.go2
-rw-r--r--tpl/fmt/integration_test.go45
2 files changed, 47 insertions, 0 deletions
diff --git a/tpl/fmt/fmt.go b/tpl/fmt/fmt.go
index c0d75e425..4f18758e0 100644
--- a/tpl/fmt/fmt.go
+++ b/tpl/fmt/fmt.go
@@ -68,6 +68,8 @@ func (ns *Namespace) Errorf(format string, args ...any) string {
// an information text that the error with the given id can be suppressed in config.
// It returns an empty string.
func (ns *Namespace) Erroridf(id, format string, args ...any) string {
+ format += "\nYou can suppress this error by adding the following to your site configuration:\nignoreErrors = ['%s']"
+ args = append(args, id)
ns.logger.Errorsf(id, format, args...)
return ""
}
diff --git a/tpl/fmt/integration_test.go b/tpl/fmt/integration_test.go
new file mode 100644
index 000000000..5010fa90e
--- /dev/null
+++ b/tpl/fmt/integration_test.go
@@ -0,0 +1,45 @@
+// Copyright 2023 The Hugo Authors. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package fmt_test
+
+import (
+ "testing"
+
+ "github.com/gohugoio/hugo/hugolib"
+)
+
+// Issue #11506
+func TestErroridf(t *testing.T) {
+ t.Parallel()
+
+ files := `
+-- hugo.toml --
+disableKinds = ['page','rss','section','sitemap','taxonomy','term']
+ignoreErrors = ['error-b']
+-- layouts/index.html --
+{{ erroridf "error-a" "%s" "a"}}
+{{ erroridf "error-b" "%s" "b"}}
+ `
+
+ b := hugolib.NewIntegrationTestBuilder(
+ hugolib.IntegrationTestConfig{
+ T: t,
+ TxtarString: files,
+ },
+ )
+
+ b.BuildE()
+ b.AssertLogMatches(`^ERROR a\nYou can suppress this error by adding the following to your site configuration:\nignoreErrors = \['error-a'\]\n$`)
+
+}