Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/discus-lang/salt-vscode
Salt Visual Studio Code language extension
https://github.com/discus-lang/salt-vscode
compiler functional ide language-extensions low-level vscode
Last synced: 2 months ago
JSON representation
Salt Visual Studio Code language extension
- Host: GitHub
- URL: https://github.com/discus-lang/salt-vscode
- Owner: discus-lang
- Created: 2018-12-30T07:59:21.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T09:21:32.000Z (about 2 years ago)
- Last Synced: 2024-03-26T18:37:18.169Z (10 months ago)
- Topics: compiler, functional, ide, language-extensions, low-level, vscode
- Language: TypeScript
- Homepage:
- Size: 1.27 MB
- Stars: 4
- Watchers: 6
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Salt Visual Studio Code Language Extension
Includes the syntax definition, as well as support for the [Language Server](https://langserver.org/) mode of the [`salt`](https://github.com/discus-lang/salt) executable. You'll need to build/install the [`salt`](https://github.com/discus-lang/salt) executable separately as well as this extension.
You may also want the [Salt Plain Visual Studio Code Theme](https://github.com/discus-lang/salt-theme). This theme knows a bit more about the Salt language syntax than the standard themes, but the standard ones work well enough if you just want to try it out.
## Development
Use VSCode for development of the extension itself. Load the code into a new workspace, select the `src/extension.ts` module and run the `Start Debugging (F5)` command in VSCode. This should open a new VSCode window with the current version of the extension running. After modifing some of the code, use the `Reload` command in the VSCode debug pane to reload the extension in the second window.
## Installation
Once you're happy with the changes, package the extension into a `.vsix` file ready to installed more permanently into VSCode. Use the following commands from the root of the extension source directory. The `vsce` package is the VSCode Extension management command line tool.
```
$ npm install vsce
$ node_modules/.bin/vsce package
$ code --install-extension ./salt-vscode-XX.XX.XX.vsix
```
## Configuration
The extension expects the `salt` executable to be in your path when you start VSCode. If you don't have 'salt' in your path, or want to use a development version, then set the desired path in the 'salt.server.executable' configuration setting in VSCode. You'll need to restart VSCode (and hence the extension) once you've changed this.
## Examples
These examples all use the [Salt Plain Visual Studio Code Theme](https://github.com/discus-lang/salt-theme).
Adding a the `watch` keyword to the front of a test causes the result to appear as an information message in the "Problems" panel.
Demonstration of error diagnostic reporting in the Salt test suite.
