// 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 goldmark_test import ( "strings" "testing" "github.com/gohugoio/hugo/common/loggers" "github.com/gohugoio/hugo/config/testconfig" "github.com/gohugoio/hugo/markup/converter/hooks" "github.com/gohugoio/hugo/markup/goldmark" "github.com/gohugoio/hugo/markup/converter" qt "github.com/frankban/quicktest" ) var nopGetRenderer = func(t hooks.RendererType, id any) any { return nil } func TestToc(t *testing.T) { c := qt.New(t) content := ` # Header 1 ## First h2---now with typography! Some text. ### H3 Some more text. ## Second h2 And then some. ### Second H3 #### First H4 ` p, err := goldmark.Provider.New( converter.ProviderConfig{ Conf: testconfig.GetTestConfig(nil, nil), Logger: loggers.NewDefault(), }) c.Assert(err, qt.IsNil) conv, err := p.New(converter.DocumentContext{}) c.Assert(err, qt.IsNil) b, err := conv.Convert(converter.RenderContext{Src: []byte(content), RenderTOC: true, GetRenderer: nopGetRenderer}) c.Assert(err, qt.IsNil) tocHTML := b.(converter.TableOfContentsProvider).TableOfContents().ToHTML(2, 3, false) got := string(tocHTML) c.Assert(got, qt.Equals, ``, qt.Commentf(got)) } func TestEscapeToc(t *testing.T) { c := qt.New(t) safeP, _ := goldmark.Provider.New( converter.ProviderConfig{ Conf: safeConf(), Logger: loggers.NewDefault(), }) unsafeP, _ := goldmark.Provider.New( converter.ProviderConfig{ Conf: unsafeConf(), Logger: loggers.NewDefault(), }) safeConv, _ := safeP.New(converter.DocumentContext{}) unsafeConv, _ := unsafeP.New(converter.DocumentContext{}) content := strings.Join([]string{ "# A < B & C > D", "# A < B & C > D
foo
", "# *EMPHASIS*", "# `echo codeblock`", }, "\n") // content := "" b, err := safeConv.Convert(converter.RenderContext{Src: []byte(content), RenderTOC: true, GetRenderer: nopGetRenderer}) c.Assert(err, qt.IsNil) tocHTML := b.(converter.TableOfContentsProvider).TableOfContents().ToHTML(1, 2, false) got := string(tocHTML) c.Assert(got, qt.Equals, ``, qt.Commentf(got)) b, err = unsafeConv.Convert(converter.RenderContext{Src: []byte(content), RenderTOC: true, GetRenderer: nopGetRenderer}) c.Assert(err, qt.IsNil) tocHTML = b.(converter.TableOfContentsProvider).TableOfContents().ToHTML(1, 2, false) got = string(tocHTML) c.Assert(got, qt.Equals, ``, qt.Commentf(got)) }