all: Rework page store, add a dynacache, improve partial rebuilds, and some general spring cleaning
There are some breaking changes in this commit, see #11455.
Closes #11455
Closes #11549
This fixes a set of bugs (see issue list) and it is also paying some technical debt accumulated over the years. We now build with Staticcheck enabled in the CI build.
The performance should be about the same as before for regular sized Hugo sites, but it should perform and scale much better to larger data sets, as objects that uses lots of memory (e.g. rendered Markdown, big JSON files read into maps with transform.Unmarshal etc.) will now get automatically garbage collected if needed. Performance on partial rebuilds when running the server in fast render mode should be the same, but the change detection should be much more accurate.
A list of the notable new features:
* A new dependency tracker that covers (almost) all of Hugo's API and is used to do fine grained partial rebuilds when running the server.
* A new and simpler tree document store which allows fast lookups and prefix-walking in all dimensions (e.g. language) concurrently.
* You can now configure an upper memory limit allowing for much larger data sets and/or running on lower specced PCs.
We have lifted the "no resources in sub folders" restriction for branch bundles (e.g. sections).
Memory Limit
* Hugos will, by default, set aside a quarter of the total system memory, but you can set this via the OS environment variable HUGO_MEMORYLIMIT (in gigabytes). This is backed by a partitioned LRU cache used throughout Hugo. A cache that gets dynamically resized in low memory situations, allowing Go's Garbage Collector to free the memory.
New Dependency Tracker: Hugo has had a rule based coarse grained approach to server rebuilds that has worked mostly pretty well, but there have been some surprises (e.g. stale content). This is now revamped with a new dependency tracker that can quickly calculate the delta given a changed resource (e.g. a content file, template, JS file etc.). This handles transitive relations, e.g. $page -> js.Build -> JS import, or $page1.Content -> render hook -> site.GetPage -> $page2.Title, or $page1.Content -> shortcode -> partial -> site.RegularPages -> $page2.Content -> shortcode ..., and should also handle changes to aggregated values (e.g. site.Lastmod) effectively.
This covers all of Hugo's API with 2 known exceptions (a list that may not be fully exhaustive):
Changes to files loaded with template func os.ReadFile may not be handled correctly. We recommend loading resources with resources.Get
Changes to Hugo objects (e.g. Page) passed in the template context to lang.Translate may not be detected correctly. We recommend having simple i18n templates without too much data context passed in other than simple types such as strings and numbers.
Note that the cachebuster configuration (when A changes then rebuild B) works well with the above, but we recommend that you revise that configuration, as it in most situations should not be needed. One example where it is still needed is with TailwindCSS and using changes to hugo_stats.json to trigger new CSS rebuilds.
Document Store: Previously, a little simplified, we split the document store (where we store pages and resources) in a tree per language. This worked pretty well, but the structure made some operations harder than they needed to be. We have now restructured it into one Radix tree for all languages. Internally the language is considered to be a dimension of that tree, and the tree can be viewed in all dimensions concurrently. This makes some operations re. language simpler (e.g. finding translations is just a slice range), but the idea is that it should also be relatively inexpensive to add more dimensions if needed (e.g. role).
Fixes #10169
Fixes #10364
Fixes #10482
Fixes #10630
Fixes #10656
Fixes #10694
Fixes #10918
Fixes #11262
Fixes #11439
Fixes #11453
Fixes #11457
Fixes #11466
Fixes #11540
Fixes #11551
Fixes #11556
Fixes #11654
Fixes #11661
Fixes #11663
Fixes #11664
Fixes #11669
Fixes #11671
Fixes #11807
Fixes #11808
Fixes #11809
Fixes #11815
Fixes #11840
Fixes #11853
Fixes #11860
Fixes #11883
Fixes #11904
Fixes #7388
Fixes #7425
Fixes #7436
Fixes #7544
Fixes #7882
Fixes #7960
Fixes #8255
Fixes #8307
Fixes #8863
Fixes #8927
Fixes #9192
Fixes #9324
2023-12-24 13:11:05 -05:00
// Copyright 2024 The Hugo Authors. All rights reserved.
2019-11-06 14:10:47 -05:00
//
// 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.
2023-01-04 12:24:36 -05:00
package goldmark_test
2019-11-06 14:10:47 -05:00
import (
2021-07-15 02:46:54 -04:00
"fmt"
2019-11-06 14:10:47 -05:00
"strings"
"testing"
2023-01-04 12:24:36 -05:00
"github.com/pelletier/go-toml/v2"
2021-02-07 12:08:46 -05:00
"github.com/spf13/cast"
2023-01-04 12:24:36 -05:00
"github.com/gohugoio/hugo/config"
"github.com/gohugoio/hugo/config/testconfig"
2022-02-17 07:04:00 -05:00
"github.com/gohugoio/hugo/markup/converter/hooks"
2023-01-04 12:24:36 -05:00
"github.com/gohugoio/hugo/markup/goldmark"
2020-01-05 05:29:22 -05:00
2019-11-06 14:10:47 -05:00
"github.com/gohugoio/hugo/markup/highlight"
"github.com/gohugoio/hugo/markup/markup_config"
"github.com/gohugoio/hugo/common/loggers"
2023-01-04 12:24:36 -05:00
"github.com/gohugoio/hugo/common/maps"
2019-11-06 14:10:47 -05:00
"github.com/gohugoio/hugo/markup/converter"
qt "github.com/frankban/quicktest"
)
2023-01-04 12:24:36 -05:00
var cfgStrHighlichgtNoClasses = `
[ markup ]
[ markup . highlight ]
noclasses = false
`
func convert ( c * qt . C , conf config . AllProvider , content string ) converter . ResultRender {
pconf := converter . ProviderConfig {
2023-06-16 02:17:42 -04:00
Logger : loggers . NewDefault ( ) ,
2023-01-04 12:24:36 -05:00
Conf : conf ,
}
p , err := goldmark . Provider . New (
pconf ,
2020-01-04 05:28:19 -05:00
)
c . Assert ( err , qt . IsNil )
2023-01-04 12:24:36 -05:00
mconf := pconf . MarkupConfig ( )
2022-02-17 07:04:00 -05:00
h := highlight . New ( mconf . Highlight )
2022-03-17 17:03:27 -04:00
getRenderer := func ( t hooks . RendererType , id any ) any {
2022-02-17 07:04:00 -05:00
if t == hooks . CodeBlockRendererType {
return h
}
return nil
}
2020-01-04 05:28:19 -05:00
conv , err := p . New ( converter . DocumentContext { DocumentID : "thedoc" } )
c . Assert ( err , qt . IsNil )
2022-02-17 07:04:00 -05:00
b , err := conv . Convert ( converter . RenderContext { RenderTOC : true , Src : [ ] byte ( content ) , GetRenderer : getRenderer } )
2020-01-04 05:28:19 -05:00
c . Assert ( err , qt . IsNil )
return b
}
2019-11-06 14:10:47 -05:00
func TestConvert ( t * testing . T ) {
c := qt . New ( t )
// Smoke test of the default configuration.
content := `
2019-11-24 06:28:57 -05:00
# # Links
https : //github.com/gohugoio/hugo/issues/6528
[ Live Demo here ! ] ( https : //docuapi.netlify.com/)
2019-11-27 07:42:36 -05:00
[ I ' m an inline - style link with title ] ( https : //www.google.com "Google's Homepage")
2021-07-15 02:46:54 -04:00
< https : //foo.bar/>
https : //bar.baz/
< fake @ example . com >
< mailto : fake2 @ example . com >
2019-11-27 07:42:36 -05:00
2019-11-06 14:10:47 -05:00
# # Code Fences
§ § § bash
LINE1
§ § §
# # Code Fences No Lexer
§ § § moo
LINE1
§ § §
# # Custom ID { # custom }
# # Auto ID
* Autolink : https : //gohugo.io/
* Strikethrough : ~ ~ Hi ~ ~ Hello , world !
2023-10-08 19:59:36 -04:00
2019-11-06 14:10:47 -05:00
# # Table
| foo | bar |
| -- - | -- - |
| baz | bim |
# # Task Lists ( default on )
- [ x ] Finish my changes [ ^ 1 ]
- [ ] Push my commits to GitHub
- [ ] Open a pull request
# # Smartypants ( default on )
* Straight double "quotes" and single ' quotes ' into “ curly ” quote HTML entities
* Dashes ( “ -- ” and “ -- - ” ) into en - and em - dash entities
* Three consecutive dots ( “ ... ” ) into an ellipsis entity
2020-01-15 04:32:45 -05:00
* Apostrophes are also converted : "That was back in the '90s, that's a long time ago"
2019-11-06 14:10:47 -05:00
# # Footnotes
That ' s some text with a footnote . [ ^ 1 ]
# # Definition Lists
date
2023-10-08 19:59:36 -04:00
: the datetime assigned to this page .
2019-11-06 14:10:47 -05:00
description
: the description for the content .
2020-01-04 05:28:19 -05:00
# # 神真美好
# # 神真美好
# # 神真美好
2019-11-06 14:10:47 -05:00
[ ^ 1 ] : And that ' s the footnote .
`
// Code fences
content = strings . Replace ( content , "§§§" , "```" , - 1 )
2023-01-04 12:24:36 -05:00
cfg := config . FromTOMLConfigString ( `
[ markup ]
[ markup . highlight ]
noClasses = false
[ markup . goldmark . renderer ]
unsafe = true
` )
b := convert ( c , testconfig . GetTestConfig ( nil , cfg ) , content )
2019-11-06 14:10:47 -05:00
got := string ( b . Bytes ( ) )
2021-07-15 02:46:54 -04:00
fmt . Println ( got )
2019-11-24 06:28:57 -05:00
// Links
2021-07-15 02:46:54 -04:00
c . Assert ( got , qt . Contains , ` <a href="https://docuapi.netlify.com/">Live Demo here!</a> ` )
c . Assert ( got , qt . Contains , ` <a href="https://foo.bar/">https://foo.bar/</a> ` )
c . Assert ( got , qt . Contains , ` <a href="https://bar.baz/">https://bar.baz/</a> ` )
c . Assert ( got , qt . Contains , ` <a href="mailto:fake@example.com">fake@example.com</a> ` )
c . Assert ( got , qt . Contains , ` <a href="mailto:fake2@example.com">mailto:fake2@example.com</a></p> ` )
2019-11-24 06:28:57 -05:00
2019-11-06 14:10:47 -05:00
// Header IDs
c . Assert ( got , qt . Contains , ` <h2 id="custom">Custom ID</h2> ` , qt . Commentf ( got ) )
c . Assert ( got , qt . Contains , ` <h2 id="auto-id">Auto ID</h2> ` , qt . Commentf ( got ) )
2020-01-04 05:28:19 -05:00
c . Assert ( got , qt . Contains , ` <h2 id="神真美好">神真美好</h2> ` , qt . Commentf ( got ) )
c . Assert ( got , qt . Contains , ` <h2 id="神真美好-1">神真美好</h2> ` , qt . Commentf ( got ) )
c . Assert ( got , qt . Contains , ` <h2 id="神真美好-2">神真美好</h2> ` , qt . Commentf ( got ) )
2019-11-06 14:10:47 -05:00
// Code fences
2022-02-14 07:27:17 -05:00
c . Assert ( got , qt . Contains , "<div class=\"highlight\"><pre tabindex=\"0\" class=\"chroma\"><code class=\"language-bash\" data-lang=\"bash\"><span class=\"line\"><span class=\"cl\">LINE1\n</span></span></code></pre></div>" )
2021-08-22 10:03:20 -04:00
c . Assert ( got , qt . Contains , "Code Fences No Lexer</h2>\n<pre tabindex=\"0\"><code class=\"language-moo\" data-lang=\"moo\">LINE1\n</code></pre>" )
2019-11-06 14:10:47 -05:00
// Extensions
c . Assert ( got , qt . Contains , ` Autolink: <a href="https://gohugo.io/">https://gohugo.io/</a> ` )
c . Assert ( got , qt . Contains , ` Strikethrough:<del>Hi</del> Hello, world ` )
c . Assert ( got , qt . Contains , ` <th>foo</th> ` )
2020-03-18 22:16:00 -04:00
c . Assert ( got , qt . Contains , ` <li><input disabled="" type="checkbox"> Push my commits to GitHub</li> ` )
2019-11-06 14:10:47 -05:00
c . Assert ( got , qt . Contains , ` Straight double “quotes” and single ‘quotes’ ` )
c . Assert ( got , qt . Contains , ` Dashes (“–” and “—”) ` )
c . Assert ( got , qt . Contains , ` Three consecutive dots (“…”) ` )
2020-01-15 04:32:45 -05:00
c . Assert ( got , qt . Contains , ` “That was back in the ’90s, that’s a long time ago” ` )
2022-04-25 10:20:30 -04:00
c . Assert ( got , qt . Contains , ` footnote.<sup id="fnref1:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup> ` )
c . Assert ( got , qt . Contains , ` <div class="footnotes" role="doc-endnotes"> ` )
2019-11-06 14:10:47 -05:00
c . Assert ( got , qt . Contains , ` <dt>date</dt> ` )
2019-11-27 07:42:36 -05:00
toc , ok := b . ( converter . TableOfContentsProvider )
c . Assert ( ok , qt . Equals , true )
2023-10-08 19:59:36 -04:00
tocString := string ( toc . TableOfContents ( ) . ToHTML ( 1 , 2 , false ) )
c . Assert ( tocString , qt . Contains , "TableOfContents" )
2019-11-06 14:10:47 -05:00
}
2020-01-04 05:28:19 -05:00
func TestConvertAutoIDAsciiOnly ( t * testing . T ) {
c := qt . New ( t )
content := `
# # God is Good : 神真美好
`
2023-01-04 12:24:36 -05:00
cfg := config . FromTOMLConfigString ( `
[ markup ]
[ markup . goldmark ]
[ markup . goldmark . parser ]
autoHeadingIDType = ' github - ascii '
` )
b := convert ( c , testconfig . GetTestConfig ( nil , cfg ) , content )
2020-01-04 05:28:19 -05:00
got := string ( b . Bytes ( ) )
c . Assert ( got , qt . Contains , "<h2 id=\"god-is-good-\">" )
}
2020-01-05 05:52:00 -05:00
func TestConvertAutoIDBlackfriday ( t * testing . T ) {
c := qt . New ( t )
content := `
# # Let ' s try this , shall we ?
`
2023-01-04 12:24:36 -05:00
cfg := config . FromTOMLConfigString ( `
[ markup ]
[ markup . goldmark ]
[ markup . goldmark . parser ]
autoHeadingIDType = ' blackfriday '
` )
b := convert ( c , testconfig . GetTestConfig ( nil , cfg ) , content )
2020-01-05 05:52:00 -05:00
got := string ( b . Bytes ( ) )
c . Assert ( got , qt . Contains , "<h2 id=\"let-s-try-this-shall-we\">" )
}
2021-02-07 12:08:46 -05:00
func TestConvertAttributes ( t * testing . T ) {
c := qt . New ( t )
withBlockAttributes := func ( conf * markup_config . Config ) {
conf . Goldmark . Parser . Attribute . Block = true
conf . Goldmark . Parser . Attribute . Title = false
}
withTitleAndBlockAttributes := func ( conf * markup_config . Config ) {
conf . Goldmark . Parser . Attribute . Block = true
conf . Goldmark . Parser . Attribute . Title = true
}
for _ , test := range [ ] struct {
name string
withConfig func ( conf * markup_config . Config )
input string
2022-03-17 17:03:27 -04:00
expect any
2021-02-07 12:08:46 -05:00
} {
{
"Title" ,
nil ,
"## heading {#id .className attrName=attrValue class=\"class1 class2\"}" ,
"<h2 id=\"id\" class=\"className class1 class2\" attrName=\"attrValue\">heading</h2>\n" ,
} ,
{
"Blockquote" ,
withBlockAttributes ,
"> foo\n> bar\n{#id .className attrName=attrValue class=\"class1 class2\"}\n" ,
"<blockquote id=\"id\" class=\"className class1 class2\"><p>foo\nbar</p>\n</blockquote>\n" ,
} ,
2021-02-23 12:04:05 -05:00
/ * {
// TODO(bep) this needs an upstream fix, see https://github.com/yuin/goldmark/issues/195
"Code block, CodeFences=false" ,
func ( conf * markup_config . Config ) {
withBlockAttributes ( conf )
conf . Highlight . CodeFences = false
} ,
"```bash\necho 'foo';\n```\n{.myclass}" ,
"TODO" ,
} , * /
{
"Code block, CodeFences=true" ,
func ( conf * markup_config . Config ) {
withBlockAttributes ( conf )
conf . Highlight . CodeFences = true
} ,
2021-03-20 11:36:30 -04:00
"```bash {.myclass id=\"myid\"}\necho 'foo';\n````\n" ,
2021-02-23 12:04:05 -05:00
"<div class=\"highlight myclass\" id=\"myid\"><pre style" ,
} ,
2021-03-20 11:36:30 -04:00
{
"Code block, CodeFences=true,linenos=table" ,
func ( conf * markup_config . Config ) {
withBlockAttributes ( conf )
conf . Highlight . CodeFences = true
} ,
"```bash {linenos=table .myclass id=\"myid\"}\necho 'foo';\n````\n{ .adfadf }" ,
2022-02-14 07:27:17 -05:00
[ ] string {
"div class=\"highlight myclass\" id=\"myid\"><div s" ,
"table style" ,
} ,
2021-03-20 11:36:30 -04:00
} ,
2022-02-24 14:12:45 -05:00
{
"Code block, CodeFences=true,lineanchors" ,
func ( conf * markup_config . Config ) {
withBlockAttributes ( conf )
conf . Highlight . CodeFences = true
conf . Highlight . NoClasses = false
} ,
"```bash {linenos=table, anchorlinenos=true, lineanchors=org-coderef--xyz}\necho 'foo';\n```" ,
2022-11-18 03:53:31 -05:00
"<div class=\"highlight\"><div class=\"chroma\">\n<table class=\"lntable\"><tr><td class=\"lntd\">\n<pre tabindex=\"0\" class=\"chroma\"><code><span class=\"lnt\" id=\"org-coderef--xyz-1\"><a href=\"#org-coderef--xyz-1\">1</a>\n</span></code></pre></td>\n<td class=\"lntd\">\n<pre tabindex=\"0\" class=\"chroma\"><code class=\"language-bash\" data-lang=\"bash\"><span class=\"line\"><span class=\"cl\"><span class=\"nb\">echo</span> <span class=\"s1\">'foo'</span><span class=\"p\">;</span>\n</span></span></code></pre></td></tr></table>\n</div>\n</div>" ,
2022-02-24 14:12:45 -05:00
} ,
2022-02-25 01:45:37 -05:00
{
"Code block, CodeFences=true,lineanchors, default ordinal" ,
func ( conf * markup_config . Config ) {
withBlockAttributes ( conf )
conf . Highlight . CodeFences = true
conf . Highlight . NoClasses = false
} ,
"```bash {linenos=inline, anchorlinenos=true}\necho 'foo';\nnecho 'bar';\n```\n\n```bash {linenos=inline, anchorlinenos=true}\necho 'baz';\nnecho 'qux';\n```" ,
[ ] string {
2022-11-18 03:53:31 -05:00
"<span class=\"ln\" id=\"hl-0-1\"><a class=\"lnlinks\" href=\"#hl-0-1\">1</a></span><span class=\"cl\"><span class=\"nb\">echo</span> <span class=\"s1\">'foo'</span>" ,
"<span class=\"ln\" id=\"hl-0-2\"><a class=\"lnlinks\" href=\"#hl-0-2\">2</a></span><span class=\"cl\">necho <span class=\"s1\">'bar'</span>" ,
"<span class=\"ln\" id=\"hl-1-2\"><a class=\"lnlinks\" href=\"#hl-1-2\">2</a></span><span class=\"cl\">necho <span class=\"s1\">'qux'</span>" ,
2022-02-25 01:45:37 -05:00
} ,
} ,
2021-02-07 12:08:46 -05:00
{
"Paragraph" ,
withBlockAttributes ,
"\nHi there.\n{.myclass }" ,
"<p class=\"myclass\">Hi there.</p>\n" ,
} ,
{
"Ordered list" ,
withBlockAttributes ,
"\n1. First\n2. Second\n{.myclass }" ,
"<ol class=\"myclass\">\n<li>First</li>\n<li>Second</li>\n</ol>\n" ,
} ,
{
"Unordered list" ,
withBlockAttributes ,
"\n* First\n* Second\n{.myclass }" ,
"<ul class=\"myclass\">\n<li>First</li>\n<li>Second</li>\n</ul>\n" ,
} ,
{
"Unordered list, indented" ,
withBlockAttributes ,
` * Fruit
* Apple
* Orange
* Banana
{ . fruits }
* Dairy
* Milk
* Cheese
{ . dairies }
{ . list } ` ,
[ ] string { "<ul class=\"list\">\n<li>Fruit\n<ul class=\"fruits\">" , "<li>Dairy\n<ul class=\"dairies\">" } ,
} ,
{
"Table" ,
withBlockAttributes ,
` | A | B |
| -- -- -- -- -- -- - | : -- -- -- -- -- -- - : | -- -- - : |
| AV | BV |
{ . myclass } ` ,
"<table class=\"myclass\">\n<thead>" ,
} ,
{
"Title and Blockquote" ,
withTitleAndBlockAttributes ,
"## heading {#id .className attrName=attrValue class=\"class1 class2\"}\n> foo\n> bar\n{.myclass}" ,
"<h2 id=\"id\" class=\"className class1 class2\" attrName=\"attrValue\">heading</h2>\n<blockquote class=\"myclass\"><p>foo\nbar</p>\n</blockquote>\n" ,
} ,
} {
c . Run ( test . name , func ( c * qt . C ) {
mconf := markup_config . Default
if test . withConfig != nil {
test . withConfig ( & mconf )
}
2023-01-04 12:24:36 -05:00
data , err := toml . Marshal ( mconf )
c . Assert ( err , qt . IsNil )
m := maps . Params {
"markup" : config . FromTOMLConfigString ( string ( data ) ) . Get ( "" ) ,
}
conf := testconfig . GetTestConfig ( nil , config . NewFrom ( m ) )
b := convert ( c , conf , test . input )
2021-02-07 12:08:46 -05:00
got := string ( b . Bytes ( ) )
for _ , s := range cast . ToStringSlice ( test . expect ) {
c . Assert ( got , qt . Contains , s )
}
} )
}
}
2020-09-04 04:23:02 -04:00
func TestConvertIssues ( t * testing . T ) {
c := qt . New ( t )
// https://github.com/gohugoio/hugo/issues/7619
c . Run ( "Hyphen in HTML attributes" , func ( c * qt . C ) {
mconf := markup_config . Default
mconf . Goldmark . Renderer . Unsafe = true
input := ` < custom - element >
< div > This will be "slotted" into the custom element . < / div >
< / custom - element >
`
2023-01-04 12:24:36 -05:00
b := convert ( c , unsafeConf ( ) , input )
2020-09-04 04:23:02 -04:00
got := string ( b . Bytes ( ) )
2020-09-11 01:49:35 -04:00
c . Assert ( got , qt . Contains , "<custom-element>\n <div>This will be \"slotted\" into the custom element.</div>\n</custom-element>\n" )
2020-09-04 04:23:02 -04:00
} )
}
2019-11-06 14:10:47 -05:00
func TestCodeFence ( t * testing . T ) {
c := qt . New ( t )
lines := ` LINE1
LINE2
LINE3
LINE4
LINE5
`
2023-01-04 12:24:36 -05:00
convertForConfig := func ( c * qt . C , confStr , code , language string ) string {
cfg := config . FromTOMLConfigString ( confStr )
conf := testconfig . GetTestConfig ( nil , cfg )
pcfg := converter . ProviderConfig {
Conf : conf ,
2023-06-16 02:17:42 -04:00
Logger : loggers . NewDefault ( ) ,
2023-01-04 12:24:36 -05:00
}
p , err := goldmark . Provider . New (
pcfg ,
2019-11-06 14:10:47 -05:00
)
2023-01-04 12:24:36 -05:00
h := highlight . New ( pcfg . MarkupConfig ( ) . Highlight )
2022-02-17 07:04:00 -05:00
2022-03-17 17:03:27 -04:00
getRenderer := func ( t hooks . RendererType , id any ) any {
2022-02-17 07:04:00 -05:00
if t == hooks . CodeBlockRendererType {
return h
}
return nil
}
2019-11-06 14:10:47 -05:00
content := "```" + language + "\n" + code + "\n```"
c . Assert ( err , qt . IsNil )
conv , err := p . New ( converter . DocumentContext { } )
c . Assert ( err , qt . IsNil )
2022-02-17 07:04:00 -05:00
b , err := conv . Convert ( converter . RenderContext { Src : [ ] byte ( content ) , GetRenderer : getRenderer } )
2019-11-06 14:10:47 -05:00
c . Assert ( err , qt . IsNil )
return string ( b . Bytes ( ) )
}
c . Run ( "Basic" , func ( c * qt . C ) {
2023-01-04 12:24:36 -05:00
confStr := `
[ markup ]
[ markup . highlight ]
noclasses = false
`
2019-11-06 14:10:47 -05:00
2023-01-04 12:24:36 -05:00
result := convertForConfig ( c , confStr , ` echo "Hugo Rocks!" ` , "bash" )
2019-11-06 14:10:47 -05:00
// TODO(bep) there is a whitespace mismatch (\n) between this and the highlight template func.
2022-02-14 07:27:17 -05:00
c . Assert ( result , qt . Equals , "<div class=\"highlight\"><pre tabindex=\"0\" class=\"chroma\"><code class=\"language-bash\" data-lang=\"bash\"><span class=\"line\"><span class=\"cl\"><span class=\"nb\">echo</span> <span class=\"s2\">"Hugo Rocks!"</span>\n</span></span></code></pre></div>" )
2023-01-04 12:24:36 -05:00
result = convertForConfig ( c , confStr , ` echo "Hugo Rocks!" ` , "unknown" )
2022-02-17 07:04:00 -05:00
c . Assert ( result , qt . Equals , "<pre tabindex=\"0\"><code class=\"language-unknown\" data-lang=\"unknown\">echo "Hugo Rocks!"\n</code></pre>" )
2019-11-06 14:10:47 -05:00
} )
c . Run ( "Highlight lines, default config" , func ( c * qt . C ) {
2023-01-04 12:24:36 -05:00
result := convertForConfig ( c , cfgStrHighlichgtNoClasses , lines , ` bash { linenos=table,hl_lines=[2 "4-5"],linenostart=3} ` )
2021-07-15 10:48:39 -04:00
c . Assert ( result , qt . Contains , "<div class=\"highlight\"><div class=\"chroma\">\n<table class=\"lntable\"><tr><td class=\"lntd\">\n<pre tabindex=\"0\" class=\"chroma\"><code><span class" )
2019-11-06 14:10:47 -05:00
c . Assert ( result , qt . Contains , "<span class=\"hl\"><span class=\"lnt\">4" )
2023-01-04 12:24:36 -05:00
result = convertForConfig ( c , cfgStrHighlichgtNoClasses , lines , "bash {linenos=inline,hl_lines=[2]}" )
2022-02-14 07:27:17 -05:00
c . Assert ( result , qt . Contains , "<span class=\"ln\">2</span><span class=\"cl\">LINE2\n</span></span>" )
2019-11-06 14:10:47 -05:00
c . Assert ( result , qt . Not ( qt . Contains ) , "<table" )
2023-01-04 12:24:36 -05:00
result = convertForConfig ( c , cfgStrHighlichgtNoClasses , lines , "bash {linenos=true,hl_lines=[2]}" )
2019-11-06 14:10:47 -05:00
c . Assert ( result , qt . Contains , "<table" )
c . Assert ( result , qt . Contains , "<span class=\"hl\"><span class=\"lnt\">2\n</span>" )
} )
c . Run ( "Highlight lines, linenumbers default on" , func ( c * qt . C ) {
2023-01-04 12:24:36 -05:00
confStr := `
[ markup ]
[ markup . highlight ]
noclasses = false
linenos = true
`
2019-11-06 14:10:47 -05:00
2023-01-04 12:24:36 -05:00
result := convertForConfig ( c , confStr , lines , "bash" )
2019-11-06 14:10:47 -05:00
c . Assert ( result , qt . Contains , "<span class=\"lnt\">2\n</span>" )
2023-01-04 12:24:36 -05:00
result = convertForConfig ( c , confStr , lines , "bash {linenos=false,hl_lines=[2]}" )
2019-11-06 14:10:47 -05:00
c . Assert ( result , qt . Not ( qt . Contains ) , "class=\"lnt\"" )
} )
c . Run ( "Highlight lines, linenumbers default on, linenumbers in table default off" , func ( c * qt . C ) {
2023-01-04 12:24:36 -05:00
confStr := `
[ markup ]
[ markup . highlight ]
noClasses = false
lineNos = true
lineNumbersInTable = false
`
2019-11-06 14:10:47 -05:00
2023-01-04 12:24:36 -05:00
result := convertForConfig ( c , confStr , lines , "bash" )
2022-02-14 07:27:17 -05:00
c . Assert ( result , qt . Contains , "<span class=\"ln\">2</span><span class=\"cl\">LINE2\n</span>" )
2023-01-04 12:24:36 -05:00
result = convertForConfig ( c , confStr , lines , "bash {linenos=table}" )
2019-11-06 14:10:47 -05:00
c . Assert ( result , qt . Contains , "<span class=\"lnt\">1\n</span>" )
} )
2019-12-02 02:31:23 -05:00
c . Run ( "No language" , func ( c * qt . C ) {
2023-01-04 12:24:36 -05:00
confStr := `
[ markup ]
[ markup . highlight ]
noClasses = false
lineNos = true
lineNumbersInTable = false
`
2019-12-02 02:31:23 -05:00
cfg := highlight . DefaultConfig
cfg . NoClasses = false
cfg . LineNos = true
cfg . LineNumbersInTable = false
2023-01-04 12:24:36 -05:00
result := convertForConfig ( c , confStr , lines , "" )
2021-08-22 10:03:20 -04:00
c . Assert ( result , qt . Contains , "<pre tabindex=\"0\"><code>LINE1\n" )
2019-12-02 02:31:23 -05:00
} )
c . Run ( "No language, guess syntax" , func ( c * qt . C ) {
2023-01-04 12:24:36 -05:00
confStr := `
[ markup ]
[ markup . highlight ]
noClasses = false
lineNos = true
lineNumbersInTable = false
guessSyntax = true
`
2019-12-02 02:31:23 -05:00
2023-01-04 12:24:36 -05:00
result := convertForConfig ( c , confStr , lines , "" )
2022-02-14 07:27:17 -05:00
c . Assert ( result , qt . Contains , "<span class=\"ln\">2</span><span class=\"cl\">LINE2\n</span></span>" )
2019-12-02 02:31:23 -05:00
} )
2019-11-06 14:10:47 -05:00
}
2023-04-12 04:15:02 -04:00
func TestTypographerConfig ( t * testing . T ) {
c := qt . New ( t )
content := `
A "quote" and ' another quote ' and a "quote with a 'nested' quote" and a ' quote with a "nested" quote ' and an ellipsis ...
`
2023-01-04 12:24:36 -05:00
confStr := `
[ markup ]
[ markup . goldmark ]
[ markup . goldmark . extensions ]
[ markup . goldmark . extensions . typographer ]
leftDoubleQuote = "«"
rightDoubleQuote = "»"
`
cfg := config . FromTOMLConfigString ( confStr )
conf := testconfig . GetTestConfig ( nil , cfg )
b := convert ( c , conf , content )
2023-04-12 04:15:02 -04:00
got := string ( b . Bytes ( ) )
c . Assert ( got , qt . Contains , "<p>A «quote» and ‘another quote’ and a «quote with a ’nested’ quote» and a ‘quote with a «nested» quote’ and an ellipsis…</p>\n" )
}
2023-01-04 12:24:36 -05:00
2023-05-30 07:21:45 -04:00
// Issue #11045
func TestTypographerImageAltText ( t * testing . T ) {
c := qt . New ( t )
content := `
! [ "They didn't even say 'hello'!" I exclaimed . ] ( https : //example.com/image.jpg)
`
confStr := `
[ markup ]
[ markup . goldmark ]
`
cfg := config . FromTOMLConfigString ( confStr )
conf := testconfig . GetTestConfig ( nil , cfg )
b := convert ( c , conf , content )
got := string ( b . Bytes ( ) )
c . Assert ( got , qt . Contains , "“They didn’t even say ‘hello’!” I exclaimed." )
}
2023-01-04 12:24:36 -05:00
func unsafeConf ( ) config . AllProvider {
cfg := config . FromTOMLConfigString ( `
[ markup ]
[ markup . goldmark . renderer ]
unsafe = true
` )
return testconfig . GetTestConfig ( nil , cfg )
}
2023-08-30 07:08:45 -04:00
func TestConvertCJK ( t * testing . T ) {
c := qt . New ( t )
content := `
私は太郎です 。
プログラミングが好きです 。 \ 運動が苦手です 。
`
confStr := `
[ markup ]
[ markup . goldmark ]
`
cfg := config . FromTOMLConfigString ( confStr )
conf := testconfig . GetTestConfig ( nil , cfg )
b := convert ( c , conf , content )
got := string ( b . Bytes ( ) )
c . Assert ( got , qt . Contains , "<p>私は太郎です。\nプログラミングが好きです。\\ 運動が苦手です。</p>\n" )
}
func TestConvertCJKWithExtensionWithEastAsianLineBreaksOption ( t * testing . T ) {
c := qt . New ( t )
content := `
私は太郎です 。
プログラミングが好きで 、
運動が苦手です 。
`
confStr := `
[ markup ]
[ markup . goldmark ]
[ markup . goldmark . extensions . CJK ]
enable = true
eastAsianLineBreaks = true
`
cfg := config . FromTOMLConfigString ( confStr )
conf := testconfig . GetTestConfig ( nil , cfg )
b := convert ( c , conf , content )
got := string ( b . Bytes ( ) )
c . Assert ( got , qt . Contains , "<p>私は太郎です。プログラミングが好きで、運動が苦手です。</p>\n" )
}
2023-10-29 05:13:56 -04:00
func TestConvertCJKWithExtensionWithEastAsianLineBreaksOptionWithSimple ( t * testing . T ) {
c := qt . New ( t )
content := `
私は太郎です 。
Programming が好きで 、
運動が苦手です 。
`
confStr := `
[ markup ]
[ markup . goldmark ]
[ markup . goldmark . extensions . CJK ]
enable = true
eastAsianLineBreaks = true
eastAsianLineBreaksStyle = "simple"
`
cfg := config . FromTOMLConfigString ( confStr )
conf := testconfig . GetTestConfig ( nil , cfg )
b := convert ( c , conf , content )
got := string ( b . Bytes ( ) )
c . Assert ( got , qt . Contains , "<p>私は太郎です。\nProgramming が好きで、運動が苦手です。</p>\n" )
}
func TestConvertCJKWithExtensionWithEastAsianLineBreaksOptionWithStyle ( t * testing . T ) {
c := qt . New ( t )
content := `
私は太郎です 。
Programming が好きで 、
運動が苦手です 。
`
confStr := `
[ markup ]
[ markup . goldmark ]
[ markup . goldmark . extensions . CJK ]
enable = true
eastAsianLineBreaks = true
eastAsianLineBreaksStyle = "css3draft"
`
cfg := config . FromTOMLConfigString ( confStr )
conf := testconfig . GetTestConfig ( nil , cfg )
b := convert ( c , conf , content )
got := string ( b . Bytes ( ) )
c . Assert ( got , qt . Contains , "<p>私は太郎です。Programming が好きで、運動が苦手です。</p>\n" )
}
2023-08-30 07:08:45 -04:00
func TestConvertCJKWithExtensionWithEscapedSpaceOption ( t * testing . T ) {
c := qt . New ( t )
content := `
私は太郎です 。
プログラミングが好きです 。 \ 運動が苦手です 。
`
confStr := `
[ markup ]
[ markup . goldmark ]
[ markup . goldmark . extensions . CJK ]
enable = true
escapedSpace = true
`
cfg := config . FromTOMLConfigString ( confStr )
conf := testconfig . GetTestConfig ( nil , cfg )
b := convert ( c , conf , content )
got := string ( b . Bytes ( ) )
c . Assert ( got , qt . Contains , "<p>私は太郎です。\nプログラミングが好きです。運動が苦手です。</p>\n" )
}