mirror of
https://github.com/zed-industries/zed.git
synced 2024-12-28 20:01:33 +00:00
f92e6e9a95
This PR adds support for context servers provided by extensions.
To provide a context server from an extension, you need to list the
context servers in your `extension.toml`:
```toml
[context_servers.my-context-server]
```
And then implement the `context_server_command` method to return the
command that will be used to start the context server:
```rs
use zed_extension_api::{self as zed, Command, ContextServerId, Result};
struct ExampleContextServerExtension;
impl zed::Extension for ExampleContextServerExtension {
fn new() -> Self {
ExampleContextServerExtension
}
fn context_server_command(&mut self, _context_server_id: &ContextServerId) -> Result<Command> {
Ok(Command {
command: "node".to_string(),
args: vec!["/path/to/example-context-server/index.js".to_string()],
env: Vec::new(),
})
}
}
zed::register_extension!(ExampleContextServerExtension);
```
Release Notes:
- N/A
|
||
|---|---|---|
| .. | ||
| src | ||
| wit | ||
| build.rs | ||
| Cargo.toml | ||
| LICENSE-APACHE | ||
| PENDING_CHANGES.md | ||
| README.md | ||
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:
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:
[dependencies]
zed_extension_api = "0.1.0"
[lib]
crate-type = ["cdylib"]
Implementing an Extension
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);
Testing your extension
To run your extension in Zed as you're developing it:
- Open the extensions view using the
zed: extensionsaction in the command palette. - Click the
Install Dev Extensionbutton 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.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 |