added layered fs to load os and embedded templates

Author: brahmlower

README.md

@@ -53,5 +53,12 @@ Usage:
   helm-values docs [flags]
 
 Flags:
-  -h, --help                 help for docs
+      --chart-dir string         path to the chart directory
+      --dry-run                  don't write changes to disk
+      --extra-templates string   path to extra templates directory
+  -h, --help                     help for docs
+      --log-level string         log level (debug, info, warn, error, fatal, panic) (default "warn")
+      --schema-file string       path to the schema-file file (default "values.schema.json")
+      --stdout                   write to stdout
+      --strict                   fail on doc comment parsing errors
 ```

cmd/helm-schema/internal/commands/docs.go

@@ -9,6 +9,7 @@ import (
 	"helmschema/cmd/helm-schema/internal/config"
 	"helmschema/cmd/helm-schema/internal/docs"
 	"helmschema/cmd/helm-schema/internal/jsonschema"
+	"os"
 	"strings"
 
 	"github.com/sirupsen/logrus"
@@ -83,6 +84,8 @@ func generateDocs(logger *logrus.Logger, cfg *config.DocsConfig) error {
 		if err != nil {
 			return err
 		}
+		extraTemplates = append(extraTemplates, "templates/md.valuesTable.gotmpl")
+		extraTemplates = append(extraTemplates, "templates/rst.valuesTable.gotmpl")
 
 		logger.Debugf(
 			"%s: docs: loading template: %s",
@@ -93,8 +96,23 @@ func generateDocs(logger *logrus.Logger, cfg *config.DocsConfig) error {
 			logger.Debugf("%s: docs: loading extra template: %s", plan.Chart().Details.Name, extraTemplate)
 		}
 
+		root, err := os.OpenRoot("/")
+		if err != nil {
+			return err
+		}
+		// rootFS := root.FS()
+		// f, err := rootFS.Open("Users/brahm.lower/development/helm-kiwix/charts/kiwix/README.md.gotmpl")
+		// fmt.Printf("f: %v\n", f)
+		// fmt.Printf("err: %s\n", err.Error())
+
+		layeredFs := docs.NewLayeredFS(
+			docs.TemplateFS,
+			root.FS(),
+		)
+
 		t, err := docs.NewTemplator(
 			logger,
+			layeredFs,
 			plan.Chart().Details.Name,
 			plan.ReadmeTemplateFilePath(),
 			extraTemplates,

cmd/helm-schema/internal/docs/embedded.go

@@ -0,0 +1,6 @@
+package docs
+
+import "embed"
+
+//go:embed all:templates
+var TemplateFS embed.FS

cmd/helm-schema/internal/docs/layeredfs.go

@@ -0,0 +1,51 @@
+package docs
+
+import (
+	"fmt"
+	"io/fs"
+)
+
+func NewLayeredFS(layers ...fs.FS) *LayeredFS {
+	return &LayeredFS{
+		layers: layers,
+	}
+}
+
+type LayeredFS struct {
+	layers []fs.FS
+}
+
+var _ fs.FS = (*LayeredFS)(nil)
+var _ fs.GlobFS = (*LayeredFS)(nil)
+var _ fs.ReadFileFS = (*LayeredFS)(nil)
+
+func (l *LayeredFS) Open(name string) (fs.File, error) {
+	var lastErr error
+	var f fs.File
+	for _, layer := range l.layers {
+		f, lastErr = layer.Open(name)
+		if lastErr == nil {
+			return f, nil
+		}
+	}
+
+	return nil, lastErr
+}
+
+func (l *LayeredFS) Glob(name string) ([]string, error) {
+	return []string{name}, nil
+}
+
+func (l *LayeredFS) ReadFile(name string) ([]byte, error) {
+	var lastErr error
+	var b []byte
+	for _, layer := range l.layers {
+		b, lastErr = fs.ReadFile(layer, name)
+		if lastErr == nil {
+			return b, nil
+		}
+	}
+
+	fmt.Printf("ReadFile error: %v, %s\n", lastErr, name)
+	return nil, lastErr
+}

cmd/helm-schema/internal/docs/templates.go

@@ -2,18 +2,28 @@ package docs
 
 import (
 	"io"
+	"io/fs"
 	"path/filepath"
+	"strings"
 	"text/template"
 
 	"github.com/Masterminds/sprig/v3"
 	"github.com/sirupsen/logrus"
 )
 
-func NewTemplator(logger *logrus.Logger, chartName string, path string, extraPaths []string) (*Templator, error) {
+func NewTemplator(logger *logrus.Logger, fsys fs.FS, chartName string, path string, extraPaths []string) (*Templator, error) {
 	paths := append([]string{path}, extraPaths...)
+
+	// A ridiculously stupid hack to get file lookups working
+	// through the Root.FS because full absolute paths don't seem
+	// to work when the root directory itself is mounted.
+	for i, p := range paths {
+		paths[i] = strings.TrimPrefix(p, "/")
+	}
+
 	t, err := template.New(filepath.Base(path)).
 		Funcs(sprig.FuncMap()).
-		ParseFiles(paths...)
+		ParseFS(fsys, paths...)
 	if err != nil {
 		return nil, err
 	}

cmd/helm-schema/internal/docs/templates/md.valuesTable.gotmpl

@@ -2,7 +2,7 @@
 {{- define "md.valuesTable" }}
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-  {{- range .Values }}
+  {{- range .ValuesTable }}
     {{- "\n| "}}{{ .Key }}
     {{- " | "}}{{ .Type }}
     {{- " | "}}{{ .Default }}

cmd/helm-schema/internal/plan.go

@@ -123,23 +123,21 @@ func (p *Plan) WriteSchema(logger *logrus.Logger, schema *jsonschema.Schema) err
 }
 
 func (p *Plan) WriteReadme(logger *logrus.Logger, s string) error {
-	if p.StdOut() {
-		fmt.Println(s)
+	if !p.DryRun() {
+		logger.Debugf("%s: docs: opening readme file", p.Chart().Details.Name)
+		f, err := os.Create(p.ReadmeFilePath())
+		if err != nil {
+			return err
+		}
+		defer f.Close()
+
+		if _, err = f.Write([]byte(s)); err != nil {
+			return err
+		}
 	}
 
-	if p.DryRun() {
-		return nil
-	}
-
-	logger.Debugf("%s: docs: opening readme file", p.Chart().Details.Name)
-	f, err := os.Create(p.ReadmeFilePath())
-	if err != nil {
-		return err
-	}
-	defer f.Close()
-
-	if _, err = f.Write([]byte(s)); err != nil {
-		return err
+	if p.StdOut() {
+		fmt.Println(s)
 	}
 
 	return nil