architecture-as-code icon indicating copy to clipboard operation
architecture-as-code copied to clipboard

Visualizer VSCode Plugin

Open aidanm3341 opened this issue 1 year ago • 0 comments

Feature Request

Using the existing visualizer functionality, it would be useful to have an extension which immediately turns the CALM file to its diagram representation in a VSCode window.

Requirements

  • The extension should be triggered by running a command from the command palette
    • "CALM: Visualize Current File"
  • The visualizer panel should open along side the existing panel
  • The diagram should refresh when you save the CALM file
  • Validation Errors from the CALM file should be displayed in the window so the user can address them

Notes

  • This could be implemented using the VSCode WebView capability https://code.visualstudio.com/api/extension-guides/webview
  • This existing visualisation logic lives here https://github.com/finos/architecture-as-code/tree/main/cli/src/commands/visualize
  • We might need to add an additional piece of logic to determine if the current file is a pattern or an instantiation so we know which path through the logic to take. (This detail is currently provided by the user when they execute the CLI)
    • Alternatively, the simpler approach would be instead to have two commands:
      • "CALM: Visualize Current Pattern"
      • "CALM: Visualize Current Instantiation"

aidanm3341 avatar Apr 03 '24 10:04 aidanm3341