After this commit, if you want to resolve `layouts/_shortcodes/myshortcode.txt` when rendering HTML content, you need to use the `{{%` shortcode delimiter:
```
{{% myshortcode %}}
```
This should be what people would do anyway, but we have also as part of this improved the error message to inform about what needs to be done.
Note that this is not relevant for partials.
Fixes #13698
return true
}
base, layoutDescriptor := po.GetInternalTemplateBasePathAndDescriptor()
+
+ // With shortcodes/mymarkdown.md (only), this allows {{% mymarkdown %}} when rendering HTML,
+ // but will not resolve any template when doing {{< mymarkdown >}}.
+ layoutDescriptor.AlwaysAllowPlainText = sc.doMarkup
q := tplimpl.TemplateQuery{
Path: base,
Name: sc.name,
Desc: layoutDescriptor,
Consider: include,
}
- v := s.TemplateStore.LookupShortcode(q)
+ v, err := s.TemplateStore.LookupShortcode(q)
if v == nil {
- s.Log.Errorf("Unable to locate template for shortcode %q in page %q", sc.name, p.File().Path())
- return zeroShortcode, nil
+ return zeroShortcode, err
}
tmpl = v
hasVariants = hasVariants || len(ofCount) > 1
---
title: "p1"
---
-{{< foo >}}
+{{% foo %}}
# The below would have failed using the HTML template parser.
-- layouts/shortcodes/foo.md --
§§§
b := Test(t, files)
- b.AssertFileContent("public/p1/index.html", `
-<x
- `)
+ b.AssertFileContent("public/p1/index.html", "<code><x")
}
func TestShortcodePreserveIndentation(t *testing.T) {
"strings"
"testing"
+ qt "github.com/frankban/quicktest"
"github.com/gohugoio/hugo/htesting/hqt"
"github.com/gohugoio/hugo/hugolib"
)
b.AssertFileContent("public/p1/index.html", "78eb19b5c6f3768f")
b.AssertFileContent("public/p2/index.html", "a6db910a9cf54bc1")
}
+
+func TestShortcodePlainTextVsHTMLTemplateIssue13698(t *testing.T) {
+ t.Parallel()
+
+ filesTemplate := `
+-- hugo.toml --
+markup.goldmark.renderer.unsafe = true
+-- layouts/all.html --
+Content: {{ .Content }}|
+-- layouts/_shortcodes/mymarkdown.md --
+<div>Foo bar</div>
+-- content/p1.md --
+---
+title: p1
+---
+## A shortcode
+
+SHORTCODE
+
+`
+
+ files := strings.ReplaceAll(filesTemplate, "SHORTCODE", "{{% mymarkdown %}}")
+ b := hugolib.Test(t, files)
+ b.AssertFileContent("public/p1/index.html", "<div>Foo bar</div>")
+
+ files = strings.ReplaceAll(filesTemplate, "SHORTCODE", "{{< mymarkdown >}}")
+
+ var err error
+ b, err = hugolib.TestE(t, files)
+ b.Assert(err, qt.IsNotNil)
+ b.Assert(err.Error(), qt.Contains, `no compatible template found for shortcode "mymarkdown" in [/_shortcodes/mymarkdown.md]; note that to use plain text template shortcodes in HTML you need to use the shortcode {{% delimiter`)
+}
// Misc.
LayoutFromUserMustMatch bool // If set, we only look for the exact layout.
IsPlainText bool // Whether this is a plain text template.
+ AlwaysAllowPlainText bool // Whether to e.g. allow plain text templates to be rendered in HTML.
}
func (d *TemplateDescriptor) normalizeFromFile() {
return weightNoMatch
}
- w := this.doCompare(category, isEmbedded, s.opts.DefaultContentLanguage, other)
+ w := this.doCompare(category, s.opts.DefaultContentLanguage, other)
if w.w1 <= 0 {
if category == CategoryMarkup && (this.Variant1 == other.Variant1) && (this.Variant2 == other.Variant2 || this.Variant2 != "" && other.Variant2 == "") {
}
w.w1 = 1
- return w
+ }
+
+ if category == CategoryShortcode {
+ if (this.IsPlainText == other.IsPlainText || !other.IsPlainText) || this.AlwaysAllowPlainText {
+ w.w1 = 1
+ }
}
}
}
//lint:ignore ST1006 this vs other makes it easier to reason about.
-func (this TemplateDescriptor) doCompare(category Category, isEmbedded bool, defaultContentLanguage string, other TemplateDescriptor) weight {
+func (this TemplateDescriptor) doCompare(category Category, defaultContentLanguage string, other TemplateDescriptor) weight {
w := weightNoMatch
- // HTML in plain text is OK, but not the other way around.
- if other.IsPlainText && !this.IsPlainText {
- return w
+ if !this.AlwaysAllowPlainText {
+ // HTML in plain text is OK, but not the other way around.
+ if other.IsPlainText && !this.IsPlainText {
+ return w
+ }
}
+
if other.Kind != "" && other.Kind != this.Kind {
return w
}
"bytes"
"context"
"embed"
+ "errors"
"fmt"
"io"
"io/fs"
return ti
}
-func (s *TemplateStore) LookupShortcode(q TemplateQuery) *TemplInfo {
+func (s *TemplateStore) LookupShortcode(q TemplateQuery) (*TemplInfo, error) {
q.init()
k1 := s.key(q.Path)
}
for k, vv := range v {
+ best.candidates = append(best.candidates, vv)
if !q.Consider(vv) {
continue
}
weight := s.dh.compareDescriptors(q.Category, vv.subCategory == SubCategoryEmbedded, q.Desc, k)
weight.distance = distance
- if best.isBetter(weight, vv) {
+ isBetter := best.isBetter(weight, vv)
+ if isBetter {
best.updateValues(weight, k2, k, vv)
}
}
return false, nil
})
- // Any match will do.
- return best.templ
+ if best.w.w1 <= 0 {
+ var err error
+ if s := best.candidatesAsStringSlice(); s != nil {
+ msg := fmt.Sprintf("no compatible template found for shortcode %q in %s", q.Name, s)
+ if !q.Desc.IsPlainText {
+ msg += "; note that to use plain text template shortcodes in HTML you need to use the shortcode {{% delimiter"
+ }
+ err = errors.New(msg)
+ } else {
+ err = fmt.Errorf("no template found for shortcode %q", q.Name)
+ }
+ return nil, err
+ }
+
+ return best.templ, nil
}
// PrintDebug is for testing/debugging only.
}
type bestMatch struct {
- templ *TemplInfo
- desc TemplateDescriptor
- w weight
- key string
+ templ *TemplInfo
+ desc TemplateDescriptor
+ w weight
+ key string
+ candidates []*TemplInfo
// settings.
defaultOutputformat string
best.w = weight{}
best.desc = TemplateDescriptor{}
best.key = ""
+ best.candidates = nil
+}
+
+func (best *bestMatch) candidatesAsStringSlice() []string {
+ if len(best.candidates) == 0 {
+ return nil
+ }
+ candidates := make([]string, len(best.candidates))
+ for i, v := range best.candidates {
+ candidates[i] = v.PathInfo.Path()
+ }
+ return candidates
}
func (best *bestMatch) isBetter(w weight, ti *TemplInfo) bool {
}
if w.w1 <= 0 {
-
if best.w.w1 <= 0 {
return ti.PathInfo.Path() < best.templ.PathInfo.Path()
}
b.AssertFileContent("public/index.html", "<link rel=\"stylesheet\" href=\"/css/style.css\">")
}
+func TestPartialPlainTextInHTML(t *testing.T) {
+ t.Parallel()
+
+ files := `
+-- hugo.toml --
+-- layouts/all.html --
+<html>
+<head>
+{{ partial "mypartial.txt" . }}
+</head>
+</html>
+-- layouts/partials/mypartial.txt --
+My <div>partial</div>.
+`
+
+ b := hugolib.Test(t, files)
+
+ b.AssertFileContent("public/index.html", "My <div>partial</div>.")
+}
+
// Issue #13593.
func TestGoatAndNoGoat(t *testing.T) {
t.Parallel()
b.AssertLogContains("unrecognized render hook")
}
+func TestLayoutNotFound(t *testing.T) {
+ t.Parallel()
+
+ files := `
+-- hugo.toml --
+-- layouts/single.html --
+Single.
+`
+ b := hugolib.Test(t, files, hugolib.TestOptWarn())
+ b.AssertLogContains("WARN found no layout file for \"html\" for kind \"home\"")
+}
+
func TestLayoutOverrideThemeWhenThemeOnOldFormatIssue13715(t *testing.T) {
t.Parallel()
Category: tplimpl.CategoryShortcode,
Desc: desc,
}
- v := store.LookupShortcode(q)
- if v == nil {
+ v, err := store.LookupShortcode(q)
+ if v == nil || err != nil {
b.Fatal("not found")
}
}
projects / brevno-suite / hugo / commitdiff