https://github.com/hediet/vscode-rpc

Provides an RPC interface to automate VSCode from other processes
https://github.com/hediet/vscode-rpc

Last synced: about 2 months ago
JSON representation

Provides an RPC interface to automate VSCode from other processes

• Host: GitHub
• URL: https://github.com/hediet/vscode-rpc
• Owner: hediet
• Created: 2019-01-30T03:10:31.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-05-29T03:10:46.000Z (over 3 years ago)
• Last Synced: 2024-06-03T00:36:00.398Z (4 months ago)
• Language: TypeScript
• Homepage:
• Size: 686 KB
• Stars: 11
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# VS Code RPC

This repository contains an RPC Server for VS Code (implemented as extension) and a NodeJS client implementation.

## Scenarios

See [contracts.ts](vscode-rpc/src/contracts.ts) for the RPC contract definitions.

### Registrar

To support controlling multiple Vs Code instances, there is a registrar-server process that is connected to all VS Code instances and to all clients.

This server broadcasts notifications from clients to VsCode instances and vice versa and listens on a fixed port.

Each VS Code instance has a connection to the registrar server and hosts its own server on a random port.

The registrar server can be asked to get a list of all available Vs Code instances and their server ports.

The registrar server is also responsible for authenticating clients.

The first Vs Code instance spawns the registrar and the registrar exits with the disconnect of the last Vs Code client as shown in the folling sequence diagram:

![Registrar Startup](docs/exported/main/RegistrarStartup.png)

### VS Code Instances

After ensuring that the registrar has started, each VS Code instance authenticates to the registrar server:

![VsCode Authentication](docs/exported/main/VsCodeAuthentication.png)

### Tokens

Authentication is implemented using tokens. Tokens are managed by the registrar.

Prior to issueing a new token, the registrar asks all VS Code instances to grant or deny the token request:

![Token Request](docs/exported/main/ClientRequestsToken.png)

### Client Authentication

Clients must authenticate to the registrar before send any requests or notifications:

![Client Authenticates to Registrar](docs/exported/main/ClientAuthenticatesToRegistrar.png)

If clients connect to a VS Code instance directly, they also have to authenticate:

![Client Authenticates to VSCode](docs/exported/main/ClientAuthenticatesToVSCode.png)