Reimplement and simplify Hugo's template system

See #13541 for details.

Fixes #13545
Fixes #13515
Closes #7964
Closes #13365
Closes #12988
Closes #4891
This commit is contained in:
Bjørn Erik Pedersen
2025-04-06 19:55:35 +02:00
parent 812ea0b325
commit 83cfdd78ca
138 changed files with 5342 additions and 4396 deletions

View File

@@ -1,12 +1,10 @@
package output
import (
"strings"
// "fmt"
"github.com/gohugoio/hugo/docshelper"
"github.com/gohugoio/hugo/output/layouts"
)
// This is is just some helpers used to create some JSON used in the Hugo docs.
@@ -14,90 +12,12 @@ func init() {
docsProvider := func() docshelper.DocProvider {
return docshelper.DocProvider{
"output": map[string]any{
"layouts": createLayoutExamples(),
// TODO(bep), maybe revisit this later, but I hope this isn't needed.
// "layouts": createLayoutExamples(),
"layouts": map[string]any{},
},
}
}
docshelper.AddDocProviderFunc(docsProvider)
}
func createLayoutExamples() any {
type Example struct {
Example string
Kind string
OutputFormat string
Suffix string
Layouts []string `json:"Template Lookup Order"`
}
var (
basicExamples []Example
demoLayout = "demolayout"
demoType = "demotype"
)
for _, example := range []struct {
name string
d layouts.LayoutDescriptor
}{
// Taxonomy layouts.LayoutDescriptor={categories category taxonomy en false Type Section
{"Single page in \"posts\" section", layouts.LayoutDescriptor{Kind: "page", Type: "posts", OutputFormatName: "html", Suffix: "html"}},
{"Base template for single page in \"posts\" section", layouts.LayoutDescriptor{Baseof: true, Kind: "page", Type: "posts", OutputFormatName: "html", Suffix: "html"}},
{"Single page in \"posts\" section with layout set to \"demolayout\"", layouts.LayoutDescriptor{Kind: "page", Type: "posts", Layout: demoLayout, OutputFormatName: "html", Suffix: "html"}},
{"Base template for single page in \"posts\" section with layout set to \"demolayout\"", layouts.LayoutDescriptor{Baseof: true, Kind: "page", Type: "posts", Layout: demoLayout, OutputFormatName: "html", Suffix: "html"}},
{"AMP single page in \"posts\" section", layouts.LayoutDescriptor{Kind: "page", Type: "posts", OutputFormatName: "amp", Suffix: "html"}},
{"AMP single page in \"posts\" section, French language", layouts.LayoutDescriptor{Kind: "page", Type: "posts", Lang: "fr", OutputFormatName: "amp", Suffix: "html"}},
// Typeless pages get "page" as type
{"Home page", layouts.LayoutDescriptor{Kind: "home", Type: "page", OutputFormatName: "html", Suffix: "html"}},
{"Base template for home page", layouts.LayoutDescriptor{Baseof: true, Kind: "home", Type: "page", OutputFormatName: "html", Suffix: "html"}},
{"Home page with type set to \"demotype\"", layouts.LayoutDescriptor{Kind: "home", Type: demoType, OutputFormatName: "html", Suffix: "html"}},
{"Base template for home page with type set to \"demotype\"", layouts.LayoutDescriptor{Baseof: true, Kind: "home", Type: demoType, OutputFormatName: "html", Suffix: "html"}},
{"Home page with layout set to \"demolayout\"", layouts.LayoutDescriptor{Kind: "home", Type: "page", Layout: demoLayout, OutputFormatName: "html", Suffix: "html"}},
{"AMP home, French language", layouts.LayoutDescriptor{Kind: "home", Type: "page", Lang: "fr", OutputFormatName: "amp", Suffix: "html"}},
{"JSON home", layouts.LayoutDescriptor{Kind: "home", Type: "page", OutputFormatName: "json", Suffix: "json"}},
{"RSS home", layouts.LayoutDescriptor{Kind: "home", Type: "page", OutputFormatName: "rss", Suffix: "xml"}},
{"Section list for \"posts\"", layouts.LayoutDescriptor{Kind: "section", Type: "posts", Section: "posts", OutputFormatName: "html", Suffix: "html"}},
{"Section list for \"posts\" with type set to \"blog\"", layouts.LayoutDescriptor{Kind: "section", Type: "blog", Section: "posts", OutputFormatName: "html", Suffix: "html"}},
{"Section list for \"posts\" with layout set to \"demolayout\"", layouts.LayoutDescriptor{Kind: "section", Layout: demoLayout, Section: "posts", OutputFormatName: "html", Suffix: "html"}},
{"Section list for \"posts\"", layouts.LayoutDescriptor{Kind: "section", Type: "posts", OutputFormatName: "rss", Suffix: "xml"}},
{"Taxonomy list for \"categories\"", layouts.LayoutDescriptor{Kind: "taxonomy", Type: "categories", Section: "category", OutputFormatName: "html", Suffix: "html"}},
{"Taxonomy list for \"categories\"", layouts.LayoutDescriptor{Kind: "taxonomy", Type: "categories", Section: "category", OutputFormatName: "rss", Suffix: "xml"}},
{"Term list for \"categories\"", layouts.LayoutDescriptor{Kind: "term", Type: "categories", Section: "category", OutputFormatName: "html", Suffix: "html"}},
{"Term list for \"categories\"", layouts.LayoutDescriptor{Kind: "term", Type: "categories", Section: "category", OutputFormatName: "rss", Suffix: "xml"}},
} {
l := layouts.NewLayoutHandler()
layouts, _ := l.For(example.d)
basicExamples = append(basicExamples, Example{
Example: example.name,
Kind: example.d.Kind,
OutputFormat: example.d.OutputFormatName,
Suffix: example.d.Suffix,
Layouts: makeLayoutsPresentable(layouts),
})
}
return basicExamples
}
func makeLayoutsPresentable(l []string) []string {
var filtered []string
for _, ll := range l {
if strings.Contains(ll, "page/") {
// This is a valid lookup, but it's more confusing than useful.
continue
}
ll = "layouts/" + strings.TrimPrefix(ll, "_text/")
if !strings.Contains(ll, "indexes") {
filtered = append(filtered, ll)
}
}
return filtered
}

