Skip to content

Latest commit

 

History

History
121 lines (92 loc) · 7.61 KB

README.md

File metadata and controls

121 lines (92 loc) · 7.61 KB
Raw

KLighD for the web

The repository contains multiple projects that use web technologies to visualize KLighD generated diagrams.

Packages

This repository contains a monorepo for different KLighD related, web-based packages. The packages are seperated in two types:

  • Packages that produce usable applications are placed in the applications folder.
  • Packages that serve as library code are placed in the packages folder.
Package name Type Description
@kieler/klighd-core library Core package to visualize KLighD generated diagrams. Based on Sprotty.
@kieler/klighd-interactive library Support module for klighd-core to interactively apply constraints to the diagram.
@kieler/klighd-cli application CLI and web-server to visualize diagrams in the browser using klighd-core`.
klighd-vscode application Visual Studio Code extension that uses klighd-core to add diagram support to VS Code. Should be used by other extensions to visualize their KLighD generated diagrams.

KlighD Release Mapping

klighd-vscode KlighD
0.1.0 2.1.0
0.2.0 2.1.0
0.2.1 2.1.0
0.3.0 2.2.0

Moreover, the default branches of both repositories should be compatible but might experience regression.

Contributing

Requirements

Development of this project requires Node.js v14.x and yarn v1.x.

Developing the klighd-vscode extension requires an extension that has a dependency on klighd-vscode and provides a language client with KLighD synthesis capabilities. A good candidate for development is the kieler.keith-vscode (under development) extension.

Furthermore, development of the klighd-cli requires a language server with KLighD synthesis capabilities. The server can either be started separately, using a socket for communication, or placed as a jar named language-server.jar in the applications/klighd-cli folder.

Disclaimer

Developing a language server that uses KLighD to fulfill all requirements to be usable with these applications is no easy task. Until the distribution of KLighD and documentation about building your own language server is improved, feel free to seek advice from a member of the KIELER working group.

An example for a simple language server with KLighD synthesis support can be found here. Configuration for the build process using Maven Tycho can be found here. The VS Code extension for this language server can be found here.

Scripts

All scripts that are available at the monorepo root. Run a script with yarn <script>. More specific scripts may be provided by each package.

Script name Description
clean Removes all build results in each package.
lint Runs eslint in all packages to identify style problems.
build Builds all packages for production.
watch Builds all packages for development in watch mode.
package Builds and packages supported packages for distribution. E.g. creates a klighd-vscode.vsix file and creates self-contained CLI binaries.
distribute Builds and publishes configured application builds. (Script name "publish" is preserved for publishing packages )

Developing using the klighd-cli

  1. Fulfill the requirements above.
  2. Run yarn in the monorepo root to install all dependencies (if not already done).
  3. (only on the first build:) Run yarn build to first do a sequential build to link the internal dependencies.
  4. Run yarn watch in the monorepo root to watch all packages for changes.
  5. Run yarn start or yarn socket in the applications/klighd-cli folder to start a web-server, serving the standalone view.
    • yarn start uses a language-server.jar file placed in the klighd-cli folder.
    • yarn socket uses a socket connection (default port 5007) to connect to the LS.
  6. Navigate to http://localhost:8000?source=file:///<path-to-diagram-file> in your browser to inspect the standalone view.

Create self-contained klighd-cli binaries

  1. Fulfill the requirements above.
  2. Run yarn in the monorepo root to install all dependencies (if not already done).
  3. Run yarn package
  4. The packaged CLI can be found in applications/klighd-cli/bin with a version for each platform.

The self-contained CLI does not contain a language server to make it more flexible for different language servers. Run klighd-{os} -h for information on how to provide a language server for the CLI.

Developing using the VS Code extension

We recommend VS Code to develop the VS Code extension to make use of the provided launch tasks. The following steps have are required to start developing.

  1. Fulfill the requirements above.
  2. Install all workspace recommended extensions.
  3. Run yarn in the monorepo root to install all dependencies (if not already done).
  4. Run the "Launch VS Code Extension" launch configuration. This also runs a task to watch all packages.
  5. A VS Code instance with the klighd-vscode extension should be started.
  6. After changes to your files, run the "Reload Window" command in your dev VS Code instance.

Locally install the VS Code extension

  1. Fulfill the requirements above.
  2. Run yarn in the monorepo root to install all dependencies (if not already done).
  3. Run yarn package
  4. Run code --install-extension applications/klighd-vscode/klighd-vscode.vsix