Skip to content

feat(core): export manual functions for CLI wrappers to consume #397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jakedoublev merged 3 commits into from
Oct 1, 2024
Merged

feat(core): export manual functions for CLI wrappers to consume #397

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2651e6d
feat(core): export manual functions for CLI wrappers to consume
jakedoublev Oct 1, 2024
24a8cab
fix FS type to embed
jakedoublev Oct 1, 2024
a56f3d5
fix lint ignore
jakedoublev Oct 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 17 additions & 12 deletions pkg/man/man.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package man

import (
"embed"
"fmt"
"io/fs"
"log/slog"
Expand Down Expand Up @@ -120,15 +121,8 @@ func (m Manual) GetCommand(cmd string, opts ...CommandOpts) *Doc {
}

//nolint:mnd,gocritic // allow file separator counts to be hardcoded
func init() {
slog.Debug("Loading docs from embed")
Docs = Manual{
Docs: make(map[string]*Doc),
En: make(map[string]*Doc),
Fr: make(map[string]*Doc),
}

err := fs.WalkDir(docsEmbed.ManFiles, ".", func(path string, d fs.DirEntry, err error) error {
func ProcessEmbeddedDocs(manFiles embed.FS) {
err := fs.WalkDir(manFiles, ".", func(path string, d fs.DirEntry, err error) error {
if err != nil {
return err
}
Expand Down Expand Up @@ -165,12 +159,12 @@ func init() {
}

slog.Debug("Found doc", slog.String("cmd", cmd), slog.String("lang", lang))
c, err := docsEmbed.ManFiles.ReadFile(path)
c, err := manFiles.ReadFile(path)
if err != nil {
return fmt.Errorf("could not read file, %s: %s ", path, err.Error())
}

doc, err := processDoc(string(c))
doc, err := ProcessDoc(string(c))
if err != nil {
return fmt.Errorf("could not process doc, %s: %s", path, err.Error())
}
Expand All @@ -192,7 +186,18 @@ func init() {
}
}

func processDoc(doc string) (*Doc, error) {
func init() {
slog.Debug("Loading docs from embed")
Docs = Manual{
Docs: make(map[string]*Doc),
En: make(map[string]*Doc),
Fr: make(map[string]*Doc),
}

ProcessEmbeddedDocs(docsEmbed.ManFiles)
}

func ProcessDoc(doc string) (*Doc, error) {
if len(doc) == 0 {
return nil, fmt.Errorf("empty document")
}
Expand Down