Crates.io | zed_extension_api |
lib.rs | zed_extension_api |
version | 0.0.6 |
source | src |
created_at | 2024-03-20 21:11:06.252462 |
updated_at | 2024-04-09 14:39:54.254132 |
description | APIs for creating Zed extensions in Rust |
homepage | |
repository | https://github.com/zed-industries/zed |
max_upload_size | |
id | 1180986 |
size | 41,629 |
This crate lets you write extensions for Zed in Rust.
You'll need an extension.toml
file at the root of your extension directory, with the following structure:
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"
Zed extensions are packaged as WebAssembly files. In your Cargo.toml, you'll
need to set your crate-type
accordingly:
[dependencies]
zed_extension_api = "0.0.6"
[lib]
crate-type = ["cdylib"]
To define your extension, create a type that implements the Extension
trait, and register it.
use zed_extension_api as zed;
struct MyExtension {
// ... state
}
impl zed::Extension for MyExtension {
// ...
}
zed::register_extension!(MyExtension);
To run your extension in Zed as you're developing it:
zed: extensions
action in the command palette.Install Dev Extension
button in the top rightExtensions 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.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 |