From 569cb0b8aa5b65fa137fe2d2cbecdf8e164961f4 Mon Sep 17 00:00:00 2001 From: turkmenkaan Date: Tue, 10 Dec 2024 20:00:48 -0500 Subject: [PATCH 1/5] add play cmd --- d2cli/help.go | 1 + d2cli/main.go | 2 ++ d2cli/play.go | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 70 insertions(+) create mode 100644 d2cli/play.go diff --git a/d2cli/help.go b/d2cli/help.go index a786cd7b4e..8338b3af33 100644 --- a/d2cli/help.go +++ b/d2cli/help.go @@ -38,6 +38,7 @@ Subcommands: %[1]s layout [name] - Display long help for a particular layout engine, including its configuration options %[1]s themes - Lists available themes %[1]s fmt file.d2 ... - Format passed files + %[1]s play file.d2 - Opens the file in playground See more docs and the source code at https://oss.terrastruct.com/d2. Hosted icons at https://icons.terrastruct.com. diff --git a/d2cli/main.go b/d2cli/main.go index eeefd6ae91..7823db6b84 100644 --- a/d2cli/main.go +++ b/d2cli/main.go @@ -154,6 +154,8 @@ func Run(ctx context.Context, ms *xmain.State) (err error) { return nil case "fmt": return fmtCmd(ctx, ms) + case "play": + return playSubcommand(ctx, ms) case "version": if len(ms.Opts.Flags.Args()) > 1 { return xmain.UsageErrorf("version subcommand accepts no arguments") diff --git a/d2cli/play.go b/d2cli/play.go new file mode 100644 index 0000000000..9bbd6cf251 --- /dev/null +++ b/d2cli/play.go @@ -0,0 +1,67 @@ +package d2cli + +import ( + "context" + "fmt" + "os" + + "oss.terrastruct.com/d2/lib/urlenc" + "oss.terrastruct.com/util-go/xbrowser" + "oss.terrastruct.com/util-go/xmain" +) + +func playSubcommand(ctx context.Context, ms *xmain.State) error { + if len(ms.Opts.Flags.Args()) != 2 { + return xmain.UsageErrorf("play must be passed one file to open") + } + filepath := ms.Opts.Flags.Args()[1] + + theme, err := ms.Opts.Flags.GetInt64("theme") + if err != nil { + return err + } + + sketch, err := ms.Opts.Flags.GetBool("sketch") + if err != nil { + return err + } + + var sketchNumber int + if sketch { + sketchNumber = 1 + } else { + sketchNumber = 0 + } + + fileRaw, err := readFile(filepath) + if err != nil { + return err + } + + encoded, err := urlenc.Encode(fileRaw) + if err != nil { + return err + } + + url := fmt.Sprintf("https://play.d2lang.com/?l=&script=%s&sketch=%d&theme=%d&", encoded, sketchNumber, theme) + openBrowser(ctx, ms, url) + return nil +} + +func readFile(filepath string) (string, error) { + data, err := os.ReadFile(filepath) + if err != nil { + return "", xmain.UsageErrorf(err.Error()) + } + + return string(data), nil +} + +func openBrowser(ctx context.Context, ms *xmain.State, url string) { + ms.Log.Info.Printf("opening playground: %s", url) + + err := xbrowser.Open(ctx, ms.Env, url) + if err != nil { + ms.Log.Warn.Printf("failed to open browser to %v: %v", url, err) + } +} From 7c2b8221ba24caee29812e9ea79a96cb97b80edd Mon Sep 17 00:00:00 2001 From: turkmenkaan Date: Tue, 10 Dec 2024 20:04:27 -0500 Subject: [PATCH 2/5] add more help info --- d2cli/help.go | 1 + 1 file changed, 1 insertion(+) diff --git a/d2cli/help.go b/d2cli/help.go index 8338b3af33..010118c222 100644 --- a/d2cli/help.go +++ b/d2cli/help.go @@ -22,6 +22,7 @@ Usage: %[1]s [--watch=false] [--theme=0] file.d2 [file.svg | file.png] %[1]s layout [name] %[1]s fmt file.d2 ... + %[1]s play [--theme=0] [--sketch] file.d2 %[1]s compiles and renders file.d2 to file.svg | file.png It defaults to file.svg if an output path is not provided. From 5f5792847c5d23569cea4578b28ce62199b7ba49 Mon Sep 17 00:00:00 2001 From: Alexander Wang Date: Tue, 4 Feb 2025 06:40:08 -0700 Subject: [PATCH 3/5] address pr comments --- d2cli/help.go | 2 +- d2cli/main.go | 2 +- d2cli/play.go | 20 ++++++++++++++------ 3 files changed, 16 insertions(+), 8 deletions(-) diff --git a/d2cli/help.go b/d2cli/help.go index 010118c222..6d1ea05677 100644 --- a/d2cli/help.go +++ b/d2cli/help.go @@ -39,7 +39,7 @@ Subcommands: %[1]s layout [name] - Display long help for a particular layout engine, including its configuration options %[1]s themes - Lists available themes %[1]s fmt file.d2 ... - Format passed files - %[1]s play file.d2 - Opens the file in playground + %[1]s play file.d2 - Opens the file in playground, an online web viewer (https://play.d2lang.com) See more docs and the source code at https://oss.terrastruct.com/d2. Hosted icons at https://icons.terrastruct.com. diff --git a/d2cli/main.go b/d2cli/main.go index 7823db6b84..de4dded2a4 100644 --- a/d2cli/main.go +++ b/d2cli/main.go @@ -155,7 +155,7 @@ func Run(ctx context.Context, ms *xmain.State) (err error) { case "fmt": return fmtCmd(ctx, ms) case "play": - return playSubcommand(ctx, ms) + return playCmd(ctx, ms) case "version": if len(ms.Opts.Flags.Args()) > 1 { return xmain.UsageErrorf("version subcommand accepts no arguments") diff --git a/d2cli/play.go b/d2cli/play.go index 9bbd6cf251..f32590576a 100644 --- a/d2cli/play.go +++ b/d2cli/play.go @@ -3,6 +3,7 @@ package d2cli import ( "context" "fmt" + "io" "os" "oss.terrastruct.com/d2/lib/urlenc" @@ -10,9 +11,9 @@ import ( "oss.terrastruct.com/util-go/xmain" ) -func playSubcommand(ctx context.Context, ms *xmain.State) error { +func playCmd(ctx context.Context, ms *xmain.State) error { if len(ms.Opts.Flags.Args()) != 2 { - return xmain.UsageErrorf("play must be passed one file to open") + return xmain.UsageErrorf("play must be passed one argument: either a filepath or '-' for stdin") } filepath := ms.Opts.Flags.Args()[1] @@ -33,7 +34,7 @@ func playSubcommand(ctx context.Context, ms *xmain.State) error { sketchNumber = 0 } - fileRaw, err := readFile(filepath) + fileRaw, err := readInput(filepath) if err != nil { return err } @@ -43,17 +44,24 @@ func playSubcommand(ctx context.Context, ms *xmain.State) error { return err } - url := fmt.Sprintf("https://play.d2lang.com/?l=&script=%s&sketch=%d&theme=%d&", encoded, sketchNumber, theme) + url := fmt.Sprintf("https://play.d2lang.com/?script=%s&sketch=%d&theme=%d&", encoded, sketchNumber, theme) openBrowser(ctx, ms, url) return nil } -func readFile(filepath string) (string, error) { +func readInput(filepath string) (string, error) { + if filepath == "-" { + data, err := io.ReadAll(os.Stdin) + if err != nil { + return "", fmt.Errorf("error reading from stdin: %w", err) + } + return string(data), nil + } + data, err := os.ReadFile(filepath) if err != nil { return "", xmain.UsageErrorf(err.Error()) } - return string(data), nil } From 7c132758abe37645105e37c068497e0483d88c90 Mon Sep 17 00:00:00 2001 From: Alexander Wang Date: Tue, 4 Feb 2025 06:42:15 -0700 Subject: [PATCH 4/5] next.md --- ci/release/changelogs/next.md | 1 + 1 file changed, 1 insertion(+) diff --git a/ci/release/changelogs/next.md b/ci/release/changelogs/next.md index 748687cad2..fb288461eb 100644 --- a/ci/release/changelogs/next.md +++ b/ci/release/changelogs/next.md @@ -9,6 +9,7 @@ - CLI: PNG output to stdout is supported using `--stdout-format png -` [#2291](https://github.com/terrastruct/d2/pull/2291) - Globs: `&connected` and `&leaf` filters are implemented [#2299](https://github.com/terrastruct/d2/pull/2299) - CLI: add --no-xml-tag for direct HTML embedding [#2302](https://github.com/terrastruct/d2/pull/2302) +- CLI: `play` cmd added for opening d2 input in online playground [#2242](https://github.com/terrastruct/d2/pull/2242) #### Improvements 🧹 From 5a9154b37212abaa3822be858ebd84083026d12c Mon Sep 17 00:00:00 2001 From: Alexander Wang Date: Tue, 4 Feb 2025 06:47:35 -0700 Subject: [PATCH 5/5] man page --- ci/release/template/man/d2.1 | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/ci/release/template/man/d2.1 b/ci/release/template/man/d2.1 index 90831ef730..24ebdd7e18 100644 --- a/ci/release/template/man/d2.1 +++ b/ci/release/template/man/d2.1 @@ -15,6 +15,8 @@ .Ar layout Op Ar name .Nm d2 .Ar fmt Ar file.d2 ... +.Nm d2 +.Ar play Ar file.d2 .Sh DESCRIPTION .Nm compiles and renders @@ -141,6 +143,9 @@ Print version information and exit .It Fl -stdout-format Ar string Set the output format when writing to stdout. Supported formats are: png, svg. Only used when output is set to stdout (-) .Ns . +.It Fl -no-xml-tag Ar false +Omit XML tag () from output SVG files. Useful when generating SVGs for direct HTML embedding +.Ns . .El .Sh SUBCOMMANDS .Bl -tag -width Fl @@ -155,10 +160,8 @@ Lists available themes .Ns . .It Ar fmt Ar file.d2 ... Format all passed files -.It Fl -no-xml-tag Ar false -Omit XML tag () from output SVG files. Useful when generating SVGs for direct HTML embedding -.Ns . -.Ns . +.It Ar play Ar file.d2 +Opens the file in playground, an online web viewer (https://play.d2lang.com) .El .Sh ENVIRONMENT VARIABLES Many flags can also be set with environment variables.