View File

@@ -1,336 +0,0 @@
// Copyright 2024 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 layouts
import (
"strings"
"sync"
)
// These may be used as content sections with potential conflicts. Avoid that.
var reservedSections = map[string]bool{
"shortcodes": true,
"partials": true,
}
// LayoutDescriptor describes how a layout should be chosen. This is
// typically built from a Page.
type LayoutDescriptor struct {
Type string
Section string
// E.g. "page", but also used for the _markup render kinds, e.g. "render-image".
Kind string
// Comma-separated list of kind variants, e.g. "go,json" as variants which would find "render-codeblock-go.html"
KindVariants string
Lang string
Layout string
// LayoutOverride indicates what we should only look for the above layout.
LayoutOverride bool
// From OutputFormat and MediaType.
OutputFormatName string
Suffix string
RenderingHook bool
Baseof bool
}
func (d LayoutDescriptor) isList() bool {
return !d.RenderingHook && d.Kind != "page" && d.Kind != "404" && d.Kind != "sitemap" && d.Kind != "sitemapindex"
}
// LayoutHandler calculates the layout template to use to render a given output type.
type LayoutHandler struct {
mu sync.RWMutex
cache map[LayoutDescriptor][]string
}
// NewLayoutHandler creates a new LayoutHandler.
func NewLayoutHandler() *LayoutHandler {
return &LayoutHandler{cache: make(map[LayoutDescriptor][]string)}
}
// For returns a layout for the given LayoutDescriptor and options.
// Layouts are rendered and cached internally.
func (l *LayoutHandler) For(d LayoutDescriptor) ([]string, error) {
// We will get lots of requests for the same layouts, so avoid recalculations.
l.mu.RLock()
if cacheVal, found := l.cache[d]; found {
l.mu.RUnlock()
return cacheVal, nil
}
l.mu.RUnlock()
layouts := resolvePageTemplate(d)
layouts = uniqueStringsReuse(layouts)
l.mu.Lock()
l.cache[d] = layouts
l.mu.Unlock()
return layouts, nil
}
type layoutBuilder struct {
layoutVariations []string
typeVariations []string
d LayoutDescriptor
// f Format
}
func (l *layoutBuilder) addLayoutVariations(vars ...string) {
for _, layoutVar := range vars {
if l.d.Baseof && layoutVar != "baseof" {
l.layoutVariations = append(l.layoutVariations, layoutVar+"-baseof")
continue
}
if !l.d.RenderingHook && !l.d.Baseof && l.d.LayoutOverride && layoutVar != l.d.Layout {
continue
}
l.layoutVariations = append(l.layoutVariations, layoutVar)
}
}
func (l *layoutBuilder) addTypeVariations(vars ...string) {
for _, typeVar := range vars {
if !reservedSections[typeVar] {
if l.d.RenderingHook {
typeVar = typeVar + renderingHookRoot
}
l.typeVariations = append(l.typeVariations, typeVar)
}
}
}
func (l *layoutBuilder) addSectionType() {
if l.d.Section != "" {
l.addTypeVariations(l.d.Section)
}
}
func (l *layoutBuilder) addKind() {
l.addLayoutVariations(l.d.Kind)
l.addTypeVariations(l.d.Kind)
}
const renderingHookRoot = "/_markup"
func resolvePageTemplate(d LayoutDescriptor) []string {
b := &layoutBuilder{d: d}
if !d.RenderingHook && d.Layout != "" {
b.addLayoutVariations(d.Layout)
}
if d.Type != "" {
b.addTypeVariations(d.Type)
}
if d.RenderingHook {
if d.KindVariants != "" {
// Add the more specific variants first.
for _, variant := range strings.Split(d.KindVariants, ",") {
b.addLayoutVariations(d.Kind + "-" + variant)
}
}
b.addLayoutVariations(d.Kind)
b.addSectionType()
}
switch d.Kind {
case "page":
b.addLayoutVariations("single")
b.addSectionType()
case "home":
b.addLayoutVariations("index", "home")
// Also look in the root
b.addTypeVariations("")
case "section":
if d.Section != "" {
b.addLayoutVariations(d.Section)
}
b.addSectionType()
b.addKind()
case "term":
b.addKind()
if d.Section != "" {
b.addLayoutVariations(d.Section)
}
b.addLayoutVariations("taxonomy")
b.addTypeVariations("taxonomy")
b.addSectionType()
case "taxonomy":
if d.Section != "" {
b.addLayoutVariations(d.Section + ".terms")
}
b.addSectionType()
b.addLayoutVariations("terms")
// For legacy reasons this is deliberately put last.
b.addKind()
case "404":
b.addLayoutVariations("404")
b.addTypeVariations("")
case "robotstxt":
b.addLayoutVariations("robots")
b.addTypeVariations("")
case "sitemap":
b.addLayoutVariations("sitemap")
b.addTypeVariations("")
case "sitemapindex":
b.addLayoutVariations("sitemapindex")
b.addTypeVariations("")
}
isRSS := d.OutputFormatName == "rss"
if !d.RenderingHook && !d.Baseof && isRSS {
// The historic and common rss.xml case
b.addLayoutVariations("")
}
if d.Baseof || d.Kind != "404" {
// Most have _default in their lookup path
b.addTypeVariations("_default")
}
if d.isList() {
// Add the common list type
b.addLayoutVariations("list")
}
if d.Baseof {
b.addLayoutVariations("baseof")
}
layouts := b.resolveVariations()
if !d.RenderingHook && !d.Baseof && isRSS {
layouts = append(layouts, "_internal/_default/rss.xml")
}
switch d.Kind {
case "robotstxt":
layouts = append(layouts, "_internal/_default/robots.txt")
case "sitemap":
layouts = append(layouts, "_internal/_default/sitemap.xml")
case "sitemapindex":
layouts = append(layouts, "_internal/_default/sitemapindex.xml")
}
return layouts
}
func (l *layoutBuilder) resolveVariations() []string {
var layouts []string
var variations []string
name := strings.ToLower(l.d.OutputFormatName)
if l.d.Lang != "" {
// We prefer the most specific type before language.
variations = append(variations, []string{l.d.Lang + "." + name, name, l.d.Lang}...)
} else {
variations = append(variations, name)
}
variations = append(variations, "")
for _, typeVar := range l.typeVariations {
for _, variation := range variations {
for _, layoutVar := range l.layoutVariations {
if variation == "" && layoutVar == "" {
continue
}
s := constructLayoutPath(typeVar, layoutVar, variation, l.d.Suffix)
if s != "" {
layouts = append(layouts, s)
}
}
}
}
return layouts
}
// constructLayoutPath constructs a layout path given a type, layout,
// variations, and extension. The path constructed follows the pattern of
// type/layout.variations.extension. If any value is empty, it will be left out
// of the path construction.
//
// Path construction requires at least 2 of 3 out of layout, variations, and extension.
// If more than one of those is empty, an empty string is returned.
func constructLayoutPath(typ, layout, variations, extension string) string {
// we already know that layout and variations are not both empty because of
// checks in resolveVariants().
if extension == "" && (layout == "" || variations == "") {
return ""
}
// Commence valid path construction...
var (
p strings.Builder
needDot bool
)
if typ != "" {
p.WriteString(typ)
p.WriteString("/")
}
if layout != "" {
p.WriteString(layout)
needDot = true
}
if variations != "" {
if needDot {
p.WriteString(".")
}
p.WriteString(variations)
needDot = true
}
if extension != "" {
if needDot {
p.WriteString(".")
}
p.WriteString(extension)
}
return p.String()
}
// Inline this here so we can use tinygo to compile a wasm binary of this package.
func uniqueStringsReuse(s []string) []string {
result := s[:0]
for i, val := range s {
var seen bool
for j := range i {
if s[j] == val {
seen = true
break
}
}
if !seen {
result = append(result, val)
}
}
return result
}

