b72a46db68
Some checks failed
Update All Top Ranking Issues / update_top_ranking_issues (push) Has been cancelled
Triage Project Sync (#84) / Sync triage project (push) Has been cancelled
release_nightly / notify_on_failure (push) Has been cancelled
release_nightly / check_style (push) Has been cancelled
release_nightly / run_tests_windows (push) Has been cancelled
release_nightly / clippy_windows (push) Has been cancelled
release_nightly / bundle_linux_aarch64 (push) Has been cancelled
release_nightly / bundle_linux_x86_64 (push) Has been cancelled
release_nightly / bundle_mac_aarch64 (push) Has been cancelled
release_nightly / bundle_mac_x86_64 (push) Has been cancelled
release_nightly / bundle_windows_aarch64 (push) Has been cancelled
release_nightly / bundle_windows_x86_64 (push) Has been cancelled
release_nightly / build_nix_linux_x86_64 (push) Has been cancelled
release_nightly / build_nix_mac_aarch64 (push) Has been cancelled
release_nightly / update_nightly_tag (push) Has been cancelled
Hotfix Review Monitor / check-hotfix-reviews (push) Has been cancelled
Stale PR Review Reminder / check-stale-prs (push) Has been cancelled
Update Weekly Top Ranking Issues / update_top_ranking_issues (push) Has been cancelled
Bump collab-staging Tag / update-collab-staging-tag (push) Has been cancelled
compliance_check / scheduled_compliance_check (push) Has been cancelled
Single-commit orphan branch: full zed-industries/zed @ 8c74db0 source tree with a 3-file patch applied (no upstream history). Patch (crates/gpui_linux/src/linux/wayland/): - serial.rs: add SerialKind::KeyboardEnter - client.rs: store wl_keyboard.enter serial; add latest_serial_of() - window.rs: activate() uses keyboard-enter serial (Mutter focus gate) Mutter honors window activation only when the token carries the keyboard- focus serial from wl_keyboard.enter; GPUI used a stale mouse-press serial. See docs/tray-window-focus-wayland.md in logiguard. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
78 lines
2.1 KiB
Markdown
78 lines
2.1 KiB
Markdown
# The Zed Rust Extension API
|
|
|
|
This crate lets you write extensions for Zed in Rust.
|
|
|
|
## Extension Manifest
|
|
|
|
You'll need an `extension.toml` file at the root of your extension directory, with the following structure:
|
|
|
|
```toml
|
|
id = "my-extension"
|
|
name = "My Extension"
|
|
description = "..."
|
|
version = "0.0.1"
|
|
schema_version = 1
|
|
authors = ["Your Name <you@example.com>"]
|
|
repository = "https://github.com/your/extension-repository"
|
|
```
|
|
|
|
## Cargo metadata
|
|
|
|
Zed extensions are packaged as WebAssembly files. In your Cargo.toml, you'll
|
|
need to set your `crate-type` accordingly:
|
|
|
|
```toml
|
|
[dependencies]
|
|
zed_extension_api = "0.6.0"
|
|
|
|
[lib]
|
|
crate-type = ["cdylib"]
|
|
```
|
|
|
|
## Implementing an Extension
|
|
|
|
To define your extension, create a type that implements the `Extension` trait, and register it.
|
|
|
|
```rust
|
|
use zed_extension_api as zed;
|
|
|
|
struct MyExtension {
|
|
// ... state
|
|
}
|
|
|
|
impl zed::Extension for MyExtension {
|
|
// ...
|
|
}
|
|
|
|
zed::register_extension!(MyExtension);
|
|
```
|
|
|
|
## Testing your extension
|
|
|
|
To run your extension in Zed as you're developing it:
|
|
|
|
- Make sure you have [Rust installed](https://www.rust-lang.org/learn/get-started)
|
|
- Have the `wasm32-wasip2` target installed (`rustup target add wasm32-wasip2`)
|
|
- Open the extensions view using the `zed: extensions` action in the command palette.
|
|
- Click the `Install Dev Extension` button in the top right
|
|
- Choose the path to your extension directory.
|
|
|
|
## Compatible Zed versions
|
|
|
|
Extensions created using newer versions of the Zed extension API won't be compatible with older versions of Zed.
|
|
|
|
Here is the compatibility of the `zed_extension_api` with versions of Zed:
|
|
|
|
| Zed version | `zed_extension_api` version |
|
|
| ----------- | --------------------------- |
|
|
| `0.192.x` | `0.0.1` - `0.6.0` |
|
|
| `0.186.x` | `0.0.1` - `0.5.0` |
|
|
| `0.184.x` | `0.0.1` - `0.4.0` |
|
|
| `0.178.x` | `0.0.1` - `0.3.0` |
|
|
| `0.162.x` | `0.0.1` - `0.2.0` |
|
|
| `0.149.x` | `0.0.1` - `0.1.0` |
|
|
| `0.131.x` | `0.0.1` - `0.0.6` |
|
|
| `0.130.x` | `0.0.1` - `0.0.5` |
|
|
| `0.129.x` | `0.0.1` - `0.0.4` |
|
|
| `0.128.x` | `0.0.1` |
|