generate.go

package main

import (
	"fmt"
	"io"
	"log"

	mdfmt "github.com/Kunde21/markdownfmt/v3/markdown"
	"github.com/yuin/goldmark/ast"
)

type generator struct {
	headingIdx int

	Preface  []byte
	W        io.Writer       // required
	Renderer *mdfmt.Renderer // required
	Log      *log.Logger
	NoTOC    bool

	NoSectionTitle bool
}

func (g *generator) Generate(src []byte, coll *markdownCollection) error {
	if _, err := g.W.Write(g.Preface); err != nil {
		return err
	}

	for _, sec := range coll.Sections {
		if err := g.renderSection(src, sec); err != nil {
			return err
		}
		if err := sec.Items.Walk(g.renderItem); err != nil {
			return err
		}
	}
	return nil
}

func (g *generator) renderSection(src []byte, sec *markdownSection) error {
	var nodes []ast.Node
	if t := sec.Title; !g.NoSectionTitle && t != nil {
		nodes = append(nodes, t)
	}
	if !g.NoTOC {
		nodes = append(nodes, sec.TOCItems)
	}

	for _, n := range nodes {
		if err := g.Renderer.Render(g.W, src, n); err != nil {
			return err
		}
	}

	if len(nodes) > 0 {
		_, _ = io.WriteString(g.W, "\n\n")
	}
	return nil
}

func (g *generator) addHeadingSep() {
	if g.headingIdx > 0 {
		_, _ = io.WriteString(g.W, "\n")
	}
	g.headingIdx++
}

func (g *generator) renderItem(item markdownItem) error {
	switch item := item.(type) {
	case *markdownGroupItem:
		return g.renderGroupItem(item)

	case *markdownFileItem:
		return g.renderFileItem(item)

	case *markdownEmbedItem:
		return g.renderEmbedItem(item)

	case *markdownExternalLinkItem:
		// Nothing to do.
		// The item was already rendered in the TOC.
		return nil

	default:
		panic(fmt.Sprintf("unknown markdown item type %T", item))
	}
}

func (g *generator) renderGroupItem(group *markdownGroupItem) error {
	g.addHeadingSep()
	if err := g.Renderer.Render(g.W, group.src, group.Heading.AST); err != nil {
		return err
	}
	_, _ = io.WriteString(g.W, "\n")
	return nil
}

func (g *generator) renderEmbedItem(embed *markdownEmbedItem) error {
	g.addHeadingSep()
	if err := g.Renderer.Render(g.W, embed.SummaryFile.Source, embed.Heading.AST); err != nil {
		return err
	}

	_, _ = io.WriteString(g.W, "\n")

	return (&generator{
		W:              g.W,
		Renderer:       g.Renderer,
		Log:            g.Log,
		NoTOC:          true,
		NoSectionTitle: true,
		headingIdx:     g.headingIdx,
	}).Generate(embed.SummaryFile.Source, &markdownCollection{
		Sections:    []*markdownSection{embed.Section},
		FilesByPath: embed.FilesByPath,
	})
}

func (g *generator) renderFileItem(file *markdownFileItem) error {
	g.addHeadingSep()
	return g.Renderer.Render(g.W, file.File.Source, file.File.AST)
}