View File

@@ -1,982 +0,0 @@
// Copyright 2017-present 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 layouts
import (
"fmt"
"reflect"
"strings"
"testing"
qt "github.com/frankban/quicktest"
"github.com/kylelemons/godebug/diff"
)
func TestLayout(t *testing.T) {
c := qt.New(t)
for _, this := range []struct {
name string
layoutDescriptor LayoutDescriptor
layoutOverride string
expect []string
}{
{
"Home",
LayoutDescriptor{Kind: "home", OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"index.amp.html",
"home.amp.html",
"list.amp.html",
"index.html",
"home.html",
"list.html",
"_default/index.amp.html",
"_default/home.amp.html",
"_default/list.amp.html",
"_default/index.html",
"_default/home.html",
"_default/list.html",
},
},
{
"Home baseof",
LayoutDescriptor{Kind: "home", Baseof: true, OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"index-baseof.amp.html",
"home-baseof.amp.html",
"list-baseof.amp.html",
"baseof.amp.html",
"index-baseof.html",
"home-baseof.html",
"list-baseof.html",
"baseof.html",
"_default/index-baseof.amp.html",
"_default/home-baseof.amp.html",
"_default/list-baseof.amp.html",
"_default/baseof.amp.html",
"_default/index-baseof.html",
"_default/home-baseof.html",
"_default/list-baseof.html",
"_default/baseof.html",
},
},
{
"Home, HTML",
LayoutDescriptor{Kind: "home", OutputFormatName: "html", Suffix: "html"},
"",
// We will eventually get to index.html. This looks stuttery, but makes the lookup logic easy to understand.
[]string{
"index.html.html",
"home.html.html",
"list.html.html",
"index.html",
"home.html",
"list.html",
"_default/index.html.html",
"_default/home.html.html",
"_default/list.html.html",
"_default/index.html",
"_default/home.html",
"_default/list.html",
},
},
{
"Home, HTML, baseof",
LayoutDescriptor{Kind: "home", Baseof: true, OutputFormatName: "html", Suffix: "html"},
"",
[]string{
"index-baseof.html.html",
"home-baseof.html.html",
"list-baseof.html.html",
"baseof.html.html",
"index-baseof.html",
"home-baseof.html",
"list-baseof.html",
"baseof.html",
"_default/index-baseof.html.html",
"_default/home-baseof.html.html",
"_default/list-baseof.html.html",
"_default/baseof.html.html",
"_default/index-baseof.html",
"_default/home-baseof.html",
"_default/list-baseof.html",
"_default/baseof.html",
},
},
{
"Home, french language",
LayoutDescriptor{Kind: "home", Lang: "fr", OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"index.fr.amp.html",
"home.fr.amp.html",
"list.fr.amp.html",
"index.amp.html",
"home.amp.html",
"list.amp.html",
"index.fr.html",
"home.fr.html",
"list.fr.html",
"index.html",
"home.html",
"list.html",
"_default/index.fr.amp.html",
"_default/home.fr.amp.html",
"_default/list.fr.amp.html",
"_default/index.amp.html",
"_default/home.amp.html",
"_default/list.amp.html",
"_default/index.fr.html",
"_default/home.fr.html",
"_default/list.fr.html",
"_default/index.html",
"_default/home.html",
"_default/list.html",
},
},
{
"Home, no ext or delim",
LayoutDescriptor{Kind: "home", OutputFormatName: "nem", Suffix: ""},
"",
[]string{
"index.nem",
"home.nem",
"list.nem",
"_default/index.nem",
"_default/home.nem",
"_default/list.nem",
},
},
{
"Home, no ext",
LayoutDescriptor{Kind: "home", OutputFormatName: "nex", Suffix: ""},
"",
[]string{
"index.nex",
"home.nex",
"list.nex",
"_default/index.nex",
"_default/home.nex",
"_default/list.nex",
},
},
{
"Page, no ext or delim",
LayoutDescriptor{Kind: "page", OutputFormatName: "nem", Suffix: ""},
"",
[]string{"_default/single.nem"},
},
{
"Section",
LayoutDescriptor{Kind: "section", Section: "sect1", OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"sect1/sect1.amp.html",
"sect1/section.amp.html",
"sect1/list.amp.html",
"sect1/sect1.html",
"sect1/section.html",
"sect1/list.html",
"section/sect1.amp.html",
"section/section.amp.html",
"section/list.amp.html",
"section/sect1.html",
"section/section.html",
"section/list.html",
"_default/sect1.amp.html",
"_default/section.amp.html",
"_default/list.amp.html",
"_default/sect1.html",
"_default/section.html",
"_default/list.html",
},
},
{
"Section, baseof",
LayoutDescriptor{Kind: "section", Section: "sect1", Baseof: true, OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"sect1/sect1-baseof.amp.html",
"sect1/section-baseof.amp.html",
"sect1/list-baseof.amp.html",
"sect1/baseof.amp.html",
"sect1/sect1-baseof.html",
"sect1/section-baseof.html",
"sect1/list-baseof.html",
"sect1/baseof.html",
"section/sect1-baseof.amp.html",
"section/section-baseof.amp.html",
"section/list-baseof.amp.html",
"section/baseof.amp.html",
"section/sect1-baseof.html",
"section/section-baseof.html",
"section/list-baseof.html",
"section/baseof.html",
"_default/sect1-baseof.amp.html",
"_default/section-baseof.amp.html",
"_default/list-baseof.amp.html",
"_default/baseof.amp.html",
"_default/sect1-baseof.html",
"_default/section-baseof.html",
"_default/list-baseof.html",
"_default/baseof.html",
},
},
{
"Section, baseof, French, AMP",
LayoutDescriptor{Kind: "section", Section: "sect1", Lang: "fr", Baseof: true, OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"sect1/sect1-baseof.fr.amp.html",
"sect1/section-baseof.fr.amp.html",
"sect1/list-baseof.fr.amp.html",
"sect1/baseof.fr.amp.html",
"sect1/sect1-baseof.amp.html",
"sect1/section-baseof.amp.html",
"sect1/list-baseof.amp.html",
"sect1/baseof.amp.html",
"sect1/sect1-baseof.fr.html",
"sect1/section-baseof.fr.html",
"sect1/list-baseof.fr.html",
"sect1/baseof.fr.html",
"sect1/sect1-baseof.html",
"sect1/section-baseof.html",
"sect1/list-baseof.html",
"sect1/baseof.html",
"section/sect1-baseof.fr.amp.html",
"section/section-baseof.fr.amp.html",
"section/list-baseof.fr.amp.html",
"section/baseof.fr.amp.html",
"section/sect1-baseof.amp.html",
"section/section-baseof.amp.html",
"section/list-baseof.amp.html",
"section/baseof.amp.html",
"section/sect1-baseof.fr.html",
"section/section-baseof.fr.html",
"section/list-baseof.fr.html",
"section/baseof.fr.html",
"section/sect1-baseof.html",
"section/section-baseof.html",
"section/list-baseof.html",
"section/baseof.html",
"_default/sect1-baseof.fr.amp.html",
"_default/section-baseof.fr.amp.html",
"_default/list-baseof.fr.amp.html",
"_default/baseof.fr.amp.html",
"_default/sect1-baseof.amp.html",
"_default/section-baseof.amp.html",
"_default/list-baseof.amp.html",
"_default/baseof.amp.html",
"_default/sect1-baseof.fr.html",
"_default/section-baseof.fr.html",
"_default/list-baseof.fr.html",
"_default/baseof.fr.html",
"_default/sect1-baseof.html",
"_default/section-baseof.html",
"_default/list-baseof.html",
"_default/baseof.html",
},
},
{
"Section with layout",
LayoutDescriptor{Kind: "section", Section: "sect1", Layout: "mylayout", OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"sect1/mylayout.amp.html",
"sect1/sect1.amp.html",
"sect1/section.amp.html",
"sect1/list.amp.html",
"sect1/mylayout.html",
"sect1/sect1.html",
"sect1/section.html",
"sect1/list.html",
"section/mylayout.amp.html",
"section/sect1.amp.html",
"section/section.amp.html",
"section/list.amp.html",
"section/mylayout.html",
"section/sect1.html",
"section/section.html",
"section/list.html",
"_default/mylayout.amp.html",
"_default/sect1.amp.html",
"_default/section.amp.html",
"_default/list.amp.html",
"_default/mylayout.html",
"_default/sect1.html",
"_default/section.html",
"_default/list.html",
},
},
{
"Term, French, AMP",
LayoutDescriptor{Kind: "term", Section: "tags", Lang: "fr", OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"term/term.fr.amp.html",
"term/tags.fr.amp.html",
"term/taxonomy.fr.amp.html",
"term/list.fr.amp.html",
"term/term.amp.html",
"term/tags.amp.html",
"term/taxonomy.amp.html",
"term/list.amp.html",
"term/term.fr.html",
"term/tags.fr.html",
"term/taxonomy.fr.html",
"term/list.fr.html",
"term/term.html",
"term/tags.html",
"term/taxonomy.html",
"term/list.html",
"taxonomy/term.fr.amp.html",
"taxonomy/tags.fr.amp.html",
"taxonomy/taxonomy.fr.amp.html",
"taxonomy/list.fr.amp.html",
"taxonomy/term.amp.html",
"taxonomy/tags.amp.html",
"taxonomy/taxonomy.amp.html",
"taxonomy/list.amp.html",
"taxonomy/term.fr.html",
"taxonomy/tags.fr.html",
"taxonomy/taxonomy.fr.html",
"taxonomy/list.fr.html",
"taxonomy/term.html",
"taxonomy/tags.html",
"taxonomy/taxonomy.html",
"taxonomy/list.html",
"tags/term.fr.amp.html",
"tags/tags.fr.amp.html",
"tags/taxonomy.fr.amp.html",
"tags/list.fr.amp.html",
"tags/term.amp.html",
"tags/tags.amp.html",
"tags/taxonomy.amp.html",
"tags/list.amp.html",
"tags/term.fr.html",
"tags/tags.fr.html",
"tags/taxonomy.fr.html",
"tags/list.fr.html",
"tags/term.html",
"tags/tags.html",
"tags/taxonomy.html",
"tags/list.html",
"_default/term.fr.amp.html",
"_default/tags.fr.amp.html",
"_default/taxonomy.fr.amp.html",
"_default/list.fr.amp.html",
"_default/term.amp.html",
"_default/tags.amp.html",
"_default/taxonomy.amp.html",
"_default/list.amp.html",
"_default/term.fr.html",
"_default/tags.fr.html",
"_default/taxonomy.fr.html",
"_default/list.fr.html",
"_default/term.html",
"_default/tags.html",
"_default/taxonomy.html",
"_default/list.html",
},
},
{
"Term, baseof, French, AMP",
LayoutDescriptor{Kind: "term", Section: "tags", Lang: "fr", Baseof: true, OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"term/term-baseof.fr.amp.html",
"term/tags-baseof.fr.amp.html",
"term/taxonomy-baseof.fr.amp.html",
"term/list-baseof.fr.amp.html",
"term/baseof.fr.amp.html",
"term/term-baseof.amp.html",
"term/tags-baseof.amp.html",
"term/taxonomy-baseof.amp.html",
"term/list-baseof.amp.html",
"term/baseof.amp.html",
"term/term-baseof.fr.html",
"term/tags-baseof.fr.html",
"term/taxonomy-baseof.fr.html",
"term/list-baseof.fr.html",
"term/baseof.fr.html",
"term/term-baseof.html",
"term/tags-baseof.html",
"term/taxonomy-baseof.html",
"term/list-baseof.html",
"term/baseof.html",
"taxonomy/term-baseof.fr.amp.html",
"taxonomy/tags-baseof.fr.amp.html",
"taxonomy/taxonomy-baseof.fr.amp.html",
"taxonomy/list-baseof.fr.amp.html",
"taxonomy/baseof.fr.amp.html",
"taxonomy/term-baseof.amp.html",
"taxonomy/tags-baseof.amp.html",
"taxonomy/taxonomy-baseof.amp.html",
"taxonomy/list-baseof.amp.html",
"taxonomy/baseof.amp.html",
"taxonomy/term-baseof.fr.html",
"taxonomy/tags-baseof.fr.html",
"taxonomy/taxonomy-baseof.fr.html",
"taxonomy/list-baseof.fr.html",
"taxonomy/baseof.fr.html",
"taxonomy/term-baseof.html",
"taxonomy/tags-baseof.html",
"taxonomy/taxonomy-baseof.html",
"taxonomy/list-baseof.html",
"taxonomy/baseof.html",
"tags/term-baseof.fr.amp.html",
"tags/tags-baseof.fr.amp.html",
"tags/taxonomy-baseof.fr.amp.html",
"tags/list-baseof.fr.amp.html",
"tags/baseof.fr.amp.html",
"tags/term-baseof.amp.html",
"tags/tags-baseof.amp.html",
"tags/taxonomy-baseof.amp.html",
"tags/list-baseof.amp.html",
"tags/baseof.amp.html",
"tags/term-baseof.fr.html",
"tags/tags-baseof.fr.html",
"tags/taxonomy-baseof.fr.html",
"tags/list-baseof.fr.html",
"tags/baseof.fr.html",
"tags/term-baseof.html",
"tags/tags-baseof.html",
"tags/taxonomy-baseof.html",
"tags/list-baseof.html",
"tags/baseof.html",
"_default/term-baseof.fr.amp.html",
"_default/tags-baseof.fr.amp.html",
"_default/taxonomy-baseof.fr.amp.html",
"_default/list-baseof.fr.amp.html",
"_default/baseof.fr.amp.html",
"_default/term-baseof.amp.html",
"_default/tags-baseof.amp.html",
"_default/taxonomy-baseof.amp.html",
"_default/list-baseof.amp.html",
"_default/baseof.amp.html",
"_default/term-baseof.fr.html",
"_default/tags-baseof.fr.html",
"_default/taxonomy-baseof.fr.html",
"_default/list-baseof.fr.html",
"_default/baseof.fr.html",
"_default/term-baseof.html",
"_default/tags-baseof.html",
"_default/taxonomy-baseof.html",
"_default/list-baseof.html",
"_default/baseof.html",
},
},
{
"Term",
LayoutDescriptor{Kind: "term", Section: "tags", OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"term/term.amp.html",
"term/tags.amp.html",
"term/taxonomy.amp.html",
"term/list.amp.html",
"term/term.html",
"term/tags.html",
"term/taxonomy.html",
"term/list.html",
"taxonomy/term.amp.html",
"taxonomy/tags.amp.html",
"taxonomy/taxonomy.amp.html",
"taxonomy/list.amp.html",
"taxonomy/term.html",
"taxonomy/tags.html",
"taxonomy/taxonomy.html",
"taxonomy/list.html",
"tags/term.amp.html",
"tags/tags.amp.html",
"tags/taxonomy.amp.html",
"tags/list.amp.html",
"tags/term.html",
"tags/tags.html",
"tags/taxonomy.html",
"tags/list.html",
"_default/term.amp.html",
"_default/tags.amp.html",
"_default/taxonomy.amp.html",
"_default/list.amp.html",
"_default/term.html",
"_default/tags.html",
"_default/taxonomy.html",
"_default/list.html",
},
},
{
"Taxonomy",
LayoutDescriptor{Kind: "taxonomy", Section: "categories", OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"categories/categories.terms.amp.html",
"categories/terms.amp.html",
"categories/taxonomy.amp.html",
"categories/list.amp.html",
"categories/categories.terms.html",
"categories/terms.html",
"categories/taxonomy.html",
"categories/list.html",
"taxonomy/categories.terms.amp.html",
"taxonomy/terms.amp.html",
"taxonomy/taxonomy.amp.html",
"taxonomy/list.amp.html",
"taxonomy/categories.terms.html",
"taxonomy/terms.html",
"taxonomy/taxonomy.html",
"taxonomy/list.html",
"_default/categories.terms.amp.html",
"_default/terms.amp.html",
"_default/taxonomy.amp.html",
"_default/list.amp.html",
"_default/categories.terms.html",
"_default/terms.html",
"_default/taxonomy.html",
"_default/list.html",
},
},
{
"Page",
LayoutDescriptor{Kind: "page", OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"_default/single.amp.html",
"_default/single.html",
},
},
{
"Page, baseof",
LayoutDescriptor{Kind: "page", Baseof: true, OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"_default/single-baseof.amp.html",
"_default/baseof.amp.html",
"_default/single-baseof.html",
"_default/baseof.html",
},
},
{
"Page with layout",
LayoutDescriptor{Kind: "page", Layout: "mylayout", OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"_default/mylayout.amp.html",
"_default/single.amp.html",
"_default/mylayout.html",
"_default/single.html",
},
},
{
"Page with layout, baseof",
LayoutDescriptor{Kind: "page", Layout: "mylayout", Baseof: true, OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"_default/mylayout-baseof.amp.html",
"_default/single-baseof.amp.html",
"_default/baseof.amp.html",
"_default/mylayout-baseof.html",
"_default/single-baseof.html",
"_default/baseof.html",
},
},
{
"Page with layout and type",
LayoutDescriptor{Kind: "page", Layout: "mylayout", Type: "myttype", OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"myttype/mylayout.amp.html",
"myttype/single.amp.html",
"myttype/mylayout.html",
"myttype/single.html",
"_default/mylayout.amp.html",
"_default/single.amp.html",
"_default/mylayout.html",
"_default/single.html",
},
},
{
"Page baseof with layout and type",
LayoutDescriptor{Kind: "page", Layout: "mylayout", Type: "myttype", Baseof: true, OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"myttype/mylayout-baseof.amp.html",
"myttype/single-baseof.amp.html",
"myttype/baseof.amp.html",
"myttype/mylayout-baseof.html",
"myttype/single-baseof.html",
"myttype/baseof.html",
"_default/mylayout-baseof.amp.html",
"_default/single-baseof.amp.html",
"_default/baseof.amp.html",
"_default/mylayout-baseof.html",
"_default/single-baseof.html",
"_default/baseof.html",
},
},
{
"Page baseof with layout and type in French",
LayoutDescriptor{Kind: "page", Layout: "mylayout", Type: "myttype", Lang: "fr", Baseof: true, OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"myttype/mylayout-baseof.fr.amp.html",
"myttype/single-baseof.fr.amp.html",
"myttype/baseof.fr.amp.html",
"myttype/mylayout-baseof.amp.html",
"myttype/single-baseof.amp.html",
"myttype/baseof.amp.html",
"myttype/mylayout-baseof.fr.html",
"myttype/single-baseof.fr.html",
"myttype/baseof.fr.html",
"myttype/mylayout-baseof.html",
"myttype/single-baseof.html",
"myttype/baseof.html",
"_default/mylayout-baseof.fr.amp.html",
"_default/single-baseof.fr.amp.html",
"_default/baseof.fr.amp.html",
"_default/mylayout-baseof.amp.html",
"_default/single-baseof.amp.html",
"_default/baseof.amp.html",
"_default/mylayout-baseof.fr.html",
"_default/single-baseof.fr.html",
"_default/baseof.fr.html",
"_default/mylayout-baseof.html",
"_default/single-baseof.html",
"_default/baseof.html",
},
},
{
"Page with layout and type with subtype",
LayoutDescriptor{Kind: "page", Layout: "mylayout", Type: "myttype/mysubtype", OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"myttype/mysubtype/mylayout.amp.html",
"myttype/mysubtype/single.amp.html",
"myttype/mysubtype/mylayout.html",
"myttype/mysubtype/single.html",
"_default/mylayout.amp.html",
"_default/single.amp.html",
"_default/mylayout.html",
"_default/single.html",
},
},
// RSS
{
"RSS Home",
LayoutDescriptor{Kind: "home", OutputFormatName: "rss", Suffix: "xml"},
"",
[]string{
"index.rss.xml",
"home.rss.xml",
"rss.xml",
"list.rss.xml",
"index.xml",
"home.xml",
"list.xml",
"_default/index.rss.xml",
"_default/home.rss.xml",
"_default/rss.xml",
"_default/list.rss.xml",
"_default/index.xml",
"_default/home.xml",
"_default/list.xml",
"_internal/_default/rss.xml",
},
},
{
"RSS Home, baseof",
LayoutDescriptor{Kind: "home", Baseof: true, OutputFormatName: "rss", Suffix: "xml"},
"",
[]string{
"index-baseof.rss.xml",
"home-baseof.rss.xml",
"list-baseof.rss.xml",
"baseof.rss.xml",
"index-baseof.xml",
"home-baseof.xml",
"list-baseof.xml",
"baseof.xml",
"_default/index-baseof.rss.xml",
"_default/home-baseof.rss.xml",
"_default/list-baseof.rss.xml",
"_default/baseof.rss.xml",
"_default/index-baseof.xml",
"_default/home-baseof.xml",
"_default/list-baseof.xml",
"_default/baseof.xml",
},
},
{
"RSS Section",
LayoutDescriptor{Kind: "section", Section: "sect1", OutputFormatName: "rss", Suffix: "xml"},
"",
[]string{
"sect1/sect1.rss.xml",
"sect1/section.rss.xml",
"sect1/rss.xml",
"sect1/list.rss.xml",
"sect1/sect1.xml",
"sect1/section.xml",
"sect1/list.xml",
"section/sect1.rss.xml",
"section/section.rss.xml",
"section/rss.xml",
"section/list.rss.xml",
"section/sect1.xml",
"section/section.xml",
"section/list.xml",
"_default/sect1.rss.xml",
"_default/section.rss.xml",
"_default/rss.xml",
"_default/list.rss.xml",
"_default/sect1.xml",
"_default/section.xml",
"_default/list.xml",
"_internal/_default/rss.xml",
},
},
{
"RSS Term",
LayoutDescriptor{Kind: "term", Section: "tag", OutputFormatName: "rss", Suffix: "xml"},
"",
[]string{
"term/term.rss.xml",
"term/tag.rss.xml",
"term/taxonomy.rss.xml",
"term/rss.xml",
"term/list.rss.xml",
"term/term.xml",
"term/tag.xml",
"term/taxonomy.xml",
"term/list.xml",
"taxonomy/term.rss.xml",
"taxonomy/tag.rss.xml",
"taxonomy/taxonomy.rss.xml",
"taxonomy/rss.xml",
"taxonomy/list.rss.xml",
"taxonomy/term.xml",
"taxonomy/tag.xml",
"taxonomy/taxonomy.xml",
"taxonomy/list.xml",
"tag/term.rss.xml",
"tag/tag.rss.xml",
"tag/taxonomy.rss.xml",
"tag/rss.xml",
"tag/list.rss.xml",
"tag/term.xml",
"tag/tag.xml",
"tag/taxonomy.xml",
"tag/list.xml",
"_default/term.rss.xml",
"_default/tag.rss.xml",
"_default/taxonomy.rss.xml",
"_default/rss.xml",
"_default/list.rss.xml",
"_default/term.xml",
"_default/tag.xml",
"_default/taxonomy.xml",
"_default/list.xml",
"_internal/_default/rss.xml",
},
},
{
"RSS Taxonomy",
LayoutDescriptor{Kind: "taxonomy", Section: "tag", OutputFormatName: "rss", Suffix: "xml"},
"",
[]string{
"tag/tag.terms.rss.xml",
"tag/terms.rss.xml",
"tag/taxonomy.rss.xml",
"tag/rss.xml",
"tag/list.rss.xml",
"tag/tag.terms.xml",
"tag/terms.xml",
"tag/taxonomy.xml",
"tag/list.xml",
"taxonomy/tag.terms.rss.xml",
"taxonomy/terms.rss.xml",
"taxonomy/taxonomy.rss.xml",
"taxonomy/rss.xml",
"taxonomy/list.rss.xml",
"taxonomy/tag.terms.xml",
"taxonomy/terms.xml",
"taxonomy/taxonomy.xml",
"taxonomy/list.xml",
"_default/tag.terms.rss.xml",
"_default/terms.rss.xml",
"_default/taxonomy.rss.xml",
"_default/rss.xml",
"_default/list.rss.xml",
"_default/tag.terms.xml",
"_default/terms.xml",
"_default/taxonomy.xml",
"_default/list.xml",
"_internal/_default/rss.xml",
},
},
{
"Home plain text",
LayoutDescriptor{Kind: "home", OutputFormatName: "json", Suffix: "json"},
"",
[]string{
"index.json.json",
"home.json.json",
"list.json.json",
"index.json",
"home.json",
"list.json",
"_default/index.json.json",
"_default/home.json.json",
"_default/list.json.json",
"_default/index.json",
"_default/home.json",
"_default/list.json",
},
},
{
"Page plain text",
LayoutDescriptor{Kind: "page", OutputFormatName: "json", Suffix: "json"},
"",
[]string{
"_default/single.json.json",
"_default/single.json",
},
},
{
"Reserved section, shortcodes",
LayoutDescriptor{Kind: "section", Section: "shortcodes", Type: "shortcodes", OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"section/shortcodes.amp.html",
"section/section.amp.html",
"section/list.amp.html",
"section/shortcodes.html",
"section/section.html",
"section/list.html",
"_default/shortcodes.amp.html",
"_default/section.amp.html",
"_default/list.amp.html",
"_default/shortcodes.html",
"_default/section.html",
"_default/list.html",
},
},
{
"Reserved section, partials",
LayoutDescriptor{Kind: "section", Section: "partials", Type: "partials", OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"section/partials.amp.html",
"section/section.amp.html",
"section/list.amp.html",
"section/partials.html",
"section/section.html",
"section/list.html",
"_default/partials.amp.html",
"_default/section.amp.html",
"_default/list.amp.html",
"_default/partials.html",
"_default/section.html",
"_default/list.html",
},
},
// This is currently always HTML only
{
"404, HTML",
LayoutDescriptor{Kind: "404", OutputFormatName: "html", Suffix: "html"},
"",
[]string{
"404.html.html",
"404.html",
},
},
{
"404, HTML baseof",
LayoutDescriptor{Kind: "404", Baseof: true, OutputFormatName: "html", Suffix: "html"},
"",
[]string{
"404-baseof.html.html",
"baseof.html.html",
"404-baseof.html",
"baseof.html",
"_default/404-baseof.html.html",
"_default/baseof.html.html",
"_default/404-baseof.html",
"_default/baseof.html",
},
},
{
"Content hook",
LayoutDescriptor{Kind: "render-link", RenderingHook: true, Layout: "mylayout", Section: "blog", OutputFormatName: "amp", Suffix: "html"},
"",
[]string{
"blog/_markup/render-link.amp.html",
"blog/_markup/render-link.html",
"_default/_markup/render-link.amp.html",
"_default/_markup/render-link.html",
},
},
} {
c.Run(this.name, func(c *qt.C) {
l := NewLayoutHandler()
layouts, err := l.For(this.layoutDescriptor)
c.Assert(err, qt.IsNil)
c.Assert(layouts, qt.Not(qt.IsNil), qt.Commentf(this.layoutDescriptor.Kind))
if !reflect.DeepEqual(layouts, this.expect) {
r := strings.NewReplacer(
"[", "\t\"",
"]", "\",",
" ", "\",\n\t\"",
)
fmtGot := r.Replace(fmt.Sprintf("%v", layouts))
fmtExp := r.Replace(fmt.Sprintf("%v", this.expect))
c.Fatalf("got %d items, expected %d:\nGot:\n\t%v\nExpected:\n\t%v\nDiff:\n%s", len(layouts), len(this.expect), layouts, this.expect, diff.Diff(fmtExp, fmtGot))
}
})
}
}
/*
func BenchmarkLayout(b *testing.B) {
descriptor := LayoutDescriptor{Kind: "taxonomy", Section: "categories"}
l := NewLayoutHandler()
for i := 0; i < b.N; i++ {
_, err := l.For(descriptor, HTMLFormat)
if err != nil {
panic(err)
}
}
}
func BenchmarkLayoutUncached(b *testing.B) {
for i := 0; i < b.N; i++ {
descriptor := LayoutDescriptor{Kind: "taxonomy", Section: "categories"}
l := NewLayoutHandler()
_, err := l.For(descriptor, HTMLFormat)
if err != nil {
panic(err)
}
}
}
*/

