https://github.com/openvalidation/openvalidation-vscode

openVALIDATION extension for VSCode
https://github.com/openvalidation/openvalidation-vscode

Last synced: 6 months ago
JSON representation

openVALIDATION extension for VSCode

• Host: GitHub
• URL: https://github.com/openvalidation/openvalidation-vscode
• Owner: openvalidation
• Created: 2019-12-16T06:37:12.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T06:17:39.000Z (about 3 years ago)
• Last Synced: 2025-08-16T07:46:47.521Z (6 months ago)
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=openVALIDATION.vscode-ov
• Size: 2.98 MB
• Stars: 3
• Watchers: 4
• Forks: 1
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

          
# Language Support for openVALIDATION for Visual Studio Code

[![version](https://vsmarketplacebadge.apphb.com/version/openVALIDATION.vscode-ov.svg)](https://marketplace.visualstudio.com/items?itemName=openVALIDATION.vscode-ov)

[![downloads](https://vsmarketplacebadge.apphb.com/downloads-short/openVALIDATION.vscode-ov.svg)](https://vsmarketplacebadge.apphb.com/downloads-short/openVALIDATION.vscode-ov.svg)

This extension provides support for the domain specific language [openVALIDATION](https://github.com/openvalidation/openvalidation).

The extension uses the [ov-language-server](https://github.com/openvalidation/ov-language-server) to provide the language features.

## Requirements

This extension starts the language-server, which requires the REST-API of openVALIDATION. To be independent of the internet connection, the REST-API get started by the language-server. Because openVALIDATION was written in Java, Java is required to run the extension.

For Windows, we deliver the JRE of openJDK8 to avoid this. But on other platforms like Linux, Java is required to run the extension. We're working on a better solution.

## Features

All [features](https://github.com/openvalidation/ov-language-server#implemented-features-of-the-protocol) that are implemented in the language-server are provided here. In addition to the features of the [Language-Server-Protocol](https://microsoft.github.io/language-server-protocol/) we provide semantical highlighting, which is also implemented in the language-server. The semantical highlighting is implemented with the [decorations-API](https://vscode.rocks/decorations/) of VSCode.

Besides, the extension generates code from the written openVALIDATION code.

The programming language can be picked from the available programming languages.

Also, the folder where the code should be generated can be picked in the settings.

![General features](images/vscode-ov.gif)

## Extension Settings

This extension contributes the following settings:

- `openVALIDATION.culture`: specifies the natural language of the openVALIDATION code

- `openVALIDATION.language`: defines the programming language of the generated code

- `openVALIDATION.codeGeneration.path`: defines the folder where the code should be generated to

The language and culture can also be changed with the status bar:

![Changing with status bar](images/status-bar.gif)

## Known Issues

Nearly all currently released features of openVALIDATION are supported here. But we currently don't support multiple files which are bundled with the [import](https://docs.openvalidation.io/grammatik/strukturierung-des-regelwerkes#splitting-the-set-of-rules-into-several-files) command. We still need to find a way to implement language features for multiple files in openVALIDATION.