https://github.com/simonhorlick/kind-vscode

A language server protocol implementation and vscode plugin for the Formality programming language.
https://github.com/simonhorlick/kind-vscode

formality vscode

Last synced: 3 months ago
JSON representation

A language server protocol implementation and vscode plugin for the Formality programming language.

• Host: GitHub
• URL: https://github.com/simonhorlick/kind-vscode
• Owner: simonhorlick
• License: mit
• Created: 2021-02-15T05:16:26.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-03-05T21:06:30.000Z (over 3 years ago)
• Last Synced: 2025-04-06T07:43:27.378Z (about 1 year ago)
• Topics: formality, vscode
• Language: TypeScript
• Homepage:
• Size: 3.25 MB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# kind-vscode

A Visual Studio Code plugin for the Kind programming language. This plugin provides output from the kind typechecker to VSCode.

![Screenshot of the plugin displaying a diagnostic message](https://github.com/simonhorlick/kind-vscode/raw/main/example.png)

## Architecture

![A architecture diagram showing the high level components](https://github.com/simonhorlick/kind-vscode/raw/main/architecture.jpg)

This extension is structured as three pieces:

- A vscode extension that launches kind-lsp

- A language server, kind-lsp, that's written in node and contains the state

- A set of functions for computing results, written in Kind.

## Structure

```

.

├── client // Language Client

│   ├── src

│   │   ├── test // End to End tests for Language Client / Server

│   │   └── extension.ts // Language Client entry point

├── package.json // The extension manifest.

└── server // Language Server

    └── src

        └── server.ts // Language Server entry point

```

## Getting Started

To install all of the necessary dependencies, run

```bash

npm install

```

In VSCode there is a launch configuration named "Launch Client" that will start an instance of VSCode with the plugin enabled.

## Roadmap

The following features are planned:

- [ ] Hover over a symbol to view its documentation

- [x] Jump to definition

- [ ] Autocompletion

- [ ] Rename symbol

- [ ] Support for other editors, for example: Atom, vim