Adding the export functionality

rogeruiz / scuttle

An automation translation layer for working with Structurizr DSL

https://github.com/rogeruiz/scuttle/issues/9

GNU Affero General Public License v3.0

24 stars 6 forks source link

Adding the export functionality #13

Open rogeruiz opened 2 years ago

rogeruiz commented 2 years ago

Adding the basic functionality for the export method. This addresses the issues brought up in #11.

Acceptance criteria

[x] Adding in the export library
[x] Figure out how to launch Structurizr-CLI
- [x] Have Export leverage the Structurizr-CLI Docker image
- [ ] ~~Have Export leverage calling the Java code in Structurizr-CLI~~
[ ] Export validates the Structurizr-DSL file that gets fed to the export via --workspace.
[ ] Export validates the PlantUML that gets generated

rogeruiz commented 2 years ago

Got stuck tonight on the Async and Sync nature of things. We'll see how it pans out. I'm going to read this book for now.

https://rust-lang.github.io/async-book/01_getting_started/03_state_of_async_rust.html#compatibility-considerations

rogeruiz commented 1 year ago

More thoughts on error handling here from the Rust Discord.

make your own struct around a pathbuf and use the try_from thing

rogeruiz commented 1 year ago

From reading more on Structs and TryFrom, I don't think that's going to be the best thing to do here.

https://doc.rust-lang.org/stable/rust-by-example/conversion/try_from_try_into.html

https://doc.rust-lang.org/std/keyword.impl.html

I do think a custom Structs and some implementation functions make sense here for ergonomics. Especially since I'll be using this logic in two command to start.

rogeruiz commented 1 year ago

While testing this with @felipe-lee, I found that I don't have good error handling for when the Docker socket is not actively running on a users machine. Thanks, Felipe!