feat(renderer): support 'toc-title' attribute (#918)

Parse the `toc-title` attribute value during rendering Fixes #915 Signed-off-by: Xavier Coulon <[email protected]>
bytesparadise · Jan 30, 2022 · b8f27ce · b8f27ce
1 parent 397035b
commit b8f27ce
Show file tree

Hide file tree

Showing 183 changed files with 5,567 additions and 5,277 deletions.
diff --git a/cmd/libasciidoc/cmd_suite_test.go b/cmd/libasciidoc/cmd_suite_test.go
@@ -1,8 +1,8 @@
 package main_test
 
 import (
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golintt
 
 	"testing"
 

diff --git a/cmd/libasciidoc/root_cmd.go b/cmd/libasciidoc/root_cmd.go
@@ -52,7 +52,7 @@ func NewRootCmd() *cobra.Command {
 			for _, sourcePath := range args {
 				out, close := getOut(cmd, sourcePath, outputName)
 				if out != nil {
-					defer close() //nolint errcheck
+					defer close() // nolint errcheck
 					// log.Debugf("Starting to process file %v", path)
 					config := configuration.NewConfiguration(
 						configuration.WithFilename(sourcePath),

diff --git a/cmd/libasciidoc/root_cmd_test.go b/cmd/libasciidoc/root_cmd_test.go
@@ -6,8 +6,8 @@ import (
 
 	main "github.com/bytesparadise/libasciidoc/cmd/libasciidoc"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golintt
 )
 
 var _ = Describe("root cmd", func() {

diff --git a/cmd/libasciidoc/version_cmd_test.go b/cmd/libasciidoc/version_cmd_test.go
@@ -5,8 +5,8 @@ import (
 
 	main "github.com/bytesparadise/libasciidoc/cmd/libasciidoc"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golintt
 )
 
 var _ = Describe("version cmd", func() {

diff --git a/libasciidoc_suite_test.go b/libasciidoc_suite_test.go
@@ -3,8 +3,8 @@ package libasciidoc_test
 import (
 	"testing"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 func TestLibasciidoc(t *testing.T) {

diff --git a/libasciidoc_test.go b/libasciidoc_test.go
@@ -10,8 +10,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golintt
 	log "github.com/sirupsen/logrus"
 )
 

diff --git a/pkg/parser/attribute_substitution_test.go b/pkg/parser/attribute_substitution_test.go
@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 var _ = Describe("attribute substitutions", func() {

diff --git a/pkg/parser/attributes_test.go b/pkg/parser/attributes_test.go
@@ -8,9 +8,9 @@ import (
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 	log "github.com/sirupsen/logrus"
 
-	. "github.com/onsi/ginkgo"                  //nolint golint
-	. "github.com/onsi/ginkgo/extensions/table" //nolint golint
-	. "github.com/onsi/gomega"                  //nolint golint
+	. "github.com/onsi/ginkgo"                  // nolint:golint
+	. "github.com/onsi/ginkgo/extensions/table" // nolint:golint
+	. "github.com/onsi/gomega"                  // nolint:golint
 )
 
 var _ = Describe("attributes", func() {

diff --git a/pkg/parser/bench_test.go b/pkg/parser/bench_test.go
@@ -10,9 +10,9 @@ import (
 
 	"github.com/bytesparadise/libasciidoc/pkg/parser"
 
-	. "github.com/onsi/ginkgo"                  //nolint golint
-	. "github.com/onsi/ginkgo/extensions/table" //nolint golint
-	. "github.com/onsi/gomega"                  //nolint golint
+	. "github.com/onsi/ginkgo"                  // nolint:golint
+	. "github.com/onsi/ginkgo/extensions/table" // nolint:golint
+	. "github.com/onsi/gomega"                  // nolint:golint
 )
 
 const (

diff --git a/pkg/parser/blank_line_test.go b/pkg/parser/blank_line_test.go
@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golintt
 )
 
 var _ = Describe("blank lines", func() {

diff --git a/pkg/parser/check_list_test.go b/pkg/parser/check_list_test.go
@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 var _ = Describe("checked lists", func() {

diff --git a/pkg/parser/comment_test.go b/pkg/parser/comment_test.go
@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golintt
 )
 
 var _ = Describe("comments", func() {

diff --git a/pkg/parser/cross_reference_test.go b/pkg/parser/cross_reference_test.go
@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 var _ = Describe("cross references", func() {

diff --git a/pkg/parser/delimited_block_admonition_test.go b/pkg/parser/delimited_block_admonition_test.go
@@ -3,8 +3,8 @@ package parser_test
 import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 var _ = Describe("admonition blocks", func() {

diff --git a/pkg/parser/delimited_block_example_test.go b/pkg/parser/delimited_block_example_test.go
@@ -7,8 +7,8 @@ import (
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 	log "github.com/sirupsen/logrus"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 var _ = Describe("example blocks", func() {

diff --git a/pkg/parser/delimited_block_fenced_test.go b/pkg/parser/delimited_block_fenced_test.go
@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 var _ = Describe("fenced blocks", func() {

diff --git a/pkg/parser/delimited_block_listing_test.go b/pkg/parser/delimited_block_listing_test.go
@@ -7,8 +7,8 @@ import (
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 	log "github.com/sirupsen/logrus"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 var _ = Describe("listing blocks", func() {

diff --git a/pkg/parser/delimited_block_literal_test.go b/pkg/parser/delimited_block_literal_test.go
@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 var _ = Describe("literal blocks", func() {

diff --git a/pkg/parser/delimited_block_markdown_quote_test.go b/pkg/parser/delimited_block_markdown_quote_test.go
@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golintt
 )
 
 var _ = Describe("markdown-style quote blocks", func() {

diff --git a/pkg/parser/delimited_block_passthrough_test.go b/pkg/parser/delimited_block_passthrough_test.go
@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 var _ = Describe("passthrough blocks", func() {

diff --git a/pkg/parser/delimited_block_quote_test.go b/pkg/parser/delimited_block_quote_test.go
@@ -5,8 +5,8 @@ import (
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 	log "github.com/sirupsen/logrus"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golintt
 )
 
 var _ = Describe("quote blocks", func() {

diff --git a/pkg/parser/delimited_block_sidebar_test.go b/pkg/parser/delimited_block_sidebar_test.go
@@ -5,8 +5,8 @@ import (
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 	log "github.com/sirupsen/logrus"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golintt
 )
 
 var _ = Describe("sidebar blocks", func() {

diff --git a/pkg/parser/delimited_block_source_test.go b/pkg/parser/delimited_block_source_test.go
@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golintt
 )
 
 var _ = Describe("source blocks", func() {

diff --git a/pkg/parser/delimited_block_verse_test.go b/pkg/parser/delimited_block_verse_test.go
@@ -6,8 +6,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 var _ = Describe("verse blocks", func() {

diff --git a/pkg/parser/document_fragment_processing_test.go b/pkg/parser/document_fragment_processing_test.go
@@ -5,8 +5,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 var _ = Describe("document processing", func() {

diff --git a/pkg/parser/document_header_test.go b/pkg/parser/document_header_test.go
@@ -5,8 +5,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 var _ = Describe("headers", func() {

diff --git a/pkg/parser/document_preprocessing_builder_test.go b/pkg/parser/document_preprocessing_builder_test.go
@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/configuration"
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 var _ = Describe("preprocessing condition stack", func() {

diff --git a/pkg/parser/document_preprocessing_conditionals_test.go b/pkg/parser/document_preprocessing_conditionals_test.go
@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/configuration"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golintt
 )
 
 var _ = Describe("conditional inclusions", func() {

diff --git a/pkg/parser/document_preprocessing_include_files_test.go b/pkg/parser/document_preprocessing_include_files_test.go
@@ -8,8 +8,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golintt
 	log "github.com/sirupsen/logrus"
 )
 

diff --git a/pkg/parser/document_processing_aggregate_test.go b/pkg/parser/document_processing_aggregate_test.go
@@ -6,8 +6,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 var _ = Describe("include preamble and table of contents when aggregating fragments", func() {

diff --git a/pkg/parser/document_processing_apply_substitutions.go b/pkg/parser/document_processing_apply_substitutions.go
@@ -590,7 +590,7 @@ const (
 	// Callouts the "callouts" substitution
 	Callouts string = "callouts"
 	// InlinePassthroughs the "inline_passthrough" substitution
-	InlinePassthroughs string = "inline_passthrough" // nolint: gosec
+	InlinePassthroughs string = "inline_passthrough" // nolint:gosec
 	// Macros the "macros" substitution
 	Macros string = "macros"
 	// None the "none" substitution

diff --git a/pkg/parser/document_processing_apply_substitutions_test.go b/pkg/parser/document_processing_apply_substitutions_test.go
@@ -6,8 +6,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 var _ = Describe("apply substitutions", func() {

diff --git a/pkg/parser/document_processing_collect_footnotes_test.go b/pkg/parser/document_processing_collect_footnotes_test.go
@@ -5,8 +5,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 var _ = Describe("collect footnotes", func() {

diff --git a/pkg/parser/document_processing_filter_elements_test.go b/pkg/parser/document_processing_filter_elements_test.go
@@ -3,8 +3,8 @@ package parser
 import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 var _ = Describe("element filters", func() {

diff --git a/pkg/parser/document_processing_insert_preamble_test.go b/pkg/parser/document_processing_insert_preamble_test.go
@@ -3,8 +3,8 @@ package parser
 import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 var _ = Describe("insert preambles", func() {

diff --git a/pkg/parser/document_processing_parse_fragments_test.go b/pkg/parser/document_processing_parse_fragments_test.go
@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo" //nolint golint
-	. "github.com/onsi/gomega" //nolint golint
+	. "github.com/onsi/ginkgo" // nolint:golint
+	. "github.com/onsi/gomega" // nolint:golint
 )
 
 var _ = Describe("document fragment parsing", func() {