https://github.com/korosuke613/vdmpp-vscode-extension

Smart linting and syntax highlighting(rough) for VDM++ in VSCode.
https://github.com/korosuke613/vdmpp-vscode-extension

language-server-protocol vdmpp visual-studio-code

Last synced: about 1 month ago
JSON representation

Smart linting and syntax highlighting(rough) for VDM++ in VSCode.

• Host: GitHub
• URL: https://github.com/korosuke613/vdmpp-vscode-extension
• Owner: korosuke613
• License: gpl-3.0
• Created: 2020-02-01T19:29:51.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-01-20T20:16:11.000Z (almost 4 years ago)
• Last Synced: 2024-10-18T02:50:23.565Z (2 months ago)
• Topics: language-server-protocol, vdmpp, visual-studio-code
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=korosuke613.vdmpp-extension
• Size: 15.8 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# VDM++ IDE for Visual Studio Code

Smart linting and syntax highlighting(rough) for VDM++ in VSCode using the [VDM++ language server](https://github.com/korosuke613/vdmpp-language-server).

[![Version](https://img.shields.io/visual-studio-marketplace/v/korosuke613.vdmpp-extension)](https://marketplace.visualstudio.com/items?itemName=korosuke613.vdmpp-extension)

[![Downloads](https://img.shields.io/visual-studio-marketplace/d/korosuke613.vdmpp-extension)](https://marketplace.visualstudio.com/items?itemName=korosuke613.vdmpp-extension)

[![Installs](https://img.shields.io/visual-studio-marketplace/i/korosuke613.vdmpp-extension)](https://marketplace.visualstudio.com/items?itemName=korosuke613.vdmpp-extension)

To use, open a VDM++ file(`*.vdmpp`).

The language server will then automatically launch in the background.

## Features

* Linting

* Syntax Highlighting(Rough)

**Future Works**

* [x] Linting

* [x] Syntax Highlighting(rough)

* [ ] Syntax Highlighting(detail)

* [ ] Formatting

* [ ] Document symbols

* [ ] Go-to-definition

* [ ] Code completion

* [ ] Hover

* [ ] Find references

### Syntax Highlighting

Syntax highlight the VDM++ file.

![Syntax Highlighting](https://raw.githubusercontent.com/korosuke613/vdmpp-vscode-extension/master/images/sample-syntax-highlight.png)

### Linting

Lint the VDM++ file.(using [VDMJ](https://github.com/nickbattle/vdmj))

![Linting](https://raw.githubusercontent.com/korosuke613/vdmpp-vscode-extension/master/images/sample-lint.png)

## Development

For the Developper.

### Structure

![Structure](https://raw.githubusercontent.com/korosuke613/vdmpp-vscode-extension/master/images/vdmpp_extension_structure.png)

[Image file is here.](https://sketch.cloud/s/z3zga)

### Seaquence diagram

#### Activate extension

![activate extension](https://raw.githubusercontent.com/korosuke613/vdmpp-vscode-extension/master/images/activate_extension_sequence.png)

### Packageing

```bash

vsce package

```

### Debugging

1. git clone this repository

2. open directory with vscode

4. open command parette `Cmd + Shift + p`

5. input "start debugging"

6. select "Launch Extension"

#### Change read LSP Server

You can change read LSP Server.

1. Open `src/extension.ts`

2. Change `path.resolve(context.extensionPath,in~~~` in `server.listen()`.

**COUTION: Don't commit that diff.**

##### example

![change LSP Server](https://raw.githubusercontent.com/korosuke613/vdmpp-vscode-extension/master/images/change-lsp-server.png)