JustSync VS Code Adapter

JustSync VsCode Adapter is the official Visual Studio Code extension for JustSync, a secure P2P collaboration tool. This extension acts as a client adapter, connecting your editor directly to the JustSync core binary to enable real-time collaboration and cursor synchronization.

Features

• P2P Secure Collaboration: Connect directly with peers without central storage of your code.
• Host & Join Sessions: Easily start a hosting session or join an existing one via IP and Token.
• Real-time Cursor Synchronization: See where your peers are working with visual cursor indicators.
• Zero-Config Handshake: Uses a secure token exchange for authenticating peers.

Requirements

This extension requires the JustSync core binary to be installed and available on your system.

1. Download or build the JustSync binary.
2. Ensure the binary is named JustSync (or JustSync.exe on Windows).
3. Add the location of the binary to your system's PATH environment variable so the extension can spawn the process.

Usage

1. Start Session:
   • Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P).
   • Run JustSync: Start/Stop Session.
   • Select Host Session to generate a token, or Join Session to connect to a host.
2. Stop Session:
   • Click the JustSync status bar item (bottom right) or run the toggle command again.

Development & Build Instructions

Automatic (VsCode Marketplace)

You can just install the extension through vscode's marketplace, under the same name ("JustSync"), and the publisher ("FabianHoller").

Manual

Alternatively, you can build this extension from source.

This project is a TypeScript extension that wraps the JustSync Language Server Protocol (LSP) interface.

Prerequisites

• Node.js (v16+)
• npm

Build Scripts

The package.json includes several helper scripts for the build lifecycle:

• Compile Source: Transpile TypeScript to JavaScript.

  npm run compile
  

• Watch Mode: Automatically recompile on file changes (useful during development).

  npm run watch
  

• Package Extension: Create a .vsix file for distribution.

  npm run package
  # or
  npm run bundle-vs
  

• Install Locally: Package and immediately install the extension into your VS Code instance.

  npm run install-vs
  

Manual Installation

To install the extension from source without publishing:

1. Run npm install to setup dependencies.
2. Run npm run bundle-vs to generate the .vsix package.
3. In VS Code, go to Extensions -> ... (Menu) -> Install from VSIX... and select the generated file.

OR

3. Run npm run install-vs to install to vscode directly.

Please note: You'll need to have the 'code' command working for vscode, for this to work.

License

This project is licensed under the MIT License.

Note: This extension is an adapter. All core logic, encryption, and networking are handled by the JustSync binary.