Export workspace as DSL.json

[lfb0801]

Description

I'm wondering why the functionality of translating the Structurizr-java workspace object to the Structurizr-dsl workspace.json file is not a feature yet.
For a school project we want to generate the DSL in one project using the Structurizr-java project, and then send it to another project that will implement Structurizr-ui and will render the workspace.

I am capable of creating this translation myself and making a PR, but I'm wondering why it hadn't been implemented yet. (maybe it is, but I haven't found it yet 😄)

Are there any reason why I wouldn't want to make this translation?
Would this be a valuable addition to the project?

Kind regards

Priority

Low

Resolution

I have no budget, please add this feature for free

More information

No response

[simonbrowndotje]

The structurizr/java library already has functionality to export a workspace to JSON. For example:

    public static void main(String[] args) throws Exception {
        Workspace workspace = new Workspace("Getting Started", "This is a model of my software system.");
        Model model = workspace.getModel();

        Person user = model.addPerson("User", "A user of my software system.");
        SoftwareSystem softwareSystem = model.addSoftwareSystem("Software System", "My software system.");
        user.uses(softwareSystem, "Uses");

        ViewSet views = workspace.getViews();
        SystemContextView contextView = views.createSystemContextView(softwareSystem, "SystemContext", "An example of a System Context diagram.");
        contextView.addAllSoftwareSystems();
        contextView.addAllPeople();

        // export to JSON string
        String json = WorkspaceUtils.toJson(workspace, false);

        // export to JSON file
        WorkspaceUtils.saveWorkspaceToJson(workspace, new File("workspace.json"));
    }

[dariuszwojciech]

Hello,

I found this thread as I was looking for a way to get a neat model from workspace (not JSON but a clean model). Is that at all possible by any chance?
Thank you so much in advance!

Best wishes,
Dariusz

[lfb0801]

It would be nice to be able to call:

WorkspaceUtils.saveWorkspaceToDSL(workspace, new File("workspace.dsl"));

or

WorkspaceUtils.toDSL(workspace, false);