keyweeusr / emacs-syncthing

Emacs client for Syncthing

emacs-syncthing

Emacs client for Syncthing. Currently it tries to port all viewing functionality, later on even with editing/writing.

How to

Install it from Melpa or clone and install manually, then simply M-x syncthing.

Note that if you have debug-on-error enabled on your first run, the customize buffer for setting up the API token might be somewhere in the background. Use M-x customize-group syncthing for setting it manually, then re-run.

Key bindings

Ensure you are in the Syncthing buffer: C-hm or ? for all bindings.

Customization

Check the manual for Emacs Customization: C-hi mEmacsmCustomization and group M-x customize-group syncthing.

Screenshots

emacs-syncthing's Issues

Rethink debug logging

The current method of adding debugging logging to every function call is fragile and doesn't scale well.
Firstly, it requires that you add the debugging code to every function (so far 55 instances, ~200 LOC), which significantly adds to the code base. Secondly, it requires that each instance remain in sync with the function's signature.

A better approach would pick spots where logging would be most effective and log from there.
e.g. lower-level functions which other functions build off of (syncthing-request, for example).
The kind of granularity the current logging attempts is better served by stepping through the code with a debugger.

Icons don't show

on Windows 10
GNU Emacs 29.1 (build 2, x86_64-w64-mingw32) of 2024-01-02

problem getting started

I'm having some probems getting started.
I customized the server token, but the syncthing buffer is just empty.

Interested in collaborating?

I have some ideas for how this package could be rewritten to be more flexible and performant. As it stands, the package would need to be mostly re-written to achieve these goals. Do you have any interest in working on a re-write together?