verstak
/
verstak-desktop
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: document live file watcher

This commit is contained in:
mirivlad 2026-06-28 23:00:32 +08:00
parent 1d521251a2
commit aa4905a097
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/PLUGIN_RUNTIME.md
View File

@ -427,6 +427,10 @@ contributions summary.
- Handler получает envelope `{ name, pluginId, payload, timestamp }`. - Handler получает envelope `{ name, pluginId, payload, timestamp }`.
- Subscriptions очищаются при component unmount, reload/disable flow и - Subscriptions очищаются при component unmount, reload/disable flow и
`api.dispose()`. `api.dispose()`.
- Core publishes `file.changed` for Files API mutations and live vault watcher
changes. Watcher payloads use `operation: "external.create"`,
`"external.update"`, or `"external.delete"`, include vault-relative `path`,
`type`, `workspaceRootPath`, and `external: true`.
`files` `files`
@ -461,8 +465,11 @@ contributions summary.
`files.list` through a symlink directory and all read/write/move/trash `files.list` through a symlink directory and all read/write/move/trash
operations through symlinks are forbidden in Milestone 6a. operations through symlinks are forbidden in Milestone 6a.
- Files API is text-only for read/write in Milestone 6a. `readText` is limited - Files API is text-only for read/write in Milestone 6a. `readText` is limited
to UTF-8 regular files up to 2 MB. Binary streaming and watcher support are to UTF-8 regular files up to 2 MB. Binary streaming is deferred.
deferred. - Live watcher refresh is active while Verstak is running and a vault is open.
It performs an initial no-event snapshot, then publishes `file.changed` for
external creates, updates, and deletes outside `.verstak/`. It does not keep a
persistent snapshot or report what changed while Verstak was closed.
`dispose` `dispose`