Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Cmd optional arg to not render terminal window #7

Merged
merged 4 commits into from
Feb 14, 2024
Merged

Cmd optional arg to not render terminal window #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ceb7ddc
Change colWidth to avoid collisions
boogeroccam Feb 14, 2024
d88d161
Add option to not render terminal window
boogeroccam Feb 14, 2024
c1352fc
Add test & change cli description
boogeroccam Feb 14, 2024
3aa0859
Overriding background color for render without term-window
boogeroccam Feb 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions cmd/termsvg/export/export.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
File string `arg:"" type:"existingfile" help:"asciicast file to export"`
Output string `optional:"" short:"o" type:"path" help:"where to save the file. Defaults to <input_file>.svg"`
Mini bool `name:"minify" optional:"" short:"m" help:"minify output file. May be slower"`
NoWindow bool `name:"nowindow" optional:"" short:"n" help:"don't render terminal window in svg"`
BackgroundColor string `optional:"" short:"b" help:"background color in hexadecimal format (e.g. #FFFFFF)"`
TextColor string `optional:"" short:"t" help:"text color in hexadecimal format (e.g. #000000)"`
}
Expand All @@ -25,7 +26,7 @@
output = cmd.File + ".svg"
}

err := export(cmd.File, output, cmd.Mini, cmd.BackgroundColor, cmd.TextColor)
err := export(cmd.File, output, cmd.Mini, cmd.BackgroundColor, cmd.TextColor, cmd.NoWindow)
if err != nil {
return err
}
Expand All @@ -35,7 +36,7 @@
return nil
}