View File

@@ -133,6 +133,15 @@ var (
Weight: 10,
}
// Alias is the output format used for alias redirects.
AliasHTMLFormat = Format{
Name: "alias",
MediaType: media.Builtin.HTMLType,
IsHTML: true,
Ugly: true,
Permalinkable: false,
}
MarkdownFormat = Format{
Name: "markdown",
MediaType: media.Builtin.MarkdownType,
@@ -192,8 +201,17 @@ var (
Rel: "sitemap",
}
HTTPStatusHTMLFormat = Format{
Name: "httpstatus",
GotmplFormat = Format{
Name: "gotmpl",
MediaType: media.Builtin.GotmplType,
IsPlainText: true,
NotAlternative: true,
}
// I'm not sure having a 404 format is a good idea,
// for one, we would want to have multiple formats for this.
HTTPStatus404HTMLFormat = Format{
Name: "404",
MediaType: media.Builtin.HTMLType,
NotAlternative: true,
Ugly: true,
@@ -209,12 +227,16 @@ var DefaultFormats = Formats{
CSSFormat,
CSVFormat,
HTMLFormat,
GotmplFormat,
HTTPStatus404HTMLFormat,
AliasHTMLFormat,
JSONFormat,
MarkdownFormat,
WebAppManifestFormat,
RobotsTxtFormat,
RSSFormat,
SitemapFormat,
SitemapIndexFormat,
}
func init() {

View File

@@ -68,7 +68,7 @@ func TestDefaultTypes(t *testing.T) {
c.Assert(RSSFormat.NoUgly, qt.Equals, true)
c.Assert(CalendarFormat.IsHTML, qt.Equals, false)
c.Assert(len(DefaultFormats), qt.Equals, 11)
c.Assert(len(DefaultFormats), qt.Equals, 15)
}
func TestGetFormatByName(t *testing.T) {
@@ -140,7 +140,7 @@ func TestGetFormatByFilename(t *testing.T) {
func TestSort(t *testing.T) {
c := qt.New(t)
c.Assert(DefaultFormats[0].Name, qt.Equals, "html")
c.Assert(DefaultFormats[1].Name, qt.Equals, "amp")
c.Assert(DefaultFormats[1].Name, qt.Equals, "404")
json := JSONFormat
json.Weight = 1