mirror of
https://github.com/l0ng-ai/openidea.git
synced 2026-11-06 16:08:05 +00:00
l0ng-ai
7c71cf8b6a
Released 1.x types never change, so the sets and records that will have to grow are opened up before the API is frozen: - Event kinds and action sources are strings; `event`, view `body`, `view-event` and `field-value` get an `other(extension)` case (a kind and JSON data) that carries later cases to older plugins and IDEs. An IDE refuses an event kind it doesn't know, says a view body needs a newer IDE, and leaves out unknown form fields. - Completion items can be snippets, match on `filter-text` and bring `additional-edits` (imports). Code actions can carry `data` instead of edits; the new `resolve-code-action` export computes them when the user picks the action, under the command budget, through the existing resolve path. - Diagnostics name their `source`, carry `tags` (`unnecessary`, `deprecated`) and `related` locations. - The SDK's enums are `#[non_exhaustive]` with `Other` variants; `Diagnostic::new`, `Providers::resolve_code_action`. - README: 1.x calls stay synchronous and pass documents whole; async and incremental sync come later behind the host adapter or a new interface. Official plugins and fixtures rebuilt.
82 lines
3.1 KiB
Plaintext
82 lines
3.1 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.{error, 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>,
|
|
/// With `snippet`, tab stops and placeholders (`$1`, `${1:name}`, `$0`).
|
|
insert-text: string,
|
|
snippet: bool,
|
|
/// Replaced on accept; `none`: the word at the caret.
|
|
replace: option<range>,
|
|
sort-text: option<string>,
|
|
/// Matched against what was typed instead of `label`.
|
|
filter-text: option<string>,
|
|
documentation: option<string>,
|
|
/// Applied with the item elsewhere in the document (an import).
|
|
additional-edits: list<text-edit>,
|
|
}
|
|
|
|
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>,
|
|
/// The plugin's own reference: with it and no `edits`, the edits are
|
|
/// computed by `resolve-code-action` once the user picks the action.
|
|
data: option<string>,
|
|
}
|
|
|
|
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>;
|
|
/// The edits of an action `code-actions` returned with `data`, when the
|
|
/// user picks it (the command budget applies, not the editor's 50 ms).
|
|
resolve-code-action: func(doc: document, action: code-action) -> result<code-action, error>;
|
|
definition: func(doc: document, at: position) -> list<location>;
|
|
line-markers: func(doc: document) -> list<line-marker>;
|
|
}
|