Add linkPrefixForNonMarkdownResources to transform config (#76)

* Add glueLink to transform config

Signed-off-by: Saswata Mukherjee <[email protected]>

* Implement suggestions

Signed-off-by: Saswata Mukherjee <[email protected]>

CHANGELOG.md

@@ -29,6 +29,7 @@ We use *breaking* word for marking changes that are not backward compatible (rel
 * [#69](https://github.com/bwplotka/mdox/pull/69) Add timeout option to `links.validate.config`
 * [#71](https://github.com/bwplotka/mdox/pull/71) Add `Origin.Path` to transform template
 * [#75](https://github.com/bwplotka/mdox/pull/75) Add `soft-wraps` flag to preserve soft line breaks
+* [#76](https://github.com/bwplotka/mdox/pull/76) Add `linkPrefixForNonMarkdownResources` to transform config
 
 ### Fixed
 

README.md

@@ -244,6 +244,7 @@ As seen above,
 * `inputDir`: It's a relative (to PWD) path that assumes input directory for markdown files and assets.
 * `outputDir`: It's a relative (to PWD) output directory where you can expect all files to land in. Typically that can be a `content` dir which Hugo uses as an input.
 * `extraInputGlobs`: It allows you to bring files from outside of `inputDir`.
+* `linkPrefixForNonMarkdownResources`: It specifies the link to be glued onto relative links which don't point to markdown or image files.
 * `gitIgnored`: It specifies whether `outputDir` should be git-ignored.
 * `localLinksStyle`: It sets the linking style to be applied. If empty, mdox assumes default style.
 

pkg/transform/config.go

@@ -39,6 +39,9 @@ type Config struct {
 	// ExtraInputGlobs allows to bring files from outside of input dir.
 	ExtraInputGlobs []string `yaml:"extraInputGlobs"`
 
+	// LinkPrefixForNonMarkdownResources specifies link to be glued onto relative links which don't point to markdown or image files.
+	LinkPrefixForNonMarkdownResources string `yaml:"linkPrefixForNonMarkdownResources"`
+
 	// Transformations to apply for any file.
 	Transformations []*TransformationConfig
 

pkg/transform/testdata/expected/test1/1/_index.md

@@ -16,4 +16,4 @@ Yolo
 
 ![Image](images/logo2.png)
 
-![Outside](../../../../main.go)
+![Outside](../test.go)

pkg/transform/testdata/expected/test2/2/README.md

@@ -10,4 +10,4 @@ Yolo
 
 ![Image](../images/logo2.png)
 
-![Outside](../../../../../main.go)
+![Outside](../../test.go)

pkg/transform/testdata/expected/test3/3/_index.md

@@ -16,7 +16,7 @@ Yolo
 
 ![Image](images/logo2.png)
 
-![Outside](../../../../main.go)
+![Outside](../test.go)
 
 ---
 

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

@@ -0,0 +1,13 @@
+# Group Handbook
+
+Yolo
+
+[RelLink](../test1/_index.md/)
+
+[RelLink](../team/inner/doc.md/)
+
+![Image](../logo.png)
+
+![Image](../images/logo2.png)
+
+![Outside](https://github.com/bwplotka/mdox/tree/main/testdata/test.go)

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

@@ -0,0 +1,11 @@
+---
+yolo: yolo
+title: Some Doc
+slug: doc.md
+---
+
+[RelLink](#some-doc)
+
+[RelLink](../../../readme.md/#group-handbook)
+
+[RelLink](../../../test1/_index.md/)

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

@@ -0,0 +1,17 @@
+---
+title: Test
+cascade:
+    - _target:
+        path: /**
+      type: docs
+---
+
+Yolo
+
+[RelLink](test1/_index.md/)
+
+[RelLink](team/inner/doc.md/)
+
+![Image](logo.png)
+
+![Image](images/logo2.png)

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

@@ -0,0 +1,9 @@
+---
+title: Proposals
+---
+
+[RelLink](../readme.md/)
+
+[RelLink](../team/inner/doc.md/)
+
+This should not work: [RelLink](../_index.md/)

pkg/transform/testdata/mdox4.yaml

@@ -0,0 +1,51 @@
+version: 1
+
+inputDir: "testdata/testproj"
+outputDir: "testdata/tmp/test4/4"
+extraInputGlobs:
+  - "testdata/test.md"
+  - "testdata/teststatic"
+
+linkPrefixForNonMarkdownResources: "https://github.com/bwplotka/mdox/tree/main"
+gitIgnored: true
+localLinksStyle:
+  hugo:
+    indexFileName: "_index.md"
+
+transformations:
+  - glob: "../teststatic/**"
+    path: /favicons/**
+
+  - glob: "../test.md"
+    path: /_index.md
+    popHeader: true
+    frontMatter:
+      template: |
+        title: "{{ .Origin.FirstHeader }}"
+
+        cascade:
+        - type: "docs"
+          _target:
+            path: "/**"
+
+  - glob: "doc.md"
+    popHeader: true
+    frontMatter:
+      template: |
+        title: "{{ .Origin.FirstHeader }}"
+        slug: "{{ .Target.FileName }}"
+
+  - glob: "Team/doc.md"
+    path: inner/doc.md
+    popHeader: true
+    frontMatter:
+      template: |
+        title: "{{ .Origin.FirstHeader }}"
+        yolo: "yolo"
+
+  - glob: "**/README.md"
+    path: /test1/_index.md
+    popHeader: true
+    frontMatter:
+      template: |
+        title: "{{ .Origin.FirstHeader }}"

pkg/transform/testdata/test.go

@@ -0,0 +1,3 @@
+// Copyright (c) Bartłomiej Płotka @bwplotka
+// Licensed under the Apache License 2.0.
+

pkg/transform/testdata/testproj/README.md

@@ -10,4 +10,4 @@ Yolo
 
 ![Image](images/logo2.png)
 
-![Outside](../../../../main.go)
+![Outside](../test.go)

pkg/transform/transform.go

@@ -25,6 +25,15 @@ func isMDFile(path string) bool {
 	return filepath.Ext(path) == ".md"
 }
 
+func isImgFile(path string) bool {
+	switch filepath.Ext(path) {
+	case ".png", ".jpg", "jpeg", ".svg", ".gif", ".webp":
+		return true
+	default:
+	}
+	return false
+}
+
 func prepOutputDir(d string, gitIgnored bool) error {
 	_, err := os.Stat(d)
 	if err != nil && !os.IsNotExist(err) {
@@ -65,11 +74,12 @@ func Dir(ctx context.Context, logger log.Logger, config []byte) error {
 		logger: logger,
 
 		linkTransformer: &relLinkTransformer{
-			localLinksStyle: c.LocalLinksStyle,
-			inputDir:        c.InputDir,
-			outputDir:       c.OutputDir,
-			oldRelPath:      map[string]string{},
-			newRelPath:      map[string]string{},
+			localLinksStyle:                   c.LocalLinksStyle,
+			inputDir:                          c.InputDir,
+			outputDir:                         c.OutputDir,
+			oldRelPath:                        map[string]string{},
+			newRelPath:                        map[string]string{},
+			linkPrefixForNonMarkdownResources: c.LinkPrefixForNonMarkdownResources,
 		},
 	}
 
@@ -259,10 +269,11 @@ func (t *transformer) transformFile(path string, info os.FileInfo, err error) er
 type relLinkTransformer struct {
 	localLinksStyle LocalLinksStyle
 
-	inputDir   string
-	outputDir  string
-	oldRelPath map[string]string
-	newRelPath map[string]string
+	inputDir                          string
+	outputDir                         string
+	oldRelPath                        map[string]string
+	newRelPath                        map[string]string
+	linkPrefixForNonMarkdownResources string
 }
 
 func (r *relLinkTransformer) TransformDestination(ctx mdformatter.SourceContext, destination []byte) ([]byte, error) {
@@ -296,6 +307,30 @@ func (r *relLinkTransformer) TransformDestination(ctx mdformatter.SourceContext,
 		}
 	}
 
+	// Non md or image relative link, so needs link to be prefixed.
+	if r.linkPrefixForNonMarkdownResources != "" && !isMDFile(relDest) && !isImgFile(relDest) {
+		workingDir, err := os.Getwd()
+		if err != nil {
+			return nil, err
+		}
+		// Original path before transform needs to be figured out.
+		// Case where file is in same position after transform.
+		oldRelPath := filepath.Join(r.inputDir, curRelDir, relDest)
+		if _, err := os.Stat(oldRelPath); os.IsNotExist(err) {
+			// File is moved to new dir after transform.
+			oldRelPath = filepath.Join(workingDir, curRelDir, relDest)
+			if _, err := os.Stat(oldRelPath); os.IsNotExist(err) {
+				// File is extra input glob.
+				oldRelPath = filepath.Join(workingDir, relDest)
+			}
+		}
+		originalRelPath, err := filepath.Rel(workingDir, oldRelPath)
+		if err != nil {
+			return nil, err
+		}
+		return []byte(r.linkPrefixForNonMarkdownResources + "/" + originalRelPath), nil
+	}
+
 	currDest := oldRelDest
 	if newRelPath, ok := r.newRelPath[oldRelDest]; ok {
 		currDest = newRelPath