search

kieler / kieler-vscode

Eclipse Public License 2.0
5 stars 1 forks source link

readme

KEITH

This monorepo is the home of the KIELER VS Code project. It mainly consists of a Visual Studio Code extension.

Packages

Requirements

Development of this project requires Node.js v16.x and yarn v1.x. Further, language server jars, named kieler-language-server.jar, have to placed in the keith-vscode/server folder to develop the VS Code extension. The latest jars can be downloaded here.

The keith-vscode extension has a dependency on the klighd-vscode to add diagram support. You have to install the extension locally if VS Code is not able to install the dependency automatically.

Scripts

All scripts that are available at the monorepo root. Run a script with yarn <script>.

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 all packages for distribution. E.g. creates a keith-vscode.vsix file.

Developing 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 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 keith-vscode extension should be started.
  6. After changes to your files, run the "Reload Window" command in your dev VS Code instance.

The launch configuration "Launch VS Code Extension (Socket)" can be used to connect to a Language Server run in Eclipse. See the relevant documentation for more setup information.

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 keith-vscode/keith-vscode.vsix