mirror of
https://github.com/l0ng-ai/openidea.git
synced 2026-11-06 16:08:05 +00:00
1c5a92f952
A plugin system built on WebAssembly components (wasmtime, WASI p2), with a typed WIT API (`openidea:plugin@1.0.0`) and a Rust SDK, shipped as a preview. - Extension points declared in `plugin.toml` (commands, languages, themes, icon themes, menus, key bindings, status items, settings, views, custom editors, file icons and templates, run detectors, editor providers), validated before anything takes effect and projected onto the workbench's own registries: plugin themes and file icon themes are chosen in Settings › Appearance and Quick Switch, plugin shortcuts are edited in Settings › Keymap, plugin problems are grouped in Settings › Inspections. - Capabilities with risk levels and consent at install, pinned `process:` programs, secrets in the OS keychain. - Runtime: one thread per active plugin, fuel/time/memory budgets, soft and hard deadlines on the editing path, cancellation, crash backoff, idle reclaim, a precompiled-component cache; remote projects run code plugins on `openidea-server`. - Web views and custom editors with a sandboxed page, a document bridge joined to the text editor's undo history, and split or preview layouts. - Distribution: signed `.oiplugin` packages, a static marketplace index with revocation, versioned installs with rollback, install from a `.zip` or a folder. The release workflow signs and publishes the official plugins and their index, which released builds use as the default marketplace. - Official plugins: String Tools, Key Promoter, Git Toolbox, AI Completion, Checkstyle, MyBatis Navigator, CSV Editor, Solidity, Material Icons, Harbor Night, Excalidraw, Graphviz, Regex Tester, License Header. Closes #732 Co-authored-by: Deng Liu <5108773+dengliu@users.noreply.github.com> Co-authored-by: florentvdry <16673235+florentvdry@users.noreply.github.com>
70 lines
2.4 KiB
Plaintext
70 lines
2.4 KiB
Plaintext
package openidea:plugin@1.0.0;
|
|
|
|
/// Editor features a plugin provides for the languages it declares under
|
|
/// `[[contributes.providers]]` (the host calls only declared kinds). They run
|
|
/// on the editing path: a result later than ~50 ms is dropped, a call still
|
|
/// running at 500 ms is interrupted.
|
|
interface providers {
|
|
use types.{position, range, text-edit, location};
|
|
|
|
/// The document a request is about.
|
|
record document {
|
|
path: string,
|
|
language: string,
|
|
version: u64,
|
|
text: string,
|
|
}
|
|
|
|
record completion-item {
|
|
label: string,
|
|
detail: option<string>,
|
|
/// Icon and sort group: text, method, function, constructor, field,
|
|
/// variable, class, interface, module, property, unit, value, enum,
|
|
/// keyword, snippet, color, file, reference, folder, enum-member,
|
|
/// constant, struct, event, operator or type-parameter. Unknown kinds
|
|
/// show no icon.
|
|
kind: option<string>,
|
|
insert-text: string,
|
|
/// Replaced on accept; `none`: the word at the caret.
|
|
replace: option<range>,
|
|
sort-text: option<string>,
|
|
documentation: option<string>,
|
|
}
|
|
|
|
record inline-suggestion {
|
|
insert-text: string,
|
|
/// Replaced range; `none` inserts at the caret.
|
|
replace: option<range>,
|
|
}
|
|
|
|
record file-edit {
|
|
path: string,
|
|
edits: list<text-edit>,
|
|
}
|
|
|
|
record code-action {
|
|
title: string,
|
|
/// `quickfix`, `refactor`, …
|
|
kind: option<string>,
|
|
preferred: bool,
|
|
edits: list<file-edit>,
|
|
}
|
|
|
|
record line-marker {
|
|
line: u32,
|
|
/// Gutter icon: `navigate` (default), `implemented`, `implementing`, `run`.
|
|
icon: option<string>,
|
|
tooltip: string,
|
|
/// Opened on click.
|
|
target: option<location>,
|
|
}
|
|
|
|
completion: func(doc: document, at: position, trigger: option<string>) -> list<completion-item>;
|
|
/// Ghost text at the caret (typing replaces an older request: it is cancelled).
|
|
inline-completion: func(doc: document, at: position) -> option<inline-suggestion>;
|
|
/// Actions for `selection` (quick fixes for the plugin's own diagnostics).
|
|
code-actions: func(doc: document, selection: range) -> list<code-action>;
|
|
definition: func(doc: document, at: position) -> list<location>;
|
|
line-markers: func(doc: document) -> list<line-marker>;
|
|
}
|