alemi
413247f9b4
also keep a branch on which we merge editor's changes, which kind of solves our race condition thing Co-authored-by: cschen <cschen@codemp.dev> |
||
|---|---|---|
| .github/workflows | ||
| dist | ||
| src | ||
| .editorconfig | ||
| .gitignore | ||
| .rustfmt.toml | ||
| build.rs | ||
| Cargo.toml | ||
| LICENSE | ||
| README.md | ||
codemp
This project is heavily inspired by Microsoft Live Share plugin for Visual Studio (Code). While the functionality is incredibly good, I often find issues or glitches which slow me down, and being locked to only use Visual Studio products is limiting. I decided to write my own solution, and to make it open source, so that any editor can integrate it with a plugin.
Documentation
build the crate documentation with cargo doc and access the codemp page with the html redirect docs.html
Design
Client/Server
While initially a P2P system seemed interesting, I don't think it would easily scale with many users (due to having to integrate many changes on each client). I decided to build a client/server architecture, with a central "Workspace" managed by the server application and multiple clients connecting to it. Each client will only have to care about keeping itself in sync with the server (remembering local-only changes and acknowledged changes), leaving the task of keeping track of differences to the server.
Plugins
This software will probably be distribuited as a standalone binary that editors can use to connect to a "Workspace". A dynamic library object might also be a choice. Each editor plugin must be responsible of mapping codemp functionality to actual editor capabilities, bridging codemp client to the editor itself. The client should be able to handle a session autonomously.
Text Synchronization
A non destructive way to sync changes across clients is necessary. I initially explored CRDTs, but implementation seemed complex with little extra benefits from "more traditional" approaches (Operational Transforms). This has to be investigated more.