Shuhei KadowakiandMrSubidubi
c9f65764a1
Some language servers include local symbols (e.g., local variables, parameters) in workspace symbol results. Without the `containerName` information, these symbols lack context information, making it difficult to distinguish them from top-level definitions and hindering efficient symbol lookup. This change exposes the `container_name` field from LSP [`SymbolInformation`](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#symbolInformation) to the extension API, allowing language server extensions to access `symbol.container_name` in `label_for_symbol` and provide meaningful context when rendering symbol labels. Note: The `container_name `field is added to all extension API versions because they seem to share the same underlying Rust types via wasmtime bindgen. The field is optional, so existing extensions would remain compatible as far as I understand. Closes #ISSUE Release Notes: - Added `container_name` field to `lsp::Symbol`, accessible via the extension API's `label_for_symbol` function --------- Co-authored-by: MrSubidubi <finn@zed.dev>
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.6.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:
- Make sure you have Rust installed
- Have the
wasm32-wasip2target installed (rustup target add wasm32-wasip2) - 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.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 |