1use anyhow::{Context as _, Result, anyhow, bail};
2use collections::{BTreeMap, HashMap};
3use fs::Fs;
4use language::LanguageName;
5use lsp::LanguageServerName;
6use semantic_version::SemanticVersion;
7use serde::{Deserialize, Serialize};
8use std::{
9 ffi::OsStr,
10 fmt,
11 path::{Path, PathBuf},
12 sync::Arc,
13};
14
15use crate::ExtensionCapability;
16
17/// This is the old version of the extension manifest, from when it was `extension.json`.
18#[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
19pub struct OldExtensionManifest {
20 pub name: String,
21 pub version: Arc<str>,
22
23 #[serde(default)]
24 pub description: Option<String>,
25 #[serde(default)]
26 pub repository: Option<String>,
27 #[serde(default)]
28 pub authors: Vec<String>,
29
30 #[serde(default)]
31 pub themes: BTreeMap<Arc<str>, PathBuf>,
32 #[serde(default)]
33 pub languages: BTreeMap<Arc<str>, PathBuf>,
34 #[serde(default)]
35 pub grammars: BTreeMap<Arc<str>, PathBuf>,
36}
37
38/// The schema version of the [`ExtensionManifest`].
39#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy, Serialize, Deserialize)]
40pub struct SchemaVersion(pub i32);
41
42impl fmt::Display for SchemaVersion {
43 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
44 write!(f, "{}", self.0)
45 }
46}
47
48impl SchemaVersion {
49 pub const ZERO: Self = Self(0);
50
51 pub fn is_v0(&self) -> bool {
52 self == &Self::ZERO
53 }
54}
55
56#[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
57pub struct ExtensionManifest {
58 pub id: Arc<str>,
59 pub name: String,
60 pub version: Arc<str>,
61 pub schema_version: SchemaVersion,
62
63 #[serde(default)]
64 pub description: Option<String>,
65 #[serde(default)]
66 pub repository: Option<String>,
67 #[serde(default)]
68 pub authors: Vec<String>,
69 #[serde(default)]
70 pub lib: LibManifestEntry,
71
72 #[serde(default)]
73 pub themes: Vec<PathBuf>,
74 #[serde(default)]
75 pub icon_themes: Vec<PathBuf>,
76 #[serde(default)]
77 pub languages: Vec<PathBuf>,
78 #[serde(default)]
79 pub grammars: BTreeMap<Arc<str>, GrammarManifestEntry>,
80 #[serde(default)]
81 pub language_servers: BTreeMap<LanguageServerName, LanguageServerManifestEntry>,
82 #[serde(default)]
83 pub context_servers: BTreeMap<Arc<str>, ContextServerManifestEntry>,
84 #[serde(default)]
85 pub agent_servers: BTreeMap<Arc<str>, AgentServerManifestEntry>,
86 #[serde(default)]
87 pub slash_commands: BTreeMap<Arc<str>, SlashCommandManifestEntry>,
88 #[serde(default)]
89 pub snippets: Option<PathBuf>,
90 #[serde(default)]
91 pub capabilities: Vec<ExtensionCapability>,
92 #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
93 pub debug_adapters: BTreeMap<Arc<str>, DebugAdapterManifestEntry>,
94 #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
95 pub debug_locators: BTreeMap<Arc<str>, DebugLocatorManifestEntry>,
96}
97
98impl ExtensionManifest {
99 pub fn allow_exec(
100 &self,
101 desired_command: &str,
102 desired_args: &[impl AsRef<str> + std::fmt::Debug],
103 ) -> Result<()> {
104 let is_allowed = self.capabilities.iter().any(|capability| match capability {
105 ExtensionCapability::ProcessExec(capability) => {
106 capability.allows(desired_command, desired_args)
107 }
108 _ => false,
109 });
110
111 if !is_allowed {
112 bail!(
113 "capability for process:exec {desired_command} {desired_args:?} was not listed in the extension manifest",
114 );
115 }
116
117 Ok(())
118 }
119
120 pub fn allow_remote_load(&self) -> bool {
121 !self.language_servers.is_empty()
122 || !self.debug_adapters.is_empty()
123 || !self.debug_locators.is_empty()
124 }
125}
126
127pub fn build_debug_adapter_schema_path(
128 adapter_name: &Arc<str>,
129 meta: &DebugAdapterManifestEntry,
130) -> PathBuf {
131 meta.schema_path.clone().unwrap_or_else(|| {
132 Path::new("debug_adapter_schemas")
133 .join(Path::new(adapter_name.as_ref()).with_extension("json"))
134 })
135}
136
137#[derive(Clone, Default, PartialEq, Eq, Debug, Deserialize, Serialize)]
138pub struct LibManifestEntry {
139 pub kind: Option<ExtensionLibraryKind>,
140 pub version: Option<SemanticVersion>,
141}
142
143#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
144pub struct AgentServerManifestEntry {
145 /// Display name for the agent (shown in menus).
146 pub name: String,
147 /// Environment variables to set when launching the agent server.
148 #[serde(default)]
149 pub env: HashMap<String, String>,
150 /// Optional icon path (relative to extension root, e.g., "ai.svg").
151 /// Should be a small SVG icon for display in menus.
152 #[serde(default)]
153 pub icon: Option<String>,
154 /// Per-target configuration for archive-based installation.
155 /// The key format is "{os}-{arch}" where:
156 /// - os: "darwin" (macOS), "linux", "windows"
157 /// - arch: "aarch64" (arm64), "x86_64"
158 ///
159 /// Example:
160 /// ```toml
161 /// [agent_servers.myagent.targets.darwin-aarch64]
162 /// archive = "https://example.com/myagent-darwin-arm64.zip"
163 /// cmd = "./myagent"
164 /// args = ["--serve"]
165 /// sha256 = "abc123..." # optional
166 /// ```
167 ///
168 /// For Node.js-based agents, you can use "node" as the cmd to automatically
169 /// use Zed's managed Node.js runtime instead of relying on the user's PATH:
170 /// ```toml
171 /// [agent_servers.nodeagent.targets.darwin-aarch64]
172 /// archive = "https://example.com/nodeagent.zip"
173 /// cmd = "node"
174 /// args = ["index.js", "--port", "3000"]
175 /// ```
176 ///
177 /// Note: All commands are executed with the archive extraction directory as the
178 /// working directory, so relative paths in args (like "index.js") will resolve
179 /// relative to the extracted archive contents.
180 pub targets: HashMap<String, TargetConfig>,
181}
182
183#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
184pub struct TargetConfig {
185 /// URL to download the archive from (e.g., "https://github.com/owner/repo/releases/download/v1.0.0/myagent-darwin-arm64.zip")
186 pub archive: String,
187 /// Command to run (e.g., "./myagent" or "./myagent.exe")
188 pub cmd: String,
189 /// Command-line arguments to pass to the agent server.
190 #[serde(default)]
191 pub args: Vec<String>,
192 /// Optional SHA-256 hash of the archive for verification.
193 /// If not provided and the URL is a GitHub release, we'll attempt to fetch it from GitHub.
194 #[serde(default)]
195 pub sha256: Option<String>,
196}
197
198#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
199pub enum ExtensionLibraryKind {
200 Rust,
201}
202
203#[derive(Clone, Default, PartialEq, Eq, Debug, Deserialize, Serialize)]
204pub struct GrammarManifestEntry {
205 pub repository: String,
206 #[serde(alias = "commit")]
207 pub rev: String,
208 #[serde(default)]
209 pub path: Option<String>,
210}
211
212#[derive(Clone, Default, PartialEq, Eq, Debug, Deserialize, Serialize)]
213pub struct LanguageServerManifestEntry {
214 /// Deprecated in favor of `languages`.
215 #[serde(default)]
216 language: Option<LanguageName>,
217 /// The list of languages this language server should work with.
218 #[serde(default)]
219 languages: Vec<LanguageName>,
220 #[serde(default)]
221 pub language_ids: HashMap<LanguageName, String>,
222 #[serde(default)]
223 pub code_action_kinds: Option<Vec<lsp::CodeActionKind>>,
224}
225
226impl LanguageServerManifestEntry {
227 /// Returns the list of languages for the language server.
228 ///
229 /// Prefer this over accessing the `language` or `languages` fields directly,
230 /// as we currently support both.
231 ///
232 /// We can replace this with just field access for the `languages` field once
233 /// we have removed `language`.
234 pub fn languages(&self) -> impl IntoIterator<Item = LanguageName> + '_ {
235 let language = if self.languages.is_empty() {
236 self.language.clone()
237 } else {
238 None
239 };
240 self.languages.iter().cloned().chain(language)
241 }
242}
243
244#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
245pub struct ContextServerManifestEntry {}
246
247#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
248pub struct SlashCommandManifestEntry {
249 pub description: String,
250 pub requires_argument: bool,
251}
252
253#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
254pub struct DebugAdapterManifestEntry {
255 pub schema_path: Option<PathBuf>,
256}
257
258#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
259pub struct DebugLocatorManifestEntry {}
260
261impl ExtensionManifest {
262 pub async fn load(fs: Arc<dyn Fs>, extension_dir: &Path) -> Result<Self> {
263 let extension_name = extension_dir
264 .file_name()
265 .and_then(OsStr::to_str)
266 .context("invalid extension name")?;
267
268 let mut extension_manifest_path = extension_dir.join("extension.json");
269 if fs.is_file(&extension_manifest_path).await {
270 let manifest_content = fs.load(&extension_manifest_path).await.with_context(|| {
271 format!("loading {extension_name} extension.json, {extension_manifest_path:?}")
272 })?;
273 let manifest_json = serde_json::from_str::<OldExtensionManifest>(&manifest_content)
274 .with_context(|| {
275 format!("invalid extension.json for extension {extension_name}")
276 })?;
277
278 Ok(manifest_from_old_manifest(manifest_json, extension_name))
279 } else {
280 extension_manifest_path.set_extension("toml");
281 let manifest_content = fs.load(&extension_manifest_path).await.with_context(|| {
282 format!("loading {extension_name} extension.toml, {extension_manifest_path:?}")
283 })?;
284 toml::from_str(&manifest_content).map_err(|err| {
285 anyhow!("Invalid extension.toml for extension {extension_name}:\n{err}")
286 })
287 }
288 }
289}
290
291fn manifest_from_old_manifest(
292 manifest_json: OldExtensionManifest,
293 extension_id: &str,
294) -> ExtensionManifest {
295 ExtensionManifest {
296 id: extension_id.into(),
297 name: manifest_json.name,
298 version: manifest_json.version,
299 description: manifest_json.description,
300 repository: manifest_json.repository,
301 authors: manifest_json.authors,
302 schema_version: SchemaVersion::ZERO,
303 lib: Default::default(),
304 themes: {
305 let mut themes = manifest_json.themes.into_values().collect::<Vec<_>>();
306 themes.sort();
307 themes.dedup();
308 themes
309 },
310 icon_themes: Vec::new(),
311 languages: {
312 let mut languages = manifest_json.languages.into_values().collect::<Vec<_>>();
313 languages.sort();
314 languages.dedup();
315 languages
316 },
317 grammars: manifest_json
318 .grammars
319 .into_keys()
320 .map(|grammar_name| (grammar_name, Default::default()))
321 .collect(),
322 language_servers: Default::default(),
323 context_servers: BTreeMap::default(),
324 agent_servers: BTreeMap::default(),
325 slash_commands: BTreeMap::default(),
326 snippets: None,
327 capabilities: Vec::new(),
328 debug_adapters: Default::default(),
329 debug_locators: Default::default(),
330 }
331}
332
333#[cfg(test)]
334mod tests {
335 use pretty_assertions::assert_eq;
336
337 use crate::ProcessExecCapability;
338
339 use super::*;
340
341 fn extension_manifest() -> ExtensionManifest {
342 ExtensionManifest {
343 id: "test".into(),
344 name: "Test".to_string(),
345 version: "1.0.0".into(),
346 schema_version: SchemaVersion::ZERO,
347 description: None,
348 repository: None,
349 authors: vec![],
350 lib: Default::default(),
351 themes: vec![],
352 icon_themes: vec![],
353 languages: vec![],
354 grammars: BTreeMap::default(),
355 language_servers: BTreeMap::default(),
356 context_servers: BTreeMap::default(),
357 agent_servers: BTreeMap::default(),
358 slash_commands: BTreeMap::default(),
359 snippets: None,
360 capabilities: vec![],
361 debug_adapters: Default::default(),
362 debug_locators: Default::default(),
363 }
364 }
365
366 #[test]
367 fn test_build_adapter_schema_path_with_schema_path() {
368 let adapter_name = Arc::from("my_adapter");
369 let entry = DebugAdapterManifestEntry {
370 schema_path: Some(PathBuf::from("foo/bar")),
371 };
372
373 let path = build_debug_adapter_schema_path(&adapter_name, &entry);
374 assert_eq!(path, PathBuf::from("foo/bar"));
375 }
376
377 #[test]
378 fn test_build_adapter_schema_path_without_schema_path() {
379 let adapter_name = Arc::from("my_adapter");
380 let entry = DebugAdapterManifestEntry { schema_path: None };
381
382 let path = build_debug_adapter_schema_path(&adapter_name, &entry);
383 assert_eq!(
384 path,
385 PathBuf::from("debug_adapter_schemas").join("my_adapter.json")
386 );
387 }
388
389 #[test]
390 fn test_allow_exec_exact_match() {
391 let manifest = ExtensionManifest {
392 capabilities: vec![ExtensionCapability::ProcessExec(ProcessExecCapability {
393 command: "ls".to_string(),
394 args: vec!["-la".to_string()],
395 })],
396 ..extension_manifest()
397 };
398
399 assert!(manifest.allow_exec("ls", &["-la"]).is_ok());
400 assert!(manifest.allow_exec("ls", &["-l"]).is_err());
401 assert!(manifest.allow_exec("pwd", &[] as &[&str]).is_err());
402 }
403
404 #[test]
405 fn test_allow_exec_wildcard_arg() {
406 let manifest = ExtensionManifest {
407 capabilities: vec![ExtensionCapability::ProcessExec(ProcessExecCapability {
408 command: "git".to_string(),
409 args: vec!["*".to_string()],
410 })],
411 ..extension_manifest()
412 };
413
414 assert!(manifest.allow_exec("git", &["status"]).is_ok());
415 assert!(manifest.allow_exec("git", &["commit"]).is_ok());
416 assert!(manifest.allow_exec("git", &["status", "-s"]).is_err()); // too many args
417 assert!(manifest.allow_exec("npm", &["install"]).is_err()); // wrong command
418 }
419
420 #[test]
421 fn test_allow_exec_double_wildcard() {
422 let manifest = ExtensionManifest {
423 capabilities: vec![ExtensionCapability::ProcessExec(ProcessExecCapability {
424 command: "cargo".to_string(),
425 args: vec!["test".to_string(), "**".to_string()],
426 })],
427 ..extension_manifest()
428 };
429
430 assert!(manifest.allow_exec("cargo", &["test"]).is_ok());
431 assert!(manifest.allow_exec("cargo", &["test", "--all"]).is_ok());
432 assert!(
433 manifest
434 .allow_exec("cargo", &["test", "--all", "--no-fail-fast"])
435 .is_ok()
436 );
437 assert!(manifest.allow_exec("cargo", &["build"]).is_err()); // wrong first arg
438 }
439
440 #[test]
441 fn test_allow_exec_mixed_wildcards() {
442 let manifest = ExtensionManifest {
443 capabilities: vec![ExtensionCapability::ProcessExec(ProcessExecCapability {
444 command: "docker".to_string(),
445 args: vec!["run".to_string(), "*".to_string(), "**".to_string()],
446 })],
447 ..extension_manifest()
448 };
449
450 assert!(manifest.allow_exec("docker", &["run", "nginx"]).is_ok());
451 assert!(manifest.allow_exec("docker", &["run"]).is_err());
452 assert!(
453 manifest
454 .allow_exec("docker", &["run", "ubuntu", "bash"])
455 .is_ok()
456 );
457 assert!(
458 manifest
459 .allow_exec("docker", &["run", "alpine", "sh", "-c", "echo hello"])
460 .is_ok()
461 );
462 assert!(manifest.allow_exec("docker", &["ps"]).is_err()); // wrong first arg
463 }
464 #[test]
465 fn parse_manifest_with_agent_server_archive_launcher() {
466 let toml_src = r#"
467id = "example.agent-server-ext"
468name = "Agent Server Example"
469version = "1.0.0"
470schema_version = 0
471
472[agent_servers.foo]
473name = "Foo Agent"
474
475[agent_servers.foo.targets.linux-x86_64]
476archive = "https://example.com/agent-linux-x64.tar.gz"
477cmd = "./agent"
478args = ["--serve"]
479"#;
480
481 let manifest: ExtensionManifest = toml::from_str(toml_src).expect("manifest should parse");
482 assert_eq!(manifest.id.as_ref(), "example.agent-server-ext");
483 assert!(manifest.agent_servers.contains_key("foo"));
484 let entry = manifest.agent_servers.get("foo").unwrap();
485 assert!(entry.targets.contains_key("linux-x86_64"));
486 let target = entry.targets.get("linux-x86_64").unwrap();
487 assert_eq!(target.archive, "https://example.com/agent-linux-x64.tar.gz");
488 assert_eq!(target.cmd, "./agent");
489 assert_eq!(target.args, vec!["--serve"]);
490 }
491}