Arnaud Ritti
99102d8a40
Related #1947 Uninstall keeps a plugin registered but stopped until its private data, secrets and package are cleaned up; a failure is shown and Uninstall can be retried, also after a restart (a durable cleanup record outside the package restores the target). While cleanup is pending, enable, reload, consent, permission changes, reinstall, replacement and rollback are refused. Secret-deletion errors are reported, and cleanup never follows a symlinked ancestor outside plugin storage. The SDK mock checks private-path components and rejects traversal independently of filesystem grants. 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 answers Find Usages and Rename from DocumentIndexer definitions
and references. Existing indexers work without another export; declare
engines.openidea = "^1.3" when requiring these host features. Each anchor must
cover exactly the name, using UTF-16 columns. The host merges native results,
previews indexed renames and applies them as one undoable workspace edit.
The existing project.read capability and trusted-project boundary apply.
See the indexing contract
and the minimal fixture.
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.
API 1.3 also adds open-content-tab to the web bridge: a plugin-backed editor
tab with custom toolbar actions (content-tab-action / content-tab-reply),
native diff viewer integration, and full EditorDocumentLifecycle support. See
the protocol and lifecycle
and the built fixture.