mattn / mattn/vim-filewatcher

update api to match existing vim apis.

Open
#2 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
22
Forks
1
PR merge metrics
No merged PRs in 30d

Description

Would it be possible to update the api to use ids instead of object oriented style so it matches with vim? Would be awesome if you proposed the api at https://groups.google.com/d/msg/vim_dev/oubHkRbdQW0/TZYUUQftAgAJ

let watch_id= filewatcher#watch(".", {x,y->execute('echo y',0)})
call filewatch#stop_watch(watch_id)
let watch_status = filewatch#status(watch_id)

Since watch_id is a number I can serialize and deserialize this across jobs or a neovim remote plugin.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the current API exposed by vim-filewatcher and compare it with the Vim API proposal linked in the issue. Determine the scope of replacing object-oriented usage with serializable numeric watch IDs; done means watch, stop, and status follow the proposed interface and work across jobs or remote plugins.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, vim
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.