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