Files
openidea/crates/ide-plugin/tests/fixtures/hello/plugin.toml
1c5a92f952 feat(plugins): plugin system with extension points, consent, Wasm runtime and plugin API 1.0 (#971)
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>
2026-11-04 02:54:31 +08:00

53 lines
1.5 KiB
TOML

id = "hello"
name = "Hello"
version = "0.3.0"
description = "Sample plugin: inserts today's date, counts words in the active file and shows a tool window with a tree."
authors = ["OpenIDEA contributors"]
change-notes = """
0.3.0 — a Greetings tool window (tree view), an editor context menu entry, a shortcut and a status bar item.
0.2.0 — plugin API 0.2: edits are versioned, one undo step for every cursor.
0.1.0 — first release: Insert Date and Word Count of Active File commands.
"""
engines.openidea = "^1.0"
wasm = "dist/plugin.wasm"
# Loaded the first time one of its commands runs.
activation = ["on-command:*", "on-view:greetings"]
[capabilities]
required = ["editor.read", "editor.write"]
# Static declarations make the commands visible before the plugin activates;
# a command must be declared here to exist.
[[contributes.commands]]
id = "insert-date"
title = "Hello: Insert Date"
category = "Hello"
[[contributes.commands]]
id = "word-count"
title = "Hello: Word Count of Active File"
category = "Hello"
# Declarative UI: shown without loading the plugin's code.
[[contributes.menus]]
menu = "editor.context"
command = "word-count"
[[contributes.keymaps]]
command = "insert-date"
key = "Ctrl+Alt+D"
mac = "Meta+Alt+D"
[[contributes.statusBar]]
id = "hello"
text = "Hello"
tooltip = "Word count of the active file"
command = "word-count"
# A tool window whose tree the plugin renders (view-provider).
[[contributes.views]]
id = "greetings"
title = "Greetings"
icon = "plugin"
location = "right"