Arnaud Ritti
1446d5592c
Closes #1952 API 1.3 adds a diagnostics provider for unsaved documents: the host sends versioned text for the declared languages after a 300 ms debounce, cancels superseded calls, drops late or stale answers under the editor-provider budget, and clears results with the document, project or plugin. Ranges are UTF-16. Actor panics are contained, queued work is rejected after a host panic, and diagnostics arriving after plugin cleanup are discarded. Verified on macOS with the diagnostics fixture. 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 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.