websocket-text-relay-vscode

websocket-text-relay-vscode is a vscode extension designed to enhance your live coding experience by leveraging the power of WebSockets and the Language Server Protocol (LSP). This tool watches for changes to your files and seamlessly relays these updates to the frontend client. With websocket-text-relay-vscode, you can see your code changes reflected live, without the need to save or refresh your browser.

This repo contains just the vscode client. The server implementation can be found in the websocket-text-relay repo

Install Extension

Search for "niels4" in the vscode extension marketplace or checkout the repo and generate the vsix file yourself using vsce

Usage

Verify the plugin is working by viewing the status UI hosted at http://localhost:38378

After installation, continue with step 2 in the websocket-text-relay README to connect your editor to a front end client and see your updates rendered as you type.

Disable / Enable / Toggle WebSocket Text Relay

Command: websocketTextRelay.<disable | enable | toggle>

Description: Disables / Enables / Toggles the WebSocket text relay functionality.

1. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P).
2. Search for Websocket Text Relay: <Disable | Enable | Toggle>.
3. Press Enter.

Keybindings

For quicker access, you can add custom keybindings for these commands. Here is an example of how to set up keybindings in your keybindings.json file:

[
  {
    "key": "ctrl+alt+w",
    "command": "websocketTextRelay.toggle",
    "when": "editorTextFocus"
  }
]

settings

enabled

This extension is enabled by default. You can disable text updates by setting websocketTextRelay.enabled setting to false.

allowNetworkAccess

By default, the http and websocket server will only accept incoming connections from your local machine. If you wish to allow network access you must set the websocketTextRelay.allowNetworkAccess setting to true.

allowedHosts

By default, the http and websocket server will only accept connections where the hostname is localhost. If you wish to allow other hosts to connect to the websocket server, you must explicitly allow them using the websocketTextRelay.allowedHosts setting.

developer

You can override the command used to start the language server using the websocketTextRelay.developer.serverCommand and websocketTextRelay.developer.serverCommandArgs settings. This is useful for local development and debugging the application using the chrome debugger. See the developer's guide for more information.

License

websocket-text-relay-vscode is released under the MIT License.