func export(input, output string, mini bool, bgColor, textColor string) error {
func export(input, output string, mini bool, bgColor, textColor string, no_window bool) error {

Check warning on line 39 in cmd/termsvg/export/export.go

View workflow job for this annotation

GitHub Actions / lint 

var-naming: don't use underscores in Go names; func parameter no_window should be noWindow (revive)
inputFile, err := os.ReadFile(input)
if err != nil {
return err
Expand All @@ -54,7 +55,7 @@

if mini {
out := new(bytes.Buffer)
svg.Export(*cast, out, bgColor, textColor)
svg.Export(*cast, out, bgColor, textColor, no_window)

m := minify.New()
m.AddFunc("image/svg+xml", msvg.Minify)
Expand All @@ -69,7 +70,7 @@
return err
}
} else {
svg.Export(*cast, outputFile, bgColor, textColor)
svg.Export(*cast, outputFile, bgColor, textColor, no_window)
}

return nil
Expand Down
33 changes: 20 additions & 13 deletions internal/svg/svg.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

const (
rowHeight = 25
colWidth = 11
colWidth = 12
padding = 20
headerSize = 3
)
Expand All @@ -26,7 +26,7 @@
backgroundColorOverride = ""
)

type Canvas struct {

Check failure on line 29 in internal/svg/svg.go

View workflow job for this annotation

GitHub Actions / lint 

type must not be placed after const (desired order: type,const,var,func) (decorder)
*svg.SVG
asciicast.Cast
id *uniqueid.ID
Expand All @@ -35,27 +35,42 @@
colors map[string]string
}

type Output interface {

Check failure on line 38 in internal/svg/svg.go

View workflow job for this annotation

GitHub Actions / lint 

type must not be placed after const (desired order: type,const,var,func) (decorder)
io.Writer
}

func Export(input asciicast.Cast, output Output, bgColor, textColor string) {
func Export(input asciicast.Cast, output Output, bgColor, textColor string, no_window bool) {

Check warning on line 42 in internal/svg/svg.go

View workflow job for this annotation

GitHub Actions / lint 

var-naming: don't use underscores in Go names; func parameter no_window should be noWindow (revive)
// Set the custom foreground and background colors
foregroundColorOverride = textColor
backgroundColorOverride = bgColor

input.Compress() // to reduce the number of frames

createCanvas(svg.New(output), input)
createCanvas(svg.New(output), input, no_window)
}

func createCanvas(svg *svg.SVG, cast asciicast.Cast) {
func createCanvas(svg *svg.SVG, cast asciicast.Cast, no_window bool) {

Check warning on line 52 in internal/svg/svg.go

View workflow job for this annotation

GitHub Actions / lint 

var-naming: don't use underscores in Go names; func parameter no_window should be noWindow (revive)
canvas := &Canvas{SVG: svg, Cast: cast, id: uniqueid.New(), colors: make(map[string]string)}
canvas.width = cast.Header.Width * colWidth
canvas.height = cast.Header.Height * rowHeight

parseCast(canvas)
canvas.createWindow()
canvas.Start(canvas.paddedWidth(), canvas.paddedHeight())
if !no_window {

Check failure on line 59 in internal/svg/svg.go

View workflow job for this annotation

GitHub Actions / lint 

if statements should only be cuddled with assignments (wsl)
canvas.createWindow()
canvas.Group(fmt.Sprintf(`transform="translate(%d,%d)"`, padding, padding*headerSize))
} else {
if backgroundColorOverride == "" {
canvas.Rect(0, 0, canvas.paddedWidth(), canvas.paddedHeight(), "fill:#282d35")
} else {
canvas.Rect(0, 0, canvas.paddedWidth(), canvas.paddedHeight(), "fill:"+backgroundColorOverride)
}
canvas.Group(fmt.Sprintf(`transform="translate(%d,%d)"`, padding, int(padding*1.5)))

Check failure on line 68 in internal/svg/svg.go

View workflow job for this annotation

GitHub Actions / lint 

mnd: Magic number: 1.5, in <argument> detected (gomnd)
}
canvas.addStyles()

Check failure on line 70 in internal/svg/svg.go

View workflow job for this annotation

GitHub Actions / lint 

expressions should not be cuddled with blocks (wsl)
canvas.createFrames()
canvas.Gend() // Transform
canvas.Gend() // Styles
canvas.End()
}

Expand Down Expand Up @@ -108,8 +123,6 @@
buttonRadius := 7
buttonColors := [3]string{"#ff5f58", "#ffbd2e", "#18c132"}

c.Start(c.paddedWidth(), c.paddedHeight())

// If the user has specified a background color, use that instead of the default
if backgroundColorOverride != "" {
c.Roundrect(0, 0, c.paddedWidth(), c.paddedHeight(), windowRadius, windowRadius, "fill:"+backgroundColorOverride)
Expand All @@ -120,11 +133,6 @@
for i := range buttonColors {
c.Circle((i*(padding+buttonRadius/2))+padding, padding, buttonRadius, fmt.Sprintf("fill:%s", buttonColors[i]))
}

c.addStyles()
c.createFrames()
c.Gend() // Transform
c.Gend() // Styles
}

func (c *Canvas) addStyles() {
Expand All @@ -150,8 +158,7 @@
} else {
styles += colors.String()
}
c.Style("text/css", styles)

Check failure on line 161 in internal/svg/svg.go

View workflow job for this annotation

GitHub Actions / lint 

expressions should not be cuddled with blocks (wsl)
c.Group(fmt.Sprintf(`transform="translate(%d,%d)"`, padding, padding*headerSize))
}

func (c *Canvas) createFrames() {
Expand Down Expand Up @@ -185,7 +192,7 @@
if cell.Char == ' ' {
lastColummn = col + 1
continue
} else {

Check warning on line 195 in internal/svg/svg.go

View workflow job for this annotation

GitHub Actions / lint 

superfluous-else: if block ends with a continue statement, so drop this else and outdent its block (revive)
lastColor = cell.FG
lastColummn = col
}
Expand Down
21 changes: 19 additions & 2 deletions internal/svg/svg_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,29 @@ func TestExport(t *testing.T) {
var output bytes.Buffer

// Pass empty override bg and text colors
svg.Export(*cast, &output, "", "")
svg.Export(*cast, &output, "", "", false)

g := goldie.New(t)
g.Assert(t, "TestExportOutput", output.Bytes())
}

func TestNoWindow(t *testing.T) {
input := testutils.GoldenData(t, "TestExportInput")

cast, err := asciicast.Unmarshal(input)
if err != nil {
t.Fatal(err)
}

var output bytes.Buffer

// Pass empty override bg and text colors
svg.Export(*cast, &output, "", "", true)

g := goldie.New(t)
g.Assert(t, "TestExportOutputNoWindow", output.Bytes())
}

func BenchmarkExport(b *testing.B) {
input := testutils.GoldenData(b, "TestExportInput")

Expand All @@ -39,6 +56,6 @@ func BenchmarkExport(b *testing.B) {
var output bytes.Buffer

// Pass empty override bg and text colors
svg.Export(*cast, &output, "", "")
svg.Export(*cast, &output, "", "", false)
}
}
16 changes: 8 additions & 8 deletions internal/svg/testdata/TestExportOutput.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
<?xml version="1.0"?>
<!-- Generated by SVGo -->
<svg width="2383" height="1510"
<svg width="2596" height="1510"
xmlns="http://www.w3.org/2000/svg"
xmlns:xlink="http://www.w3.org/1999/xlink">
<rect x="0" y="0" width="2383" height="1510" rx="5" ry="5" style="fill:#282d35" />
<rect x="0" y="0" width="2596" height="1510" rx="5" ry="5" style="fill:#282d35" />
<circle cx="20" cy="20" r="7" style="fill:#ff5f58" />
<circle cx="43" cy="20" r="7" style="fill:#ffbd2e" />
<circle cx="66" cy="20" r="7" style="fill:#18c132" />
<g transform="translate(20,60)" >
<g style="animation-duration:3.35s;animation-iteration-count:infinite;animation-name:k;animation-timing-function:steps(1,end);font-family:Monaco,Consolas,Menlo,'Bitstream Vera Sans Mono','Powerline Symbols',monospace;font-size:20px">
<style type="text/css">
<![CDATA[
@keyframes k {79.807%{transform:translateX(-0px)}82.298%{transform:translateX(-2383px)}87.777%{transform:translateX(-4766px)}92.767%{transform:translateX(-7149px)}100.000%{transform:translateX(-9532px)}}.a{fill:#e5e5e5}
@keyframes k {79.807%{transform:translateX(-0px)}82.298%{transform:translateX(-2596px)}87.777%{transform:translateX(-5192px)}92.767%{transform:translateX(-7788px)}100.000%{transform:translateX(-10384px)}}.a{fill:#e5e5e5}
]]>
</style>
<g transform="translate(20,60)" >
<g transform="translate(0)">
<text x="0" y="0" class="a" >h</text>
</g>
<g transform="translate(2383)">
<g transform="translate(2596)">
<text x="0" y="0" class="a" >he</text>
</g>
<g transform="translate(4766)">
<g transform="translate(5192)">
<text x="0" y="0" class="a" >hel</text>
</g>
<g transform="translate(7149)">
<g transform="translate(7788)">
<text x="0" y="0" class="a" >hell</text>
</g>
<g transform="translate(9532)">
<g transform="translate(10384)">
<text x="0" y="0" class="a" >hello</text>
</g>
</g>
Expand Down
31 changes: 31 additions & 0 deletions internal/svg/testdata/TestExportOutputNoWindow.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?xml version="1.0"?>
<!-- Generated by SVGo -->
<svg width="2596" height="1510"
xmlns="http://www.w3.org/2000/svg"
xmlns:xlink="http://www.w3.org/1999/xlink">
<rect x="0" y="0" width="2596" height="1510" style="fill:#282d35" />
<g transform="translate(20,30)" >
<g style="animation-duration:3.35s;animation-iteration-count:infinite;animation-name:k;animation-timing-function:steps(1,end);font-family:Monaco,Consolas,Menlo,'Bitstream Vera Sans Mono','Powerline Symbols',monospace;font-size:20px">
<style type="text/css">
<![CDATA[
@keyframes k {79.807%{transform:translateX(-0px)}82.298%{transform:translateX(-2596px)}87.777%{transform:translateX(-5192px)}92.767%{transform:translateX(-7788px)}100.000%{transform:translateX(-10384px)}}.a{fill:#e5e5e5}
]]>
</style>
<g transform="translate(0)">
<text x="0" y="0" class="a" >h</text>
</g>
<g transform="translate(2596)">
<text x="0" y="0" class="a" >he</text>
</g>
<g transform="translate(5192)">
<text x="0" y="0" class="a" >hel</text>
</g>
<g transform="translate(7788)">
<text x="0" y="0" class="a" >hell</text>
</g>
<g transform="translate(10384)">
<text x="0" y="0" class="a" >hello</text>
</g>
</g>
</g>
</svg>
Loading