Add addPath option

pkg/transform/config.go

@@ -68,6 +68,10 @@ type TransformationConfig struct {
 	// TODO(bwplotka): Explain ** and * suffixes and ability to specify "invalid" paths like "/../".
 	Path string
 
+	// Add is an optional path for a file to be created with certain frontMatter.
+	// Only parses frontMatter and cannot be mentioned alongside path and glob.
+	AddPath string `yaml:"addPath"`
+
 	// FrontMatter holds front matter transformations.
 	FrontMatter *MatterConfig `yaml:"frontMatter"`
 
@@ -153,9 +157,17 @@ func ParseConfig(c []byte) (Config, error) {
 	cfg.OutputDir = strings.TrimSuffix(cfg.OutputDir, "/")
 
 	for _, f := range cfg.Transformations {
-		f._glob, err = glob.Compile(f.Glob, '/')
-		if err != nil {
-			return Config{}, errors.Wrapf(err, "compiling glob %v", f.Glob)
+		if f.Glob != "" {
+			f._glob, err = glob.Compile(f.Glob, '/')
+			if err != nil {
+				return Config{}, errors.Wrapf(err, "compiling glob %v", f.Glob)
+			}
+		}
+
+		if f.AddPath != "" {
+			if f.Path != "" || f._glob != nil {
+				return Config{}, errors.Wrapf(err, "addPath with glob or path %v, %v, %v", f.AddPath, f.Path, f.Glob)
+			}
 		}
 
 		if f.FrontMatter != nil {

pkg/transform/testdata/expected/test4/4/Proposals/README.md

@@ -0,0 +1,15 @@
+---
+title: Proposals
+slug: README.md
+lastmod: 'TODO: Allow testing last mod .Origin.LastMod'
+---
+
+[RelLink](../README.md)
+
+[RelLink](../Team/doc.md)
+
+This should not work: [RelLink](../../test.md)
+
+---
+
+Found a typo, inconsistency or missing information in our docs? Help us to improve [Thanos](https://thanos.io) documentation by proposing a fix [on GitHub here](https://github.com/thanos-io/thanos/edit/main/docs/README.md) :heart:

pkg/transform/testdata/expected/test4/4/README.md

@@ -0,0 +1,23 @@
+---
+title: Group Handbook
+cascade:
+    - _target:
+        path: /**
+      type: docs
+---
+
+Yolo
+
+[RelLink](Proposals/README.md)
+
+[RelLink](Team/doc.md)
+
+![Image](logo.png)
+
+![Image](images/logo2.png)
+
+![Outside](../../../../main.go)
+
+---
+
+Found a typo, inconsistency or missing information in our docs? Help us to improve [Thanos](https://thanos.io) documentation by proposing a fix [on GitHub here](https://github.com/thanos-io/thanos/edit/main/docs/README.md) :heart:

pkg/transform/testdata/expected/test4/4/Team/doc.md

@@ -0,0 +1,11 @@
+# Some Doc
+
+[RelLink](#some-doc)
+
+[RelLink](../README.md#group-handbook)
+
+[RelLink](../Proposals/README.md)
+
+---
+
+Found a typo, inconsistency or missing information in our docs? Help us to improve [Thanos](https://thanos.io) documentation by proposing a fix [on GitHub here](https://github.com/thanos-io/thanos/edit/main/docs/doc.md) :heart:

pkg/transform/testdata/expected/test4/4/_index.md

@@ -0,0 +1,5 @@
+---
+weight: 100000
+---
+
+

pkg/transform/testdata/mdox4.yaml

@@ -0,0 +1,49 @@
+version: 1
+
+inputDir: "testdata/testproj"
+outputDir: "testdata/tmp/test4/4"
+
+gitIgnored: true
+
+transformations:
+
+  - addPath: _index.md
+    frontMatter:
+      template: |
+        weight: 100000
+
+  - glob: "README.md"
+    path: README.md
+    frontMatter:
+      template: |
+        title: "{{ .Origin.FirstHeader }}"
+
+        cascade:
+        - type: "docs"
+          _target:
+            path: "/**"
+    backMatter:
+      template: |
+        Found a typo, inconsistency or missing information in our docs?
+        Help us to improve [Thanos](https://thanos.io) documentation by proposing a fix [on GitHub here](https://github.com/thanos-io/thanos/edit/main/docs/{{ .Origin.Filename }}) :heart:
+
+  - glob: "**/README.md"
+    frontMatter:
+      template: |
+        title: "{{ .Origin.FirstHeader }}"
+        lastmod: "TODO: Allow testing last mod .Origin.LastMod"
+        slug: "{{ .Target.FileName }}"
+    backMatter:
+      template: |
+        Found a typo, inconsistency or missing information in our docs?
+        Help us to improve [Thanos](https://thanos.io) documentation by proposing a fix [on GitHub here](https://github.com/thanos-io/thanos/edit/main/docs/{{ .Origin.Filename }}) :heart:
+
+
+  - glob: "**.md"
+    backMatter:
+      template: |
+        Found a typo, inconsistency or missing information in our docs?
+        Help us to improve [Thanos](https://thanos.io) documentation by proposing a fix [on GitHub here](https://github.com/thanos-io/thanos/edit/main/docs/{{ .Origin.Filename }}) :heart:
+
+  - glob: "**"
+    path: "/../4static/**"

pkg/transform/transform.go

@@ -12,6 +12,7 @@ import (
 	"os"
 	"path/filepath"
 	"strings"
+	"time"
 
 	"github.com/bwplotka/mdox/pkg/mdformatter"
 	"github.com/efficientgo/tools/core/pkg/errcapture"
@@ -48,6 +49,46 @@ func prepOutputDir(d string, gitIgnored bool) error {
 	return nil
 }
 
+func createNewFiles(ctx context.Context, trs []*TransformationConfig, outputDir string, logger log.Logger) error {
+	for _, tr := range trs {
+		if tr.AddPath == "" {
+			continue
+		}
+		msg := "creating new file"
+		target := filepath.Join(outputDir, tr.AddPath)
+		_, err := os.Create(target)
+		if err != nil {
+			return errors.Wrapf(err, "creating new file %v", target)
+		}
+
+		var opts []mdformatter.Option
+		if tr.FrontMatter != nil {
+			if !isMDFile(target) {
+				return errors.Errorf("front matter option set on file that is non-markdown: %v", target)
+			}
+			msg = "creating new file with transformation"
+
+			_, targetFilename := filepath.Split(target)
+			opts = append(opts, mdformatter.WithFrontMatterTransformer(&frontMatterTransformer{
+				c: tr.FrontMatter,
+				origin: MatterOrigin{
+					LastMod: time.Now().String(),
+				},
+				target: MatterTarget{
+					FileName: targetFilename,
+				},
+			}))
+		}
+		level.Debug(logger).Log("msg", msg, "target", target)
+
+		err = mdformatter.Format(ctx, logger, []string{target}, opts...)
+		if err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
 // Dir transforms directory using given configuration file.
 func Dir(ctx context.Context, logger log.Logger, config []byte) error {
 	c, err := ParseConfig(config)
@@ -59,6 +100,10 @@ func Dir(ctx context.Context, logger log.Logger, config []byte) error {
 		return err
 	}
 
+	if err = createNewFiles(ctx, c.Transformations, c.OutputDir, logger); err != nil {
+		return err
+	}
+
 	tr := &transformer{
 		ctx:    ctx,
 		c:      c,
@@ -374,8 +419,10 @@ func (f *backMatterTransformer) Close(mdformatter.SourceContext) error { return
 
 func firstMatch(absRelPath string, trs []*TransformationConfig) (*TransformationConfig, bool) {
 	for _, tr := range trs {
-		if tr._glob.Match(absRelPath) {
-			return tr, true
+		if tr._glob != nil {
+			if tr._glob.Match(absRelPath) {
+				return tr, true
+			}
 		}
 	}
 	return nil, false

pkg/transform/transform_e2e_test.go

@@ -33,19 +33,26 @@ func TestTransform(t *testing.T) {
 		testutil.Ok(t, transform.Dir(context.Background(), logger, mdox1))
 		assertDirContent(t, filepath.Join(testData, "expected", "test1"), filepath.Join(tmpDir, "test1"))
 	})
+
 	t.Run("mdox2.yaml", func(t *testing.T) {
 		mdox2, err := ioutil.ReadFile(filepath.Join(testData, "mdox2.yaml"))
 		testutil.Ok(t, err)
 		testutil.Ok(t, transform.Dir(context.Background(), logger, mdox2))
 		assertDirContent(t, filepath.Join(testData, "expected", "test2"), filepath.Join(tmpDir, "test2"))
-
 	})
+
 	t.Run("mdox3.yaml", func(t *testing.T) {
 		mdox2, err := ioutil.ReadFile(filepath.Join(testData, "mdox3.yaml"))
 		testutil.Ok(t, err)
 		testutil.Ok(t, transform.Dir(context.Background(), logger, mdox2))
 		assertDirContent(t, filepath.Join(testData, "expected", "test3"), filepath.Join(tmpDir, "test3"))
+	})
 
+	t.Run("mdox4.yaml", func(t *testing.T) {
+		mdox2, err := ioutil.ReadFile(filepath.Join(testData, "mdox4.yaml"))
+		testutil.Ok(t, err)
+		testutil.Ok(t, transform.Dir(context.Background(), logger, mdox2))
+		assertDirContent(t, filepath.Join(testData, "expected", "test4"), filepath.Join(tmpDir, "test4"))
 	})
 }