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 pub targets: HashMap<String, TargetConfig>,
177}
178
179#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
180pub struct TargetConfig {
181 /// URL to download the archive from (e.g., "https://github.com/owner/repo/releases/download/v1.0.0/myagent-darwin-arm64.zip")
182 pub archive: String,
183 /// Command to run (e.g., "./myagent" or "./myagent.exe")
184 pub cmd: String,
185 /// Command-line arguments to pass to the agent server.
186 #[serde(default)]
187 pub args: Vec<String>,
188 /// Optional SHA-256 hash of the archive for verification.
189 /// If not provided and the URL is a GitHub release, we'll attempt to fetch it from GitHub.
190 #[serde(default)]
191 pub sha256: Option<String>,
192}
193
194#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
195pub enum ExtensionLibraryKind {
196 Rust,
197}
198
199#[derive(Clone, Default, PartialEq, Eq, Debug, Deserialize, Serialize)]
200pub struct GrammarManifestEntry {
201 pub repository: String,
202 #[serde(alias = "commit")]
203 pub rev: String,
204 #[serde(default)]
205 pub path: Option<String>,
206}
207
208#[derive(Clone, Default, PartialEq, Eq, Debug, Deserialize, Serialize)]
209pub struct LanguageServerManifestEntry {
210 /// Deprecated in favor of `languages`.
211 #[serde(default)]
212 language: Option<LanguageName>,
213 /// The list of languages this language server should work with.
214 #[serde(default)]
215 languages: Vec<LanguageName>,
216 #[serde(default)]
217 pub language_ids: HashMap<LanguageName, String>,
218 #[serde(default)]
219 pub code_action_kinds: Option<Vec<lsp::CodeActionKind>>,
220}
221
222impl LanguageServerManifestEntry {
223 /// Returns the list of languages for the language server.
224 ///
225 /// Prefer this over accessing the `language` or `languages` fields directly,
226 /// as we currently support both.
227 ///
228 /// We can replace this with just field access for the `languages` field once
229 /// we have removed `language`.
230 pub fn languages(&self) -> impl IntoIterator<Item = LanguageName> + '_ {
231 let language = if self.languages.is_empty() {
232 self.language.clone()
233 } else {
234 None
235 };
236 self.languages.iter().cloned().chain(language)
237 }
238}
239
240#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
241pub struct ContextServerManifestEntry {}
242
243#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
244pub struct SlashCommandManifestEntry {
245 pub description: String,
246 pub requires_argument: bool,
247}
248
249#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
250pub struct DebugAdapterManifestEntry {
251 pub schema_path: Option<PathBuf>,
252}
253
254#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
255pub struct DebugLocatorManifestEntry {}
256
257impl ExtensionManifest {
258 pub async fn load(fs: Arc<dyn Fs>, extension_dir: &Path) -> Result<Self> {
259 let extension_name = extension_dir
260 .file_name()
261 .and_then(OsStr::to_str)
262 .context("invalid extension name")?;
263
264 let mut extension_manifest_path = extension_dir.join("extension.json");
265 if fs.is_file(&extension_manifest_path).await {
266 let manifest_content = fs
267 .load(&extension_manifest_path)
268 .await
269 .with_context(|| format!("failed to load {extension_name} extension.json"))?;
270 let manifest_json = serde_json::from_str::<OldExtensionManifest>(&manifest_content)
271 .with_context(|| {
272 format!("invalid extension.json for extension {extension_name}")
273 })?;
274
275 Ok(manifest_from_old_manifest(manifest_json, extension_name))
276 } else {
277 extension_manifest_path.set_extension("toml");
278 let manifest_content = fs
279 .load(&extension_manifest_path)
280 .await
281 .with_context(|| format!("failed to load {extension_name} extension.toml"))?;
282 toml::from_str(&manifest_content).map_err(|err| {
283 anyhow!("Invalid extension.toml for extension {extension_name}:\n{err}")
284 })
285 }
286 }
287}
288
289fn manifest_from_old_manifest(
290 manifest_json: OldExtensionManifest,
291 extension_id: &str,
292) -> ExtensionManifest {
293 ExtensionManifest {
294 id: extension_id.into(),
295 name: manifest_json.name,
296 version: manifest_json.version,
297 description: manifest_json.description,
298 repository: manifest_json.repository,
299 authors: manifest_json.authors,
300 schema_version: SchemaVersion::ZERO,
301 lib: Default::default(),
302 themes: {
303 let mut themes = manifest_json.themes.into_values().collect::<Vec<_>>();
304 themes.sort();
305 themes.dedup();
306 themes
307 },
308 icon_themes: Vec::new(),
309 languages: {
310 let mut languages = manifest_json.languages.into_values().collect::<Vec<_>>();
311 languages.sort();
312 languages.dedup();
313 languages
314 },
315 grammars: manifest_json
316 .grammars
317 .into_keys()
318 .map(|grammar_name| (grammar_name, Default::default()))
319 .collect(),
320 language_servers: Default::default(),
321 context_servers: BTreeMap::default(),
322 agent_servers: BTreeMap::default(),
323 slash_commands: BTreeMap::default(),
324 snippets: None,
325 capabilities: Vec::new(),
326 debug_adapters: Default::default(),
327 debug_locators: Default::default(),
328 }
329}
330
331#[cfg(test)]
332mod tests {
333 use pretty_assertions::assert_eq;
334
335 use crate::ProcessExecCapability;
336
337 use super::*;
338
339 fn extension_manifest() -> ExtensionManifest {
340 ExtensionManifest {
341 id: "test".into(),
342 name: "Test".to_string(),
343 version: "1.0.0".into(),
344 schema_version: SchemaVersion::ZERO,
345 description: None,
346 repository: None,
347 authors: vec![],
348 lib: Default::default(),
349 themes: vec![],
350 icon_themes: vec![],
351 languages: vec![],
352 grammars: BTreeMap::default(),
353 language_servers: BTreeMap::default(),
354 context_servers: BTreeMap::default(),
355 agent_servers: BTreeMap::default(),
356 slash_commands: BTreeMap::default(),
357 snippets: None,
358 capabilities: vec![],
359 debug_adapters: Default::default(),
360 debug_locators: Default::default(),
361 }
362 }
363
364 #[test]
365 fn test_build_adapter_schema_path_with_schema_path() {
366 let adapter_name = Arc::from("my_adapter");
367 let entry = DebugAdapterManifestEntry {
368 schema_path: Some(PathBuf::from("foo/bar")),
369 };
370
371 let path = build_debug_adapter_schema_path(&adapter_name, &entry);
372 assert_eq!(path, PathBuf::from("foo/bar"));
373 }
374
375 #[test]
376 fn test_build_adapter_schema_path_without_schema_path() {
377 let adapter_name = Arc::from("my_adapter");
378 let entry = DebugAdapterManifestEntry { schema_path: None };
379
380 let path = build_debug_adapter_schema_path(&adapter_name, &entry);
381 assert_eq!(
382 path,
383 PathBuf::from("debug_adapter_schemas").join("my_adapter.json")
384 );
385 }
386
387 #[test]
388 fn test_allow_exec_exact_match() {
389 let manifest = ExtensionManifest {
390 capabilities: vec![ExtensionCapability::ProcessExec(ProcessExecCapability {
391 command: "ls".to_string(),
392 args: vec!["-la".to_string()],
393 })],
394 ..extension_manifest()
395 };
396
397 assert!(manifest.allow_exec("ls", &["-la"]).is_ok());
398 assert!(manifest.allow_exec("ls", &["-l"]).is_err());
399 assert!(manifest.allow_exec("pwd", &[] as &[&str]).is_err());
400 }
401
402 #[test]
403 fn test_allow_exec_wildcard_arg() {
404 let manifest = ExtensionManifest {
405 capabilities: vec![ExtensionCapability::ProcessExec(ProcessExecCapability {
406 command: "git".to_string(),
407 args: vec!["*".to_string()],
408 })],
409 ..extension_manifest()
410 };
411
412 assert!(manifest.allow_exec("git", &["status"]).is_ok());
413 assert!(manifest.allow_exec("git", &["commit"]).is_ok());
414 assert!(manifest.allow_exec("git", &["status", "-s"]).is_err()); // too many args
415 assert!(manifest.allow_exec("npm", &["install"]).is_err()); // wrong command
416 }
417
418 #[test]
419 fn test_allow_exec_double_wildcard() {
420 let manifest = ExtensionManifest {
421 capabilities: vec![ExtensionCapability::ProcessExec(ProcessExecCapability {
422 command: "cargo".to_string(),
423 args: vec!["test".to_string(), "**".to_string()],
424 })],
425 ..extension_manifest()
426 };
427
428 assert!(manifest.allow_exec("cargo", &["test"]).is_ok());
429 assert!(manifest.allow_exec("cargo", &["test", "--all"]).is_ok());
430 assert!(
431 manifest
432 .allow_exec("cargo", &["test", "--all", "--no-fail-fast"])
433 .is_ok()
434 );
435 assert!(manifest.allow_exec("cargo", &["build"]).is_err()); // wrong first arg
436 }
437
438 #[test]
439 fn test_allow_exec_mixed_wildcards() {
440 let manifest = ExtensionManifest {
441 capabilities: vec![ExtensionCapability::ProcessExec(ProcessExecCapability {
442 command: "docker".to_string(),
443 args: vec!["run".to_string(), "*".to_string(), "**".to_string()],
444 })],
445 ..extension_manifest()
446 };
447
448 assert!(manifest.allow_exec("docker", &["run", "nginx"]).is_ok());
449 assert!(manifest.allow_exec("docker", &["run"]).is_err());
450 assert!(
451 manifest
452 .allow_exec("docker", &["run", "ubuntu", "bash"])
453 .is_ok()
454 );
455 assert!(
456 manifest
457 .allow_exec("docker", &["run", "alpine", "sh", "-c", "echo hello"])
458 .is_ok()
459 );
460 assert!(manifest.allow_exec("docker", &["ps"]).is_err()); // wrong first arg
461 }
462 #[test]
463 fn parse_manifest_with_agent_server_archive_launcher() {
464 let toml_src = r#"
465id = "example.agent-server-ext"
466name = "Agent Server Example"
467version = "1.0.0"
468schema_version = 0
469
470[agent_servers.foo]
471name = "Foo Agent"
472
473[agent_servers.foo.targets.linux-x86_64]
474archive = "https://example.com/agent-linux-x64.tar.gz"
475cmd = "./agent"
476args = ["--serve"]
477"#;
478
479 let manifest: ExtensionManifest = toml::from_str(toml_src).expect("manifest should parse");
480 assert_eq!(manifest.id.as_ref(), "example.agent-server-ext");
481 assert!(manifest.agent_servers.contains_key("foo"));
482 let entry = manifest.agent_servers.get("foo").unwrap();
483 assert!(entry.targets.contains_key("linux-x86_64"));
484 let target = entry.targets.get("linux-x86_64").unwrap();
485 assert_eq!(target.archive, "https://example.com/agent-linux-x64.tar.gz");
486 assert_eq!(target.cmd, "./agent");
487 assert_eq!(target.args, vec!["--serve"]);
488 }
489}