GhostText protocol wishlist

fregante / GhostText

👻 Use your text editor to write in your browser. Everything you type in the editor will be instantly updated in the browser (and vice versa).

MIT License

3.25k stars 116 forks source link

Future

Just connect to WebSocket, no intermediary HTTP server

alternatively, just use EventSource and HTTP/2 instead of WebSocket

Add timestamp to messages in order to discard messages that are out of order

Send the full URL on connection so that the editor can use the filename and/or set the syntax

the text selection can be sent separately from the content

the editor should not send the syntax back

send editor description/title/label (via label, [title], [aria-label], etc) to be used as tab title

My suggestion?

Implement diff mode.

First connection

Browser sends editor the metadata (title, url, etc.) and the full text

Rest of the lifetime

Every time text changes in either browser or editor, it sends out a message that contains the line numbers from which the change starts, and the line number at which the change stops, and the whole text between those line numbers.

e.g.

Say, currently the text is -

Lorem Ipsum
Dolor Sit
Consectetur
Adipiscing Elit

The user changes the text to -

Lorem Ipsum
Dolor Stand
Consectetur
Adipiscing Elit

A message containing the following details is sent out -
```
start: 2
end: 2
Dolor Stand
```

The user changes the text to -

sing with me, sing for the year,
sing for the laughter and sing for the tear.
sing with me, just for today,
maybe tomorrow the good lord will take you away
dream on, dream on, dream on,
dream until your dreams come true
Lorem Ipsum
Adipiscing Elit

A message containing the following details is sent out -

start: 1
end: 3
sing with me, sing for the year,
sing for the laughter and sing for the tear.
sing with me, just for today
maybe tomorrow the good lord will take you away
dream on, dream on, dream on,
dream until your dreams come true
Lorem Ipsum

The user changes the text to -
```
Lorem Ipsum
Adipiscing Elit
```
A message containing the following details is sent out -
```
start: 1
end: 6
```
The user changes the text to -
```
Lorem Ipsum
```
A message containing the following details is sent out -
```
start: 2
end: 2
```

This way, GhostText can work on big files without needing to consume a ton of CPU.

Implement diff mode.

heh I was thinking about that earlier, but that complicates things a lot, because suddenly every message has to be delivered.

The other complication is that a diff algorithm, especially with multiple cursors, still doesn't come free (CPU), and has to be implemented by each editor plugin in different languages. One editor gets this wrong and people lose data and open issues here.

The only way I could do this would be with a standard, simple diffing algorithm available in multiple languages. This would avoid implementation errors and waste of dev time. I'd probably not implement this myself in any case due to the complexity, compared to just dynamic throttling (see the "updates" section in https://github.com/fregante/GhostText/issues/256)

Browser sends editor the metadata (title, url, etc.) and the full text

Totally agree, the current setup is awkward. PR welcome for that (including protocol.md). I suppose it would need to be sent via URL parameter though, which means it's limited in length (32k) and therefore it would need to be skipped when too long.

I'm happy to make changes that are backwards compatible, I already made a couple of improvements this week: https://github.com/fregante/GhostText/commits/main/PROTOCOL.md

fregante / GhostText