Arnaud Ritti
63065bab64
Closes #1948 Plugins receive debounced batches of files created, changed and removed outside the editor in open projects, as SDK `Event::FilesChanged` (delivered through `other("files-changed", …)`, so released WIT is unchanged), under the `events` capability and the plugin's path filters. Activation on these events requires API 1.3. Batches are coalesced per plugin through its actor, survive cancellation without losing deltas, and are dropped when the project or host shuts down. Co-authored-by: arnaud-ritti <[email protected]>
Rust plugin SDK
The Rust API is documented by cargo doc. Web pages shipped alongside a Rust
component use window.openidea rather than Rust imports.
API 1.3 adds Event::FilesChanged(FilesChanged) for debounced external file
creation, modification and removal in open projects. Declare
engines.openidea = "^1.3", the events capability and
activation = ["on-event:files-changed"], then handle the typed event in
Plugin::handle_events. Use host::subscribe_paths("files-changed", &["config/**"])
to receive only matching project-relative paths in each category. An empty
filter pauses delivery. Paths are absolute, like Event::FileSaved; pending
batches are discarded when their project closes. The released WIT variant
is unchanged: the SDK decodes event::other with kind files-changed.
See the event contract and the real Wasm fixture.
API 1.3 adds capability-gated interactive PTYs to that web bridge. Declare
engines.openidea = "^1.3" and process:<program> in plugin.toml, then send
pty-spawn, pty-input, pty-resize and pty-kill JSON strings using
openidea.postMessage. Consume pty-data and acknowledge its sequence using
pty-ack; handle pty-exit and pty-error through openidea.onMessage.
See the protocol, permission and resource limits and the minimal fixture. The frame cannot access IPC directly. Its sessions belong to that frame and end with its view or plugin. There is no new WIT import for this API.
API 1.3 also adds diagnostics for unsaved documents. Declare
kinds = ["diagnostics"] and the supported languages under
[[contributes.providers]], implement
openidea_plugin::diagnostics::DiagnosticsProvider, and export it with
register_plugin!(MyPlugin, diagnostics). The host supplies versioned text
after a 300 ms debounce, cancels superseded calls, and drops stale answers
under the editor-provider budget. Ranges use 0-based UTF-16 positions.
The provider declaration supplies the document; host imports retain their
usual capability checks. Provider results coexist with manually published
diagnostics and are cleared with the document, project or plugin. Native
tests can call MockHost::refresh_diagnostics and inspect
MockHost::provider_diagnostics.
See the diagnostics contract and limits and the real Wasm fixture.
API 1.3 also adds open-log-tab to the web bridge: a generic read-only editor
tab streams output from a granted process, with plugin-defined argument toggles.
It uses the same backend authorization and bounded PTY transport. See the
protocol and lifecycle
and the built fixture.