mirror of
https://github.com/zed-industries/zed.git
synced 2026-05-26 15:44:20 +00:00
c4d75ea6d5
### Background
Zed extensions use WASI to access the file-system. They only have
read-write access to one specific folder called their work dir. But
extensions do need to be able to *refer* to other arbitrary files on the
user's machine. For instance, extensions need to be able to look up
existing binaries on the user's `PATH`, and request that Zed invoke them
as language servers. Similarly, extensions can create paths to files in
the user's project, and use them as arguments in commands that Zed
should run. For these reasons, we pass *real* paths back and forth
between the host and extensions; we don't try to abstract over the
file-system with some virtualization scheme.
On Windows, this results in a bit of mismatch, because `wasi-libc` uses
*unix-like* path conventions (and thus, so does the Rust standard
library when compiling to WASI).
### Change 1 - Fixing `current_dir`
In order to keep the extension API minimal, extensions use the standard
library function`env::current_dir()` to query the location of their
"work" directory. Previously, when initializing extensions, we used the
`env::set_current_dir` function to set their work directory, but on
Windows, where absolute paths typically begin with a drive letter, like
`C:`, the [`wasi-libc` implementation of
`chdir`](
|
||
|---|---|---|
| .. | ||
| 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.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 |