v0.2.0 - Usability Update

This release focuses on the usability of the diagram view by adding new features that improve the experience. These include the persistence of diagram options between sessions, as well as the ability to disable diagram view syncing in VS Code.

Usage

The new version of the CLI is attached to this release and the VS Code extension is published to the marketplaces. Please refer to the initial release for usage information.

Features

• [all]: Diagram views are now able to long-term persist data. This has been applied to the diagram options, which will be remembered between application restarts. #12
  • To clear all persisted data, a command has been added to the VS Code command palette, as well as a flag to the CLI.
• [klighd-vscode]: By default, the visualized diagram changes when the active editor changes in VS Code. A command button has been added to the diagram view toolbar that disables this behavior. #13
  • When disabled, the view does not update on active editor changes. "Open in Diagram" overwrites this behavior to change the visualized diagram explicitly.
• [klighd-vscode]: Add a new klighd-vscode.dispatchAction command, which enables other host extensions to dispatch actions in klighd-core for all open webviews that belong to the host extension. #15
  • Refer to the extension overview to learn more about the command usage.
• [klighd-cli]: Add a global option --port (short -p) that can be used to overwrite the port of the web server. #14
• [klighd-cli]: Add a new serve command to start the web server without providing a file and opening the diagram view automatically. #14
  • The new command is useful to start the web server when the diagram view is embedded into local documentation via an iframe.
  • The previous behavior has been moved to the open command, which is executed by default.

Fixes

• [all]: In the diagram options panel, text inputs and their label used a horizontal layout instead of a vertical layout. #10
  • This also applies a theme to text inputs so they are no longer a white box on a dark background when a dark theme is used.
• [klighd-cli]: Previously, the CLI help text used a static name for the program. To avoid confusion, the name is now dynamically acquired from the actual program call. #14
• [klighd-cli]: Command and option descriptions have been refined to better match the auto-generated help text. #14

Documentation

• [klighd-cli]: Added a usage example of "Using the CLI for Local Documentation" in examples/local-documentation. #16
  • This example highlights how the CLI can be used to embed diagram views in locally hosted web-based documentation.