12999379643

Committed 27 Jan 2025 10:16PM CUT coverage: 65.591%. Remained the same

Build # 12999379643

Build Type

push

github

Committed by

web-flow

Commit Message

Use Hugo fork with Mojo lexer for docs (#132)

Run Details

1098 of 1674 relevant lines covered (65.59%)

31.25 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

9.57

/format/mdbook.go

package format

import (
        "fmt"
        "io"
        "io/fs"
        "os"
        "path"
        "strings"
        "text/template"

        "github.com/mlange-42/modo/assets"
        "github.com/mlange-42/modo/document"
)

type MdBook struct{}

func (f *MdBook) Accepts(files []string) error {
        if len(files) > 1 {
                return fmt.Errorf("mdBook formatter can process only a single JSON file, but %d is given", len(files))
        }
        if len(files) == 0 || files[0] == "" {
                return nil
        }
        if s, err := os.Stat(files[0]); err == nil {
                if s.IsDir() {
                        return fmt.Errorf("mdBook formatter can process only a single JSON file, but directory '%s' is given", files[0])
                }
        } else {
                return err
        }
        return nil
}

func (f *MdBook) ProcessMarkdown(element any, text string, proc *document.Processor) (string, error) {
        return text, nil
}

func (f *MdBook) WriteAuxiliary(p *document.Package, dir string, proc *document.Processor) error {
        if err := f.writeSummary(p, dir, proc); err != nil {
                return err
        }
        if err := f.writeToml(p, dir, proc); err != nil {
                return err
        }
        if err := f.writeCss(dir, proc); err != nil {
                return err
        }
        return nil
}

func (f *MdBook) ToFilePath(p string, kind string) string {
        if kind == "package" || kind == "module" {
                return path.Join(p, "_index.md")
        }
        if len(p) == 0 {
                return p
        }
        return p + ".md"
}

func (f *MdBook) ToLinkPath(p string, kind string) string {
        return f.ToFilePath(p, kind)
}

type summary struct {
        Summary   string
        Packages  string
        Modules   string
        Structs   string
        Traits    string
        Functions string
}

func (f *MdBook) writeSummary(p *document.Package, dir string, proc *document.Processor) error {
        summary, err := f.renderSummary(p, proc)
        if err != nil {
                return err
        }
        summaryPath := path.Join(dir, p.GetFileName(), "SUMMARY.md")
        if proc.Config.DryRun {
                return nil
        }
        if err := os.WriteFile(summaryPath, []byte(summary), 0644); err != nil {
                return err
        }
        return nil
}

func (f *MdBook) renderSummary(p *document.Package, proc *document.Processor) (string, error) {
        s := summary{}

        pkgFile := f.ToLinkPath("", "package")
        s.Summary = fmt.Sprintf("[`%s`](%s)", p.GetName(), pkgFile)

        pkgs := strings.Builder{}
        for _, p := range p.Packages {
                if err := f.renderPackage(p, proc.Template, nil, &pkgs); err != nil {
                        return "", err
                }
        }
        s.Packages = pkgs.String()

        mods := strings.Builder{}
        for _, m := range p.Modules {
                if err := f.renderModule(m, nil, &mods); err != nil {
                        return "", err
                }
        }
        s.Modules = mods.String()

        elems := strings.Builder{}
        for _, elem := range p.Structs {
                if err := f.renderModuleMember(elem, "", 0, &elems); err != nil {
                        return "", err
                }
        }
        s.Structs = elems.String()
        elems = strings.Builder{}
        for _, elem := range p.Traits {
                if err := f.renderModuleMember(elem, "", 0, &elems); err != nil {
                        return "", err
                }
        }
        s.Traits = elems.String()
        elems = strings.Builder{}
        for _, elem := range p.Functions {
                if err := f.renderModuleMember(elem, "", 0, &elems); err != nil {
                        return "", err
                }
        }
        s.Functions = elems.String()

        b := strings.Builder{}
        if err := proc.Template.ExecuteTemplate(&b, "mdbook_summary.md", &s); err != nil {
                return "", err
        }

        return b.String(), nil
}

func (f *MdBook) renderPackage(pkg *document.Package, t *template.Template, linkPath []string, out *strings.Builder) error {
        newPath := append([]string{}, linkPath...)
        newPath = append(newPath, pkg.GetFileName())

        pkgFile := f.ToLinkPath(path.Join(newPath...), "package")
        fmt.Fprintf(out, "%-*s- [`%s`](%s))\n", 2*len(linkPath), "", pkg.GetName(), pkgFile)
        for _, p := range pkg.Packages {
                if err := f.renderPackage(p, t, newPath, out); err != nil {
                        return err
                }
        }
        for _, m := range pkg.Modules {
                if err := f.renderModule(m, newPath, out); err != nil {
                        return err
                }
        }

        pathStr := path.Join(newPath...)
        childDepth := 2*(len(newPath)-1) + 2
        for _, elem := range pkg.Structs {
                if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {
                        return err
                }
        }
        for _, elem := range pkg.Traits {
                if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {
                        return err
                }
        }
        for _, elem := range pkg.Functions {
                if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {
                        return err
                }
        }

        return nil
}

func (f *MdBook) renderModule(mod *document.Module, linkPath []string, out *strings.Builder) error {
        newPath := append([]string{}, linkPath...)
        newPath = append(newPath, mod.GetFileName())

        pathStr := path.Join(newPath...)

        modFile := f.ToLinkPath(pathStr, "module")
        fmt.Fprintf(out, "%-*s- [`%s`](%s)\n", 2*(len(newPath)-1), "", mod.GetName(), modFile)

        childDepth := 2*(len(newPath)-1) + 2
        for _, elem := range mod.Structs {
                if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {
                        return err
                }
        }
        for _, elem := range mod.Traits {
                if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {
                        return err
                }
        }
        for _, elem := range mod.Functions {
                if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {
                        return err
                }
        }
        return nil
}

func (f *MdBook) renderModuleMember(mem document.Named, pathStr string, depth int, out io.Writer) error {
        memPath := f.ToLinkPath(path.Join(pathStr, mem.GetFileName(), ""), "")
        fmt.Fprintf(out, "%-*s- [`%s`](%s)\n", depth, "", mem.GetName(), memPath)
        return nil
}

func (f *MdBook) writeToml(p *document.Package, dir string, proc *document.Processor) error {
        toml, err := f.renderToml(p, proc.Template)
        if err != nil {
                return err
        }
        if proc.Config.DryRun {
                return nil
        }
        tomlPath := path.Join(dir, "book.toml")
        if err := os.WriteFile(tomlPath, []byte(toml), 0644); err != nil {
                return err
        }
        return nil
}

func (f *MdBook) renderToml(p *document.Package, t *template.Template) (string, error) {
        b := strings.Builder{}
        if err := t.ExecuteTemplate(&b, "book.toml", p); err != nil {
                return "", err
        }
        return b.String(), nil
}

func (f *MdBook) writeCss(dir string, proc *document.Processor) error {
        cssDir := path.Join(dir, "css")
        if !proc.Config.DryRun {
                if err := os.MkdirAll(cssDir, os.ModePerm); err != nil && !os.IsExist(err) {
                        return err
                }
        }
        css, err := fs.ReadFile(assets.CSS, "css/mdbook.css")
        if err != nil {
                return err
        }
        if !proc.Config.DryRun {
                if err := os.WriteFile(path.Join(cssDir, "custom.css"), css, 0644); err != nil {
                        return err
                }
        }
        return nil
}

1	package format
2
3	import (
4	"fmt"
5	"io"
6	"io/fs"
7	"os"
8	"path"
9	"strings"
10	"text/template"
11
12	"github.com/mlange-42/modo/assets"
13	"github.com/mlange-42/modo/document"
14	)
15
16	type MdBook struct{}
17
18	func (f *MdBook) Accepts(files []string) error {	2✔
19	if len(files) > 1 {	3✔
20	return fmt.Errorf("mdBook formatter can process only a single JSON file, but %d is given", len(files))	1✔
21	}	1✔
22	if len(files) == 0 \|\| files[0] == "" {	1✔
23	return nil	×
24	}	×
25	if s, err := os.Stat(files[0]); err == nil {	2✔
26	if s.IsDir() {	2✔
27	return fmt.Errorf("mdBook formatter can process only a single JSON file, but directory '%s' is given", files[0])	1✔
28	}	1✔
29	} else {	×
30	return err	×
31	}	×
32	return nil	×
33	}
34
35	func (f MdBook) ProcessMarkdown(element any, text string, proc document.Processor) (string, error) {	×
36	return text, nil	×
37	}	×
38
39	func (f MdBook) WriteAuxiliary(p document.Package, dir string, proc *document.Processor) error {	×
40	if err := f.writeSummary(p, dir, proc); err != nil {	×
41	return err	×
42	}	×
43	if err := f.writeToml(p, dir, proc); err != nil {	×
44	return err	×
45	}	×
46	if err := f.writeCss(dir, proc); err != nil {	×
47	return err	×
48	}	×
49	return nil	×
50	}
51
52	func (f *MdBook) ToFilePath(p string, kind string) string {	6✔
53	if kind == "package" \|\| kind == "module" {	10✔
54	return path.Join(p, "_index.md")	4✔
55	}	4✔
56	if len(p) == 0 {	2✔
57	return p	×
58	}	×
59	return p + ".md"	2✔
60	}
61
62	func (f *MdBook) ToLinkPath(p string, kind string) string {	3✔
63	return f.ToFilePath(p, kind)	3✔
64	}	3✔
65
66	type summary struct {
67	Summary string
68	Packages string
69	Modules string
70	Structs string
71	Traits string
72	Functions string
73	}
74
75	func (f MdBook) writeSummary(p document.Package, dir string, proc *document.Processor) error {	×
76	summary, err := f.renderSummary(p, proc)	×
77	if err != nil {	×
78	return err	×
79	}	×
80	summaryPath := path.Join(dir, p.GetFileName(), "SUMMARY.md")	×
81	if proc.Config.DryRun {	×
82	return nil	×
83	}	×
84	if err := os.WriteFile(summaryPath, []byte(summary), 0644); err != nil {	×
85	return err	×
86	}	×
87	return nil	×
88	}
89
90	func (f MdBook) renderSummary(p document.Package, proc *document.Processor) (string, error) {	×
91	s := summary{}	×
92		×
93	pkgFile := f.ToLinkPath("", "package")	×
94	s.Summary = fmt.Sprintf("[`%s`](%s)", p.GetName(), pkgFile)	×
95		×
96	pkgs := strings.Builder{}	×
97	for _, p := range p.Packages {	×
98	if err := f.renderPackage(p, proc.Template, nil, &pkgs); err != nil {	×
99	return "", err	×
100	}	×
101	}
102	s.Packages = pkgs.String()	×
103		×
104	mods := strings.Builder{}	×
105	for _, m := range p.Modules {	×
106	if err := f.renderModule(m, nil, &mods); err != nil {	×
107	return "", err	×
108	}	×
109	}
110	s.Modules = mods.String()	×
111		×
112	elems := strings.Builder{}	×
113	for _, elem := range p.Structs {	×
114	if err := f.renderModuleMember(elem, "", 0, &elems); err != nil {	×
115	return "", err	×
116	}	×
117	}
118	s.Structs = elems.String()	×
119	elems = strings.Builder{}	×
120	for _, elem := range p.Traits {	×
121	if err := f.renderModuleMember(elem, "", 0, &elems); err != nil {	×
122	return "", err	×
123	}	×
124	}
125	s.Traits = elems.String()	×
126	elems = strings.Builder{}	×
127	for _, elem := range p.Functions {	×
128	if err := f.renderModuleMember(elem, "", 0, &elems); err != nil {	×
129	return "", err	×
130	}	×
131	}
132	s.Functions = elems.String()	×
133		×
134	b := strings.Builder{}	×
135	if err := proc.Template.ExecuteTemplate(&b, "mdbook_summary.md", &s); err != nil {	×
136	return "", err	×
137	}	×
138
139	return b.String(), nil	×
140	}
141
142	func (f MdBook) renderPackage(pkg document.Package, t template.Template, linkPath []string, out strings.Builder) error {	×
143	newPath := append([]string{}, linkPath...)	×
144	newPath = append(newPath, pkg.GetFileName())	×
145		×
146	pkgFile := f.ToLinkPath(path.Join(newPath...), "package")	×
147	fmt.Fprintf(out, "%-s- [`%s`](%s))\n", 2len(linkPath), "", pkg.GetName(), pkgFile)	×
148	for _, p := range pkg.Packages {	×
149	if err := f.renderPackage(p, t, newPath, out); err != nil {	×
150	return err	×
151	}	×
152	}
153	for _, m := range pkg.Modules {	×
154	if err := f.renderModule(m, newPath, out); err != nil {	×
155	return err	×
156	}	×
157	}
158
159	pathStr := path.Join(newPath...)	×
160	childDepth := 2*(len(newPath)-1) + 2	×
161	for _, elem := range pkg.Structs {	×
162	if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {	×
163	return err	×
164	}	×
165	}
166	for _, elem := range pkg.Traits {	×
167	if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {	×
168	return err	×
169	}	×
170	}
171	for _, elem := range pkg.Functions {	×
172	if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {	×
173	return err	×
174	}	×
175	}
176
177	return nil	×
178	}
179
180	func (f MdBook) renderModule(mod document.Module, linkPath []string, out *strings.Builder) error {	×
181	newPath := append([]string{}, linkPath...)	×
182	newPath = append(newPath, mod.GetFileName())	×
183		×
184	pathStr := path.Join(newPath...)	×
185		×
186	modFile := f.ToLinkPath(pathStr, "module")	×
187	fmt.Fprintf(out, "%-s- [`%s`](%s)\n", 2(len(newPath)-1), "", mod.GetName(), modFile)	×
188		×
189	childDepth := 2*(len(newPath)-1) + 2	×
190	for _, elem := range mod.Structs {	×
191	if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {	×
192	return err	×
193	}	×
194	}
195	for _, elem := range mod.Traits {	×
196	if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {	×
197	return err	×
198	}	×
199	}
200	for _, elem := range mod.Functions {	×
201	if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {	×
202	return err	×
203	}	×
204	}
205	return nil	×
206	}
207
208	func (f *MdBook) renderModuleMember(mem document.Named, pathStr string, depth int, out io.Writer) error {	×
209	memPath := f.ToLinkPath(path.Join(pathStr, mem.GetFileName(), ""), "")	×
210	fmt.Fprintf(out, "%-*s- [`%s`](%s)\n", depth, "", mem.GetName(), memPath)	×
211	return nil	×
212	}	×
213
214	func (f MdBook) writeToml(p document.Package, dir string, proc *document.Processor) error {	×
215	toml, err := f.renderToml(p, proc.Template)	×
216	if err != nil {	×
217	return err	×
218	}	×
219	if proc.Config.DryRun {	×
220	return nil	×
221	}	×
222	tomlPath := path.Join(dir, "book.toml")	×
223	if err := os.WriteFile(tomlPath, []byte(toml), 0644); err != nil {	×
224	return err	×
225	}	×
226	return nil	×
227	}
228
229	func (f MdBook) renderToml(p document.Package, t *template.Template) (string, error) {	×
230	b := strings.Builder{}	×
231	if err := t.ExecuteTemplate(&b, "book.toml", p); err != nil {	×
232	return "", err	×
233	}	×
234	return b.String(), nil	×
235	}
236
237	func (f MdBook) writeCss(dir string, proc document.Processor) error {	×
238	cssDir := path.Join(dir, "css")	×
239	if !proc.Config.DryRun {	×
240	if err := os.MkdirAll(cssDir, os.ModePerm); err != nil && !os.IsExist(err) {	×
241	return err	×
242	}	×
243	}
244	css, err := fs.ReadFile(assets.CSS, "css/mdbook.css")	×
245	if err != nil {	×
246	return err	×
247	}	×
248	if !proc.Config.DryRun {	×
249	if err := os.WriteFile(path.Join(cssDir, "custom.css"), css, 0644); err != nil {	×
250	return err	×
251	}	×
252	}
253	return nil	×
254	}

mlange-42 / modo / 12999379643

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous