1use std::collections::{BTreeSet, HashMap};
2use std::env;
3use std::fs;
4use std::path::{Path, PathBuf};
5use std::sync::Arc;
6
7use ::fs::{CopyOptions, Fs, RealFs, copy_recursive};
8use anyhow::{Context as _, Result, bail};
9use clap::Parser;
10use extension::ExtensionManifest;
11use extension::extension_builder::{CompileExtensionOptions, ExtensionBuilder};
12use language::LanguageConfig;
13use reqwest_client::ReqwestClient;
14use rpc::ExtensionProvides;
15use tokio::process::Command;
16use tree_sitter::{Language, Query, WasmStore};
17
18#[derive(Parser, Debug)]
19#[command(name = "zed-extension")]
20struct Args {
21 /// The path to the extension directory
22 #[arg(long)]
23 source_dir: PathBuf,
24 /// The output directory to place the packaged extension.
25 #[arg(long)]
26 output_dir: PathBuf,
27 /// The path to a directory where build dependencies are downloaded
28 #[arg(long)]
29 scratch_dir: PathBuf,
30}
31
32#[tokio::main]
33async fn main() -> Result<()> {
34 env_logger::init();
35
36 let args = Args::parse();
37 let fs = Arc::new(RealFs::new(None, gpui::background_executor()));
38 let engine = wasmtime::Engine::default();
39 let mut wasm_store = WasmStore::new(&engine)?;
40
41 let extension_path = args
42 .source_dir
43 .canonicalize()
44 .context("failed to canonicalize source_dir")?;
45 let scratch_dir = args
46 .scratch_dir
47 .canonicalize()
48 .context("failed to canonicalize scratch_dir")?;
49 let output_dir = if args.output_dir.is_relative() {
50 env::current_dir()?.join(&args.output_dir)
51 } else {
52 args.output_dir
53 };
54
55 log::info!("loading extension manifest");
56 let mut manifest = ExtensionManifest::load(fs.clone(), &extension_path).await?;
57
58 log::info!("compiling extension");
59
60 let user_agent = format!(
61 "Zed Extension CLI/{} ({}; {})",
62 env!("CARGO_PKG_VERSION"),
63 std::env::consts::OS,
64 std::env::consts::ARCH
65 );
66 let http_client = Arc::new(ReqwestClient::user_agent(&user_agent)?);
67
68 let builder = ExtensionBuilder::new(http_client, scratch_dir);
69 builder
70 .compile_extension(
71 &extension_path,
72 &mut manifest,
73 CompileExtensionOptions { release: true },
74 fs.clone(),
75 )
76 .await
77 .context("failed to compile extension")?;
78
79 let grammars = test_grammars(&manifest, &extension_path, &mut wasm_store)?;
80 test_languages(&manifest, &extension_path, &grammars)?;
81 test_themes(&manifest, &extension_path, fs.clone()).await?;
82
83 let archive_dir = output_dir.join("archive");
84 fs::remove_dir_all(&archive_dir).ok();
85 copy_extension_resources(&manifest, &extension_path, &archive_dir, fs.clone())
86 .await
87 .context("failed to copy extension resources")?;
88
89 let tar_output = Command::new("tar")
90 .current_dir(&output_dir)
91 .args(["-czvf", "archive.tar.gz", "-C", "archive", "."])
92 .output()
93 .await
94 .context("failed to run tar")?;
95 if !tar_output.status.success() {
96 bail!(
97 "failed to create archive.tar.gz: {}",
98 String::from_utf8_lossy(&tar_output.stderr)
99 );
100 }
101
102 let extension_provides = extension_provides(&manifest);
103
104 let manifest_json = serde_json::to_string(&rpc::ExtensionApiManifest {
105 name: manifest.name,
106 version: manifest.version,
107 description: manifest.description,
108 authors: manifest.authors,
109 schema_version: Some(manifest.schema_version.0),
110 repository: manifest
111 .repository
112 .context("missing repository in extension manifest")?,
113 wasm_api_version: manifest.lib.version.map(|version| version.to_string()),
114 provides: extension_provides,
115 })?;
116 fs::remove_dir_all(&archive_dir)?;
117 fs::write(output_dir.join("manifest.json"), manifest_json.as_bytes())?;
118
119 Ok(())
120}
121
122/// Returns the set of features provided by the extension.
123fn extension_provides(manifest: &ExtensionManifest) -> BTreeSet<ExtensionProvides> {
124 let mut provides = BTreeSet::default();
125 if !manifest.themes.is_empty() {
126 provides.insert(ExtensionProvides::Themes);
127 }
128
129 if !manifest.icon_themes.is_empty() {
130 provides.insert(ExtensionProvides::IconThemes);
131 }
132
133 if !manifest.languages.is_empty() {
134 provides.insert(ExtensionProvides::Languages);
135 }
136
137 if !manifest.grammars.is_empty() {
138 provides.insert(ExtensionProvides::Grammars);
139 }
140
141 if !manifest.language_servers.is_empty() {
142 provides.insert(ExtensionProvides::LanguageServers);
143 }
144
145 if !manifest.context_servers.is_empty() {
146 provides.insert(ExtensionProvides::ContextServers);
147 }
148
149 if !manifest.agent_servers.is_empty() {
150 provides.insert(ExtensionProvides::AgentServers);
151 }
152
153 if manifest.snippets.is_some() {
154 provides.insert(ExtensionProvides::Snippets);
155 }
156
157 if !manifest.debug_adapters.is_empty() {
158 provides.insert(ExtensionProvides::DebugAdapters);
159 }
160
161 provides
162}
163
164async fn copy_extension_resources(
165 manifest: &ExtensionManifest,
166 extension_path: &Path,
167 output_dir: &Path,
168 fs: Arc<dyn Fs>,
169) -> Result<()> {
170 fs::create_dir_all(output_dir).context("failed to create output dir")?;
171
172 let manifest_toml = toml::to_string(&manifest).context("failed to serialize manifest")?;
173 fs::write(output_dir.join("extension.toml"), &manifest_toml)
174 .context("failed to write extension.toml")?;
175
176 if manifest.lib.kind.is_some() {
177 fs::copy(
178 extension_path.join("extension.wasm"),
179 output_dir.join("extension.wasm"),
180 )
181 .context("failed to copy extension.wasm")?;
182 }
183
184 if !manifest.grammars.is_empty() {
185 let source_grammars_dir = extension_path.join("grammars");
186 let output_grammars_dir = output_dir.join("grammars");
187 fs::create_dir_all(&output_grammars_dir)?;
188 for grammar_name in manifest.grammars.keys() {
189 let mut grammar_filename = PathBuf::from(grammar_name.as_ref());
190 grammar_filename.set_extension("wasm");
191 fs::copy(
192 source_grammars_dir.join(&grammar_filename),
193 output_grammars_dir.join(&grammar_filename),
194 )
195 .with_context(|| format!("failed to copy grammar '{}'", grammar_filename.display()))?;
196 }
197 }
198
199 if !manifest.themes.is_empty() {
200 let output_themes_dir = output_dir.join("themes");
201 fs::create_dir_all(&output_themes_dir)?;
202 for theme_path in &manifest.themes {
203 fs::copy(
204 extension_path.join(theme_path),
205 output_themes_dir.join(theme_path.file_name().context("invalid theme path")?),
206 )
207 .with_context(|| format!("failed to copy theme '{}'", theme_path.display()))?;
208 }
209 }
210
211 if !manifest.icon_themes.is_empty() {
212 let output_icon_themes_dir = output_dir.join("icon_themes");
213 fs::create_dir_all(&output_icon_themes_dir)?;
214 for icon_theme_path in &manifest.icon_themes {
215 fs::copy(
216 extension_path.join(icon_theme_path),
217 output_icon_themes_dir.join(
218 icon_theme_path
219 .file_name()
220 .context("invalid icon theme path")?,
221 ),
222 )
223 .with_context(|| {
224 format!("failed to copy icon theme '{}'", icon_theme_path.display())
225 })?;
226 }
227
228 let output_icons_dir = output_dir.join("icons");
229 fs::create_dir_all(&output_icons_dir)?;
230 copy_recursive(
231 fs.as_ref(),
232 &extension_path.join("icons"),
233 &output_icons_dir,
234 CopyOptions {
235 overwrite: true,
236 ignore_if_exists: false,
237 },
238 )
239 .await
240 .with_context(|| "failed to copy icons")?;
241 }
242
243 for (_, agent_entry) in &manifest.agent_servers {
244 if let Some(icon_path) = &agent_entry.icon {
245 let source_icon = extension_path.join(icon_path);
246 let dest_icon = output_dir.join(icon_path);
247
248 // Create parent directory if needed
249 if let Some(parent) = dest_icon.parent() {
250 fs::create_dir_all(parent)?;
251 }
252
253 fs::copy(&source_icon, &dest_icon)
254 .with_context(|| format!("failed to copy agent server icon '{}'", icon_path))?;
255 }
256 }
257
258 if !manifest.languages.is_empty() {
259 let output_languages_dir = output_dir.join("languages");
260 fs::create_dir_all(&output_languages_dir)?;
261 for language_path in &manifest.languages {
262 copy_recursive(
263 fs.as_ref(),
264 &extension_path.join(language_path),
265 &output_languages_dir
266 .join(language_path.file_name().context("invalid language path")?),
267 CopyOptions {
268 overwrite: true,
269 ignore_if_exists: false,
270 },
271 )
272 .await
273 .with_context(|| {
274 format!("failed to copy language dir '{}'", language_path.display())
275 })?;
276 }
277 }
278
279 if !manifest.debug_adapters.is_empty() {
280 for (debug_adapter, entry) in &manifest.debug_adapters {
281 let schema_path = entry.schema_path.clone().unwrap_or_else(|| {
282 PathBuf::from("debug_adapter_schemas".to_owned())
283 .join(debug_adapter.as_ref())
284 .with_extension("json")
285 });
286 let parent = schema_path
287 .parent()
288 .with_context(|| format!("invalid empty schema path for {debug_adapter}"))?;
289 fs::create_dir_all(output_dir.join(parent))?;
290 copy_recursive(
291 fs.as_ref(),
292 &extension_path.join(&schema_path),
293 &output_dir.join(&schema_path),
294 CopyOptions {
295 overwrite: true,
296 ignore_if_exists: false,
297 },
298 )
299 .await
300 .with_context(|| {
301 format!(
302 "failed to copy debug adapter schema '{}'",
303 schema_path.display()
304 )
305 })?;
306 }
307 }
308
309 if let Some(snippets_path) = manifest.snippets.as_ref() {
310 let parent = snippets_path.parent();
311 if let Some(parent) = parent.filter(|p| p.components().next().is_some()) {
312 fs::create_dir_all(output_dir.join(parent))?;
313 }
314 copy_recursive(
315 fs.as_ref(),
316 &extension_path.join(&snippets_path),
317 &output_dir.join(&snippets_path),
318 CopyOptions {
319 overwrite: true,
320 ignore_if_exists: false,
321 },
322 )
323 .await
324 .with_context(|| format!("failed to copy snippets from '{}'", snippets_path.display()))?;
325 }
326
327 Ok(())
328}
329
330fn test_grammars(
331 manifest: &ExtensionManifest,
332 extension_path: &Path,
333 wasm_store: &mut WasmStore,
334) -> Result<HashMap<String, Language>> {
335 let mut grammars = HashMap::default();
336 let grammars_dir = extension_path.join("grammars");
337
338 for grammar_name in manifest.grammars.keys() {
339 let mut grammar_path = grammars_dir.join(grammar_name.as_ref());
340 grammar_path.set_extension("wasm");
341
342 let wasm = fs::read(&grammar_path)?;
343 let language = wasm_store.load_language(grammar_name, &wasm)?;
344 log::info!("loaded grammar {grammar_name}");
345 grammars.insert(grammar_name.to_string(), language);
346 }
347
348 Ok(grammars)
349}
350
351fn test_languages(
352 manifest: &ExtensionManifest,
353 extension_path: &Path,
354 grammars: &HashMap<String, Language>,
355) -> Result<()> {
356 for relative_language_dir in &manifest.languages {
357 let language_dir = extension_path.join(relative_language_dir);
358 let config_path = language_dir.join("config.toml");
359 let config_content = fs::read_to_string(&config_path)?;
360 let config: LanguageConfig = toml::from_str(&config_content)?;
361 let grammar = if let Some(name) = &config.grammar {
362 Some(
363 grammars
364 .get(name.as_ref())
365 .with_context(|| format!("grammar not found: '{name}'"))?,
366 )
367 } else {
368 None
369 };
370
371 let query_entries = fs::read_dir(&language_dir)?;
372 for entry in query_entries {
373 let entry = entry?;
374 let query_path = entry.path();
375 if query_path.extension() == Some("scm".as_ref()) {
376 let grammar = grammar.with_context(|| {
377 format! {
378 "language {} provides query {} but no grammar",
379 config.name,
380 query_path.display()
381 }
382 })?;
383
384 let query_source = fs::read_to_string(&query_path)?;
385 let _query = Query::new(grammar, &query_source)?;
386 }
387 }
388
389 log::info!("loaded language {}", config.name);
390 }
391
392 Ok(())
393}
394
395async fn test_themes(
396 manifest: &ExtensionManifest,
397 extension_path: &Path,
398 fs: Arc<dyn Fs>,
399) -> Result<()> {
400 for relative_theme_path in &manifest.themes {
401 let theme_path = extension_path.join(relative_theme_path);
402 let theme_family = theme::read_user_theme(&theme_path, fs.clone()).await?;
403 log::info!("loaded theme family {}", theme_family.name);
404
405 for theme in &theme_family.themes {
406 if theme
407 .style
408 .colors
409 .deprecated_scrollbar_thumb_background
410 .is_some()
411 {
412 bail!(
413 r#"Theme "{theme_name}" is using a deprecated style property: scrollbar_thumb.background. Use `scrollbar.thumb.background` instead."#,
414 theme_name = theme.name
415 )
416 }
417 }
418 }
419
420 Ok(())
421}