feat(#89): added input file as window title

README.md

@@ -103,6 +103,7 @@ Screenshots can be customized with `--flags` or [Configuration](#configuration)
 - [`-t`](#theme), [`--theme`](#theme): Theme to use for syntax highlighting.
 - [`-w`](#window), [`--window`](#window): Display window controls.
 - [`-H`](#height), [`--height`](#height): Height of terminal window.
+- [`--window.title`](#window-title): Display input file as title when window controls are displayed.
 - [`--border.width`](#border-width): Border width thickness.
 - [`--border.color`](#border-width): Border color.
 - [`--shadow.blur`](#shadow): Shadow Gaussian Blur.
@@ -216,6 +217,24 @@ freeze artichoke.hs --window
   <img alt="output of freeze command, Haskell code block with window controls applied" src="./test/golden/svg/window.svg" width="600" />
 </a>
 
+#### Window Title
+
+Display the input file as the title of the window if `--window.title` is not passed in the arguments (`--window.title=auto` as default).
+
+Display a custom title if `--window.title` is passed in the arguments (`--window.title="custom title"`).
+
+Don't display the title if `--window.title` is passed in the arguments as empty string (`--window.title=""`).
+
+```bash
+freeze artichoke.hs --window --window.title "My artichoke code"
+```
+
+<img alt="output of freeze command, Haskell code block with window title applied" src="./test/golden/svg/title.svg" width="600" />
+
+> [!WARNING]
+>
+> The **title** can only be supported when using **window** mode (`--window=true`).
+
 ### Background
 
 Set the background color of the terminal window.

config.go

@@ -22,6 +22,7 @@ type Config struct {
 	Margin     []float64 `json:"margin" help:"Apply margin to the window." short:"m" placeholder:"0" group:"Window"`
 	Padding    []float64 `json:"padding" help:"Apply padding to the code." short:"p" placeholder:"0" group:"Window"`
 	Window     bool      `json:"window" help:"Display window controls." group:"Window"`
+	Title      Title     `json:"title" embed:"" prefix:"title." group:"Window"`
 	Width      float64   `json:"width" help:"Width of terminal window." short:"W" group:"Window"`
 	Height     float64   `json:"height" help:"Height of terminal window." short:"H" group:"Window"`
 
@@ -49,6 +50,11 @@ type Config struct {
 	ShowLineNumbers bool    `json:"show_line_numbers" help:"" group:"Line" placeholder:"false"`
 }
 
+type Title struct {
+	Text     string `json:"title" help:"Display window title. {{--title.text=auto}} as default for input filename." group:"Window" default:"auto"`
+	Position string `json:"position" help:"Position of window title, one of {{left}}, {{center}}, or {{right}}. {{--title.position=center}} as default." group:"Window" default:"center"`
+}
+
 // Shadow is the configuration options for a drop shadow.
 type Shadow struct {
 	Blur float64 `json:"blur" help:"Shadow Gaussian Blur." placeholder:"0"`

configurations/full.json

@@ -1,5 +1,9 @@
 {
   "window": true,
+	"title": {
+		"text": "auto",
+		"position": "center"
+	},
   "theme": "charm",
   "border": {
     "radius": 8,
@@ -30,4 +34,4 @@
     "ligatures": true
   },
   "line_height": 1.2
-}
+}

freeze_test.go

@@ -10,6 +10,7 @@ import (
 	"testing"
 
 	"github.com/aymanbagabas/go-udiff"
+	"github.com/beevik/etree"
 )
 
 const binary = "./test/freeze-test"
@@ -104,6 +105,62 @@ func TestFreezeErrorFileMissing(t *testing.T) {
 	}
 }
 
+func TestFreezeWindowTitleFilename(t *testing.T) {
+	output := "artichoke-default-title.svg"
+	t.Cleanup(func() { os.Remove(output) })
+	testTitle := "artichoke.hs"
+	cmd := exec.Command(binary, "test/input/artichoke.hs", "--output", output, "--window")
+	err := cmd.Run()
+
+	if err != nil {
+		t.Fatal("unexpected error", err)
+	}
+
+	doc := etree.NewDocument()
+	err = doc.ReadFromFile(output)
+	if err != nil {
+		t.Fatal("unexpected error", err)
+	}
+	childs := doc.ChildElements()
+	if len(childs) == 0 {
+		t.Fatal("no child elements")
+	}
+	lastChild := childs[len(childs)-1]
+	got := lastChild.FindElement("text").Text()
+
+	if got != testTitle {
+		t.Fatalf("expected %s to be %s", got, testTitle)
+	}
+}
+
+func TestFreezeCustomWindowTitle(t *testing.T) {
+	output := "artichoke-custom-title.svg"
+	t.Cleanup(func() { os.Remove(output) })
+	testTitle := "custom-test title"
+	cmd := exec.Command(binary, "test/input/artichoke.hs", "--output", output, "--title.text", testTitle, "--window")
+	err := cmd.Run()
+
+	if err != nil {
+		t.Fatal("unexpected error", err)
+	}
+
+	doc := etree.NewDocument()
+	err = doc.ReadFromFile(output)
+	if err != nil {
+		t.Fatal("unexpected error", err)
+	}
+	childs := doc.ChildElements()
+	if len(childs) == 0 {
+		t.Fatal("no child elements")
+	}
+	lastChild := childs[len(childs)-1]
+	got := lastChild.FindElement("text").Text()
+
+	if got != testTitle {
+		t.Fatalf("expected %s to be %s", got, testTitle)
+	}
+}
+
 func TestFreezeConfigurations(t *testing.T) {
 	tests := []struct {
 		input  string
@@ -258,6 +315,11 @@ func TestFreezeConfigurations(t *testing.T) {
 			flags:  []string{"--wrap", "80", "--width", "600"},
 			output: "wrap",
 		},
+		{
+			input:  "test/input/artichoke.hs",
+			flags:  []string{"--border.radius", "8", "--window", "--title.text", "My artichoke code"},
+			output: "title",
+		},
 	}
 
 	err := os.RemoveAll("test/output/svg")

interactive.go

@@ -103,6 +103,17 @@ func runForm(config *Config) (*Config, error) {
 				Inline(true).
 				Value(&config.Window),
 
+			huh.NewInput().Title("Title text").
+				Placeholder("auto").
+				Inline(true).
+				Prompt("").
+				Value(&config.Title.Text),
+
+			huh.NewSelect[string]().Title("Title position").
+				Inline(true).
+				Options(huh.NewOptions("left", "center", "right")...).
+				Value(&config.Title.Position),
+
 			huh.NewNote().Title("Font"),
 
 			huh.NewInput().Title("Font Family ").

main.go

@@ -287,10 +287,34 @@ func main() {
 	}
 
 	if config.Window {
-		windowControls := svg.NewWindowControls(5.5*float64(scale), 19.0*scale, 12.0*scale)
+		x := 19.0 * scale
+		y := 12.0 * scale
+		windowControls, controlsWidth := svg.NewWindowControls(5.5*float64(scale), x, y)
 		svg.Move(windowControls, float64(config.Margin[left]), float64(config.Margin[top]))
 		image.AddChild(windowControls)
 		config.Padding[top] += (15 * scale)
+		if config.Title.Text != "" {
+			titleText := config.Title.Text
+			if config.Title.Text == "auto" {
+				titleText = filepath.Base(config.Input)
+			}
+			my := float64(config.Margin[top]) + y
+			ml := float64(config.Margin[left]) + x + controlsWidth
+			mr := float64(config.Margin[right]) + x
+			// [0] left, [1] center, [2] right, [3] top
+			titlePos := []float64{ml, imageWidth / 2, imageWidth - mr, my}
+			title, err := svg.NewWindowTitle(titlePos, config.Title.Position, config.Font.Size*float64(scale), config.Font.Family, titleText, s)
+			if err != nil {
+				printErrorFatal("Unable to add title", err)
+			}
+			image.AddChild(title)
+		}
+	} else if config.Title.Text != "auto" {
+		err := errors.New("Title is not supported when not using a window controls")
+		printErrorFatal("Unable to add title", err)
+	} else if config.Title.Position != "center" {
+		err := errors.New("Title position is not supported when not using a window controls")
+		printErrorFatal("Unable to add title", err)
 	}
 
 	if config.Border.Radius > 0 {

svg/svg.go

@@ -1,10 +1,12 @@
 package svg
 
 import (
+	"errors"
 	"fmt"
 	"strconv"
 	"strings"
 
+	"github.com/alecthomas/chroma/v2"
 	"github.com/beevik/etree"
 )
 
@@ -82,7 +84,7 @@ const (
 )
 
 // NewWindowControls returns a colorful window bar element.
-func NewWindowControls(r float64, x, y float64) *etree.Element {
+func NewWindowControls(r float64, x, y float64) (*etree.Element, float64) {
 	bar := etree.NewElement("svg")
 	for i, color := range []string{red, yellow, green} {
 		circle := etree.NewElement("circle")
@@ -92,7 +94,45 @@ func NewWindowControls(r float64, x, y float64) *etree.Element {
 		circle.CreateAttr("fill", color)
 		bar.AddChild(circle)
 	}
-	return bar
+	controlsWidth := float64(len(bar.ChildElements()))*float64(x) + float64(r)*2
+	return bar, controlsWidth
+}
+
+// NewWindowTitle returns a title element with the given text.
+func NewWindowTitle(positions []float64, position string, fs float64, ff, text string, s *chroma.Style) (*etree.Element, error) {
+	if text == "" || text == "-" {
+		return nil, errors.New("Invalid title provided")
+	}
+	if position != "left" && position != "center" && position != "right" {
+		return nil, errors.New("Invalid title position. Must be one of \"left\", \"center\", or \"right\"")
+	}
+	// positions[0] left, [1] center, [2] right, [3] top
+	x := 0.0
+	y := positions[3]
+	var anchor string
+	switch position {
+	case "left":
+		x = positions[0]
+		anchor = "start"
+		break
+	case "center":
+		x = positions[1]
+		anchor = "middle"
+		break
+	case "right":
+		x = positions[2]
+		anchor = "end"
+		break
+	}
+	input := etree.NewElement("text")
+	input.CreateAttr("font-size", fmt.Sprintf("%.2fpx", fs))
+	input.CreateAttr("fill", s.Get(chroma.Text).Colour.String())
+	input.CreateAttr("font-family", ff)
+	input.CreateAttr("text-anchor", anchor)
+	input.CreateAttr("alignment-baseline", "middle")
+	input.SetText(text)
+	Move(input, float64(x), float64(y))
+	return input, nil
 }
 
 // SetDimensions sets the width and height of the given element.

test/configurations/full.json

@@ -1,5 +1,9 @@
 {
   "window": true,
+	"title": {
+		"text": "auto",
+		"position": "center"
+	},
   "theme": "charm",
   "border": {
     "radius": 8,
@@ -24,4 +28,4 @@
     "size": 14
   },
   "line_height": 1.2
-}
+}