inline images

ci/release/changelogs/next.md

@@ -11,6 +11,8 @@
 
 #### Improvements 🔧
 
+- Local images can now be included, e.g. `icon: ./my_img.png`.
+  [#146](https://github.com/terrastruct/d2/issues/146)
 - [install.sh](./install.sh) prints the dry run message more visibly.
   [#266](https://github.com/terrastruct/d2/pull/266)
 
@@ -22,3 +24,5 @@
   [#159](https://github.com/terrastruct/d2/issues/159)
 - Fixes markdown newlines created with a trailing double space or backslash.
   [#214](https://github.com/terrastruct/d2/pull/214)
+- Fixes images not loading in PNG exports
+  [#224](https://github.com/terrastruct/d2/pull/224)

cmd/d2/main.go

@@ -20,6 +20,7 @@ import (
 	"oss.terrastruct.com/d2/d2renderers/textmeasure"
 	"oss.terrastruct.com/d2/d2themes"
 	"oss.terrastruct.com/d2/d2themes/d2themescatalog"
+	"oss.terrastruct.com/d2/lib/imgbundler"
 	"oss.terrastruct.com/d2/lib/png"
 	"oss.terrastruct.com/d2/lib/version"
 	"oss.terrastruct.com/d2/lib/xmain"
@@ -170,15 +171,15 @@ func run(ctx context.Context, ms *xmain.State) (err error) {
 		_ = 343
 	}
 
-	_, err = compile(ctx, ms, plugin, *themeFlag, inputPath, outputPath, pw.Page)
+	_, err = compile(ctx, ms, false, plugin, *themeFlag, inputPath, outputPath, pw.Page)
 	if err != nil {
 		return err
 	}
 	ms.Log.Success.Printf("successfully compiled %v to %v", inputPath, outputPath)
 	return nil
 }
 
-func compile(ctx context.Context, ms *xmain.State, plugin d2plugin.Plugin, themeID int64, inputPath, outputPath string, page playwright.Page) ([]byte, error) {
+func compile(ctx context.Context, ms *xmain.State, isWatching bool, plugin d2plugin.Plugin, themeID int64, inputPath, outputPath string, page playwright.Page) ([]byte, error) {
 	input, err := ms.ReadPath(inputPath)
 	if err != nil {
 		return nil, err
@@ -211,9 +212,26 @@ func compile(ctx context.Context, ms *xmain.State, plugin d2plugin.Plugin, theme
 	if err != nil {
 		return nil, err
 	}
+	svg, err = imgbundler.InlineLocal(ctx, ms, svg)
+	if err != nil {
+		if !isWatching {
+			ms.Log.Error.Printf("missing/broken remote image(s), writing partial output: %v", err)
+		} else {
+			ms.Log.Debug.Printf("ignoring missing/broken local image(s) in watch mode: %v", err)
+		}
+	}
 
 	out := svg
 	if filepath.Ext(outputPath) == ".png" {
+		svg, err = imgbundler.InlineRemote(ctx, ms, svg)
+		if err != nil {
+			if !isWatching {
+				ms.Log.Error.Printf("missing/broken remote image(s), writing partial output: %v", err)
+			} else {
+				ms.Log.Debug.Printf("ignoring missing/broken remote image(s) in watch mode: %v", err)
+			}
+		}
+
 		out, err = png.ConvertSVG(ms, page, svg)
 		if err != nil {
 			return nil, err
@@ -224,6 +242,13 @@ func compile(ctx context.Context, ms *xmain.State, plugin d2plugin.Plugin, theme
 	if err != nil {
 		return nil, err
 	}
+
+	// Missing/broken images are fine during watch mode, as the user is likely building up a diagram.
+	// Otherwise, the assumption is that this diagram is building for production, and broken images are not okay.
+	if !isWatching && ms.Log.Nerrors() > 0 {
+		os.Exit(1)
+	}
+
 	return svg, nil
 }
 

cmd/d2/watch.go

@@ -345,7 +345,7 @@ func (w *watcher) compileLoop(ctx context.Context) error {
 			w.pw = newPW
 		}
 
-		b, err := compile(ctx, w.ms, w.layoutPlugin, w.themeID, w.inputPath, w.outputPath, w.pw.Page)
+		b, err := compile(ctx, w.ms, true, w.layoutPlugin, w.themeID, w.inputPath, w.outputPath, w.pw.Page)
 		if err != nil {
 			err = fmt.Errorf("failed to %scompile: %w", recompiledPrefix, err)
 			w.ms.Log.Error.Print(err)