https://github.com/gbaranski/eb

Experimental backend for collaborative code editors following a client server architecture. 🚧
https://github.com/gbaranski/eb

editor hacktoberfest rust

Last synced: 3 months ago
JSON representation

Experimental backend for collaborative code editors following a client server architecture. 🚧

• Host: GitHub
• URL: https://github.com/gbaranski/eb
• Owner: gbaranski
• Created: 2021-09-25T21:00:12.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-02-23T14:19:41.000Z (almost 3 years ago)
• Last Synced: 2023-03-10T05:06:49.455Z (almost 2 years ago)
• Topics: editor, hacktoberfest, rust
• Language: Rust
• Homepage:
• Size: 480 KB
• Stars: 9
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  eb - Editor Backend



Experimental backend for code editors following a client server architecture.


- [Architecture](#architecture)

- [Project status](#project-status)

- [Problem](#problem)

- [Q&A](#qa)

    - [Why not Vim over SSH/Mosh?](#why-not-vim-over-sshmosh)

    - [What's different from Kakoune server?](#whats-different-from-kakoune-server)

    - [Why not `xi-editor`?](#why-not-xi-editor)

# Architecture

![Architecture](docs/architecture.png)

# Project status

I'm trying to develop a working proof-of-concept.

# Problem

No separation of client/server in current editors.

Separating editors to client and a server has few advanteges: 

1. Server can be started on a beefy machine while running frontend on a small and slow laptop, without slowing down your development experience or consuming battery.

2. Easy collaborative programming.

3. Easier to create a new frontend which can use native GUI toolkits such as GTK and Cocoa, or a frontend which will be have Vim-like editing. Without need of implementing LSP communication or filesystem operations. 

4. Long-running sessions. You can run the server in background, while having editor closed, that'd greatly improve it's startup time. 

5. Frontend can be implemented on almost any platform, it could be made for Web and work similarly to Github Codespaces.

# Protocol

JSON-RPC is used for communication between frontend and backend.

Check [protocol.md](docs/protocol.md) for more information

# Q&A

### Why not Vim over SSH/Mosh?

I've been doing this for a long time, this works, but it has few cons:

- Quite high input latency.

- Mosh doesn't support true color, unless we use `master` branch which isn't available on Termux.

- No native feeling. Not a big issue on Laptop/PC, but on mobile it is hard to use.

### What's different from Kakoune server?

[Kakoune](https://github.com/mawww/kakoune) makes server used only by the kakoune frontend. `eb` wants to be something that can be used by many editors such as VSCode. Similarly how Microsoft came up with LSP which is now used by most of the editors right now. 

### Why not `xi-editor`?

`xi-editor` is dead, but I'd like to take some inspiration from it's design.