Renames package doc to document (#17)

CHANGELOG.md

@@ -2,7 +2,8 @@
 
 ### Other
 
-* Remove numbering from navigation entries (#16)
+* Removes numbering from navigation entries (#16)
+* Renames package `doc` to `document` (#17)
 
 ## [[v0.1.1]](https://github.com/mlange-42/modo/compare/v0.1.0...v0.1.1)
 

cmd/modo/root.go

@@ -7,7 +7,7 @@ import (
 	"os"
 
 	"github.com/mlange-42/modo"
-	"github.com/mlange-42/modo/doc"
+	"github.com/mlange-42/modo/document"
 	"github.com/mlange-42/modo/format"
 	"github.com/spf13/cobra"
 )
@@ -37,7 +37,7 @@ func rootCommand() *cobra.Command {
 				return err
 			}
 
-			docs, err := doc.FromJson(data)
+			docs, err := document.FromJson(data)
 			if err != nil {
 				log.Fatal(err)
 			}

doc/json.go → document/document.go

@@ -1,4 +1,4 @@
-package doc
+package document
 
 import (
 	"bytes"

doc/json_test.go → document/document_test.go

@@ -1,9 +1,9 @@
-package doc_test
+package document_test
 
 import (
 	"testing"
 
-	"github.com/mlange-42/modo/doc"
+	"github.com/mlange-42/modo/document"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -20,7 +20,7 @@ func TestFromJson(t *testing.T) {
     "version": "0.1.0"
 }`
 
-	docs, err := doc.FromJson([]byte(data))
+	docs, err := document.FromJson([]byte(data))
 	assert.Nil(t, err)
 	assert.NotNil(t, docs)
 }

format/formats.go

@@ -3,7 +3,7 @@ package format
 import (
 	"text/template"
 
-	"github.com/mlange-42/modo/doc"
+	"github.com/mlange-42/modo/document"
 )
 
 type Format uint8
@@ -23,5 +23,5 @@ func GetFormatter(f Format) Formatter {
 }
 
 type Formatter interface {
-	WriteAuxiliary(p *doc.Package, dir string, t *template.Template) error
+	WriteAuxiliary(p *document.Package, dir string, t *template.Template) error
 }

format/mdbook.go

@@ -7,12 +7,12 @@ import (
 	"strings"
 	"text/template"
 
-	"github.com/mlange-42/modo/doc"
+	"github.com/mlange-42/modo/document"
 )
 
 type MdBookFormatter struct{}
 
-func (f *MdBookFormatter) WriteAuxiliary(p *doc.Package, dir string, t *template.Template) error {
+func (f *MdBookFormatter) WriteAuxiliary(p *document.Package, dir string, t *template.Template) error {
 	if err := f.writeSummary(p, dir, t); err != nil {
 		return err
 	}
@@ -28,7 +28,7 @@ type summary struct {
 	Modules  string
 }
 
-func (f *MdBookFormatter) writeSummary(p *doc.Package, dir string, t *template.Template) error {
+func (f *MdBookFormatter) writeSummary(p *document.Package, dir string, t *template.Template) error {
 	summaryPath := path.Join(dir, p.GetName(), "SUMMARY.md")
 
 	s := summary{}
@@ -58,7 +58,7 @@ func (f *MdBookFormatter) writeSummary(p *doc.Package, dir string, t *template.T
 	return nil
 }
 
-func (f *MdBookFormatter) renderPackage(pkg *doc.Package, linkPath []string, out *strings.Builder) {
+func (f *MdBookFormatter) renderPackage(pkg *document.Package, linkPath []string, out *strings.Builder) {
 	newPath := append([]string{}, linkPath...)
 	newPath = append(newPath, pkg.GetName())
 	fmt.Fprintf(out, "%-*s- [%s](./%s/_index.md))\n", 2*len(linkPath), "", pkg.GetName(), path.Join(newPath...))
@@ -70,7 +70,7 @@ func (f *MdBookFormatter) renderPackage(pkg *doc.Package, linkPath []string, out
 	}
 }
 
-func (f *MdBookFormatter) renderModule(mod *doc.Module, linkPath []string, out *strings.Builder) {
+func (f *MdBookFormatter) renderModule(mod *document.Module, linkPath []string, out *strings.Builder) {
 	newPath := append([]string{}, linkPath...)
 	newPath = append(newPath, mod.GetName())
 	pathStr := path.Join(newPath...)
@@ -87,7 +87,7 @@ func (f *MdBookFormatter) renderModule(mod *doc.Module, linkPath []string, out *
 	}
 }
 
-func (f *MdBookFormatter) writeToml(p *doc.Package, dir string, t *template.Template) error {
+func (f *MdBookFormatter) writeToml(p *document.Package, dir string, t *template.Template) error {
 	tomlPath := path.Join(dir, "book.toml")
 
 	b := strings.Builder{}

format/plain.go

@@ -3,11 +3,11 @@ package format
 import (
 	"text/template"
 
-	"github.com/mlange-42/modo/doc"
+	"github.com/mlange-42/modo/document"
 )
 
 type PlainFormatter struct{}
 
-func (f *PlainFormatter) WriteAuxiliary(p *doc.Package, dir string, t *template.Template) error {
+func (f *PlainFormatter) WriteAuxiliary(p *document.Package, dir string, t *template.Template) error {
 	return nil
 }

template.go

@@ -9,7 +9,7 @@ import (
 	"strings"
 	"text/template"
 
-	"github.com/mlange-42/modo/doc"
+	"github.com/mlange-42/modo/document"
 	"github.com/mlange-42/modo/format"
 )
 
@@ -25,7 +25,7 @@ func init() {
 	}
 }
 
-func Render(data doc.Kinded) (string, error) {
+func Render(data document.Kinded) (string, error) {
 	b := strings.Builder{}
 	err := t.ExecuteTemplate(&b, data.GetKind()+".md", data)
 	if err != nil {
@@ -34,7 +34,7 @@ func Render(data doc.Kinded) (string, error) {
 	return b.String(), nil
 }
 
-func RenderPackage(p *doc.Package, dir string, renderFormat format.Format, root bool) error {
+func RenderPackage(p *document.Package, dir string, renderFormat format.Format, root bool) error {
 	pkgPath := path.Join(dir, p.GetName())
 	if err := mkDirs(pkgPath); err != nil {
 		return err
@@ -72,7 +72,7 @@ func RenderPackage(p *doc.Package, dir string, renderFormat format.Format, root
 	return nil
 }
 
-func renderModule(mod *doc.Module, dir string) error {
+func renderModule(mod *document.Module, dir string) error {
 	if err := mkDirs(dir); err != nil {
 		return err
 	}
@@ -101,9 +101,9 @@ func renderModule(mod *doc.Module, dir string) error {
 }
 
 func renderList[T interface {
-	doc.Named
-	doc.Kinded
-	doc.Pathed
+	document.Named
+	document.Kinded
+	document.Pathed
 }](list []T, dir string) error {
 	for _, elem := range list {
 		text, err := Render(elem)

template_test.go

@@ -5,26 +5,26 @@ import (
 	"testing"
 
 	"github.com/mlange-42/modo"
-	"github.com/mlange-42/modo/doc"
+	"github.com/mlange-42/modo/document"
 )
 
 func TestTemplatePackage(t *testing.T) {
-	pkg := doc.Package{
-		Kind:        doc.NewKind("package"),
-		Name:        doc.NewName("Modo"),
+	pkg := document.Package{
+		Kind:        document.NewKind("package"),
+		Name:        document.NewName("Modo"),
 		Summary:     "Mojo documentation generator",
 		Description: "Package description",
-		Modules: []*doc.Module{
+		Modules: []*document.Module{
 			{
-				Name:    doc.NewName("mod1"),
+				Name:    document.NewName("mod1"),
 				Summary: "Mod1 summary",
 			},
 			{
-				Name:    doc.NewName("mod2"),
+				Name:    document.NewName("mod2"),
 				Summary: "Mod2 summary",
 			},
 		},
-		Packages: []*doc.Package{},
+		Packages: []*document.Package{},
 	}
 
 	text, err := modo.Render(&pkg)
@@ -35,24 +35,24 @@ func TestTemplatePackage(t *testing.T) {
 }
 
 func TestTemplateModule(t *testing.T) {
-	mod := doc.Module{
-		Kind:        doc.NewKind("module"),
-		Name:        doc.NewName("modo"),
+	mod := document.Module{
+		Kind:        document.NewKind("module"),
+		Name:        document.NewName("modo"),
 		Description: "",
 		Summary:     "a test module",
-		Aliases:     []*doc.Alias{},
-		Structs: []*doc.Struct{
+		Aliases:     []*document.Alias{},
+		Structs: []*document.Struct{
 			{
-				Name:    doc.NewName("TestStruct2"),
+				Name:    document.NewName("TestStruct2"),
 				Summary: "Struct summary...",
 			},
 			{
-				Name:    doc.NewName("TestStruct"),
+				Name:    document.NewName("TestStruct"),
 				Summary: "Struct summary 2...",
 			},
 		},
-		Traits:    []*doc.Trait{},
-		Functions: []*doc.Function{},
+		Traits:    []*document.Trait{},
+		Functions: []*document.Function{},
 	}
 
 	text, err := modo.Render(&mod)