mirror of
https://github.com/l0ng-ai/openidea.git
synced 2026-11-08 08:52:12 +00:00
Arnaud Ritti
1891119f9d
Adds API 1.3 `events.subscribe-paths(kind, globs)` for `file-opened` and `file-saved`: project-relative globs checked before an event is queued or wakes an idle plugin, and again before a queued event is delivered. A new filter replaces the old one atomically; `subscribe` restores unfiltered delivery; filters survive idle reclamation. Also `workspace.project-of(path)`, the most specific open project containing a document (reading it still needs `project.read`). Closes #1958. Co-authored-by: arnaud-ritti <[email protected]>
59 lines
2.4 KiB
Plaintext
59 lines
2.4 KiB
Plaintext
package openidea:[email protected];
|
|
|
|
/// Workbench events, delivered in batches to `event-handler.handle`.
|
|
interface events {
|
|
use types.{error, extension};
|
|
|
|
record action-performed {
|
|
/// Action id (`editor.duplicate-line`).
|
|
action: string,
|
|
title: string,
|
|
/// How the user started it: `keyboard`, `menu`, `toolbar`,
|
|
/// `context-menu`, `search` or `other` (more may be added).
|
|
source: string,
|
|
/// Its keyboard shortcut, when it has one (`Ctrl+D`).
|
|
shortcut: option<string>,
|
|
}
|
|
|
|
variant event {
|
|
file-opened(string),
|
|
file-saved(string),
|
|
editor-focused(option<string>),
|
|
action-performed(action-performed),
|
|
vcs-changed(string),
|
|
scheduled,
|
|
/// A kind added after 1.0 (subscribed to by its name).
|
|
other(extension),
|
|
}
|
|
|
|
/// Delivers `kind` events from now on, for the rest of the session (also
|
|
/// across idle reclaim: an event activates the plugin again). Declare
|
|
/// `activation = ["on-event:<kind>"]` to get them before first use.
|
|
/// Kinds: `file-opened`, `file-saved`, `editor-focused` (the focused editor
|
|
/// changed), `vcs-changed` (a repository's state changed: commit,
|
|
/// checkout, fetch…), `action-performed` (an IDE action ran) and
|
|
/// `scheduled` (the `on-schedule` period elapsed); later IDEs add more,
|
|
/// and an IDE that doesn't know one fails with `invalid`.
|
|
/// Requires `events` (`events.input` for `action-performed`).
|
|
subscribe: func(kind: string) -> result<_, error>;
|
|
/// Replaces this kind's subscription with project-relative globs (OR).
|
|
/// Empty globs pause delivery; `subscribe` restores unfiltered delivery.
|
|
/// Kinds: file-opened, file-saved. Requires `events`.
|
|
subscribe-paths: func(kind: string, globs: list<string>) -> result<_, error>;
|
|
unsubscribe: func(kind: string);
|
|
}
|
|
|
|
/// Long-running work with a progress indicator. While a task is open, the
|
|
/// call that began it may run for the background budget (60 s) instead of 5 s.
|
|
interface tasks {
|
|
resource task {
|
|
/// `done` of `total` units (`none`: indeterminate), with a short status.
|
|
report: func(done: u32, total: option<u32>, message: option<string>);
|
|
/// The user cancelled it: stop soon and return.
|
|
is-cancelled: func() -> bool;
|
|
}
|
|
|
|
/// Starts a task shown in the status bar; dropping it ends it.
|
|
begin: func(title: string, cancellable: bool) -> task;
|
|
}
|