timkolberger / docusaurus-plugin-structurizr Goto Github PK

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• chore(deps): lock file maintenance

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency eslint to v9
• chore(deps): update pnpm/action-setup action to v4

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Description

Currently the plugin only supports to cli version of structurizr. When there is a deployed version of structurizr/onpremises or access to the cloud version this plugin could fetch the converted diagram from their API.

I am not entirely sure that their API supports this though.

# imaginary psuedo code!
POST workspace/$ID
GET workspace/$ID/diagram.{png,svg,mermaid}
DELETE workspace/$ID

OR

POST transform-this-file?format=mermaid

Problem Statement/Justification

The limitations of this plugin, like docker in docker and executing in CI are not straight forward to accomplish, could be mitigated by supporting the API services onpremises and cloud.

Proposed Solution or API

{
  executor: "api",
  apiToken: process.env.STRUCTURIZR_API_TOKEN,
  apiHost: "https://base-url-of-api"
}

Alternatives

No response

Additional Information

Workspace API: https://docs.structurizr.com/onpremises/workspace-api

Description

The diagrams are generated and saved at the same path where the structurizr.dsl is saved.
Moving the generated files to a separated folder will support clarity.

Problem Statement/Justification

When you generate several diagrams you will loose clarity of your folder.
Separating the generated files from the files to edit might be a good pattern.

Proposed Solution or API

Using the the output option of structurizr-cli in export function call would be great:

docker run --rm -v "${docsPath}:/usr/local/structurizr" ${dockerImage} export -workspace "${fileName}" -output diagrams

[Optional] the destination folder could become an option of the plugin.

Alternatives

No response

Additional Information

No response