Releases: kieler/klighd-vscode
v0.6.0
A bunch of new features and changes have been added to KLighD, see below for their usage.
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
- Add smart zoom support for top-down layout by @Eddykasp in #181
- Allow KImages to refer to arbitrary URIs, which will be linked in the SVG by @NiklasRentzCAU in #187
- cli: add option -a --address to specify where the CLI tool should be hosted. by @NiklasRentzCAU in #193
- Implement client-only layout to allow communication with language servers that don't perform layout. by @NiklasRentzCAU in #195
Changes
- Reuse KImages instead of embedding multiple times. by @NiklasRentzCAU in #188
- Update to Sprotty 1.3.0 by @NiklasRentzCAU in #191
- Increase the sprotty imposed scroll limits to more reasonable values by @Eddykasp in #192
- Only scale up titles if scaling is strictly larger than 1 by @NiklasRentzCAU in #197
- removed working options from blacklist. by @NiklasRentzCAU in #198
Fixes
- Fix option initialization for and handling of proxies in the CLI. by @NiklasRentzCAU in #178
- Scale Factor calculation fix by @NiklasRentzCAU in #190
- Removes the double diagram request on opening VS Code with no editor in focus by @NiklasRentzCAU in #200
Tooling/Infrastructure
- Add lint-fix command to automatically fix linter problems by @Eddykasp in #183
- Improve production/development minimization/debuggability by @NiklasRentzCAU in #199
Full Changelog: v0.5.0...v0.6.0
Contributors
Assets 6
v0.5.0
A bunch of new features and changes have been added to KLighD, see below for their usage.
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
- core: Implement image clip renderings. by @NiklasRentzCAU in #138
- support for top-down scalefactor by @Eddykasp in #153
- Proxy Views by @fight4day in #86
- Interactive tree layout and relative constraints for layered by @soerendomroes in #125
Changes
- Core: switched tabs + added quickbar for options by @TheRichmend in #145
- removed direct graph properties that have been previously moved to the general graph properties by @NiklasRentzCAU in #165
- adapt to ID generation changes in KLighD by @NiklasRentzCAU in #152
Fixes
- fixes overlayed titles sometimes having an unexpected offset. by @NiklasRentzCAU in #129
- child placement and rendering bounding box fixes by @NiklasRentzCAU in #130
- Build fixes for Windows by @NiklasRentzCAU in #131
- Fix style propagation and order of style handling. by @NiklasRentzCAU in #132
- Text rendering fixes by @NiklasRentzCAU in #133
- Hover for sidebar and diagram popup fixes by @NiklasRentzCAU in #137
- cli: fixed example calls in help text to show the executable name. by @NiklasRentzCAU in #147
- Added sidebar icon size css class as a workaround. by @soerendomroes in #158
- API fixes by @NiklasRentzCAU in #172
Tooling/Infrastructure
- Unit testing framework by @Eddykasp in #128
- CI: add caching to workflows by @NiklasRentzCAU in #136
- changed user/mail to a more generic KIELER user. by @NiklasRentzCAU in #144
- Update to Sprotty 0.12 by @NiklasRentzCAU in #150
- allow tests with jsx dependencies by @NiklasRentzCAU in #156
- Version Updates by @NiklasRentzCAU in #162
- Prettier by @NiklasRentzCAU in #164
- Update Deprecated Actions. Bump update-artifact to v4 by @Eddykasp in #171
Full Changelog: v0.4.2...v0.5.0
Contributors
Assets 6
v0.4.2
Patch release to close a possible XSS attack vector
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.
The packages can also be found on https://www.npmjs.com/
Features
Changes
Fixes
- Fixed an XSS attack vector, where the popup text of diagram elements could inject arbitrary script code.
v0.4.1
Minor release with a few small fixes
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.
The packages can also be found on https://www.npmjs.com/
Features
Changes
- Changed sync with editor and refresh icons kieler/kieler-vscode#46 #122
- Removed font "Helvetica Neue" as Sprotty's default from the sidebar to fix issues with it on Windows #123 #126
Fixes
v0.4.0
A quick new release with a bunch of QoL changes
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.
From this release onwards, the packages are also hosted on https://www.npmjs.com/
Features
- vscode: Reopens diagram on start if it was previously opened #100 #111
- better description and handling of render options and actions #110
Changes
- Improved visuals for smart zoom #105
- options sidebar does now automatically close on mouse out, behavior can be toggled
Fixes
- Fixed SVG export #115
v0.3.0
A new release for the latest KLighD 2.2.0 release
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.
From this release onwards, the packages are also hosted on https://www.npmjs.com/
Features
- incremental communication for graph models #26
- new KIELER-style shadows, for better performance and easier translation to pdf #21
- added scale threshold for rendering regions in full detail #22
- added descriptions on diagram option hover #61
- show default selection style as in KlighD #96
Changes
- optimizations from Google Maps for Models project #3 #19
- changed the constant line width to a minimum line width option #22
- BREAKING Removed text bounds estimation from the server part #20. This requires KLighD 2.2.0 or later to function correctly.
- changed default value for text->diagram navigation to
false - BREAKING changed handling of properties on graph and rendering elements to be closer to its original implementation in KLighD #63. This requires KLighD 2.2.0 or later.
- use gradient vector instead of gradient angle for colors to work around an issue in Inkscape #38
- views opened do not take focus until clicked manually #99
Fixes
- fixed drawing of rectangles around texts with disabled smart zoom #22
- fixed drawing titles containing hierarchical renderings #27 #30
- disallow non-closed line renderings (e.g. polylines, splines) to be filled with any color #67
- fixed action execution in some special cases #84 #93
- fixed an encoding issue on Windows for selecting diagram elements #98
and some more minor internal changes and fixes and adaptions to changes in KLighD 2.2.0.
v0.2.1 - Hotfix
A small hotfix to ensure that the "Sync with Editor" command is working as expected 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.
Fixes
[klighd-vscode]: Due to a broken refactor in the "Sync with Editor" feature, the command toggle did not work correctly.- This is now fixed and the feature works as expected. #17
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 newklighd-vscode.dispatchActioncommand, which enables other host extensions to dispatch actions inklighd-corefor 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 newservecommand 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
opencommand, which is executed by default.
- The new command is useful to start the web server when the diagram view is embedded into local documentation via an
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" inexamples/local-documentation. #16- This example highlights how the CLI can be used to embed diagram views in locally hosted web-based documentation.
v0.1.0 - Initial Release
This release marks the initial release of a new VS Code extension and CLI to view KLighD diagrams.
For diagram users
The VS Code extension is supposed to be used by other extension to support diagrams in their projects. Using it
alone is not possible. If you want to try this extension, you should download a depending extension instead. Known extensions are:
osgiviz(on VS Code Marketplace): https://marketplace.visualstudio.com/items?itemName=kieler.osgivizosgiviz(on Open VSX): https://open-vsx.org/extension/kieler/osgiviz
The CLI can be downloaded from the attached release assets below. Execute <bin-name> -h for usage information.
To use the CLI, a language server with KLighD synthesis support is required. This makes the CLI compatible with multiple projects.
A good example is the KIELER language server, which can be downloaded here. Further, a Java 11 installation is required to run the language server.
For extension developers
If you plan to develop an extension that relies on klighd-vscode, you can download the extension from the marketplace, the Open VSX registry, or install it locally from the attached release assets.