1use anyhow::{Context as _, Result, bail};
2use async_compression::futures::bufread::GzipDecoder;
3use async_tar::Archive;
4use async_trait::async_trait;
5use collections::HashMap;
6use dap::DapRegistry;
7use futures::StreamExt;
8use gpui::{App, AsyncApp, SharedString, Task};
9use http_client::github::{GitHubLspBinaryVersion, latest_github_release};
10use language::{
11 ContextProvider, LanguageName, LanguageRegistry, LocalFile as _, LspAdapter,
12 LspAdapterDelegate, LspInstaller, Toolchain,
13};
14use lsp::{LanguageServerBinary, LanguageServerName};
15use node_runtime::{NodeRuntime, VersionStrategy};
16use project::lsp_store::language_server_settings;
17use serde_json::{Value, json};
18use settings::{KeymapFile, SettingsJsonSchemaParams, SettingsStore};
19use smol::{
20 fs::{self},
21 io::BufReader,
22 lock::RwLock,
23};
24use std::{
25 env::consts,
26 ffi::OsString,
27 path::{Path, PathBuf},
28 str::FromStr,
29 sync::Arc,
30};
31use task::{AdapterSchemas, TaskTemplate, TaskTemplates, VariableName};
32use theme::ThemeRegistry;
33use util::{ResultExt, archive::extract_zip, fs::remove_matching, maybe, merge_json_value_into};
34
35use crate::PackageJsonData;
36
37const SERVER_PATH: &str =
38 "node_modules/vscode-langservers-extracted/bin/vscode-json-language-server";
39
40// Origin: https://github.com/SchemaStore/schemastore
41const TSCONFIG_SCHEMA: &str = include_str!("json/schemas/tsconfig.json");
42const PACKAGE_JSON_SCHEMA: &str = include_str!("json/schemas/package.json");
43
44pub(crate) struct JsonTaskProvider;
45
46impl ContextProvider for JsonTaskProvider {
47 fn associated_tasks(
48 &self,
49 file: Option<Arc<dyn language::File>>,
50 cx: &App,
51 ) -> gpui::Task<Option<TaskTemplates>> {
52 let Some(file) = project::File::from_dyn(file.as_ref()).cloned() else {
53 return Task::ready(None);
54 };
55 let is_package_json = file.path.ends_with("package.json");
56 let is_composer_json = file.path.ends_with("composer.json");
57 if !is_package_json && !is_composer_json {
58 return Task::ready(None);
59 }
60
61 cx.spawn(async move |cx| {
62 let contents = file
63 .worktree
64 .update(cx, |this, cx| this.load_file(&file.path, cx))
65 .ok()?
66 .await
67 .ok()?;
68 let path = cx.update(|cx| file.abs_path(cx)).ok()?.as_path().into();
69
70 let task_templates = if is_package_json {
71 let package_json = serde_json_lenient::from_str::<
72 HashMap<String, serde_json_lenient::Value>,
73 >(&contents.text)
74 .ok()?;
75 let package_json = PackageJsonData::new(path, package_json);
76 let command = package_json.package_manager.unwrap_or("npm").to_owned();
77 package_json
78 .scripts
79 .into_iter()
80 .map(|(_, key)| TaskTemplate {
81 label: format!("run {key}"),
82 command: command.clone(),
83 args: vec!["run".into(), key],
84 cwd: Some(VariableName::Dirname.template_value()),
85 ..TaskTemplate::default()
86 })
87 .chain([TaskTemplate {
88 label: "package script $ZED_CUSTOM_script".to_owned(),
89 command: command.clone(),
90 args: vec![
91 "run".into(),
92 VariableName::Custom("script".into()).template_value(),
93 ],
94 cwd: Some(VariableName::Dirname.template_value()),
95 tags: vec!["package-script".into()],
96 ..TaskTemplate::default()
97 }])
98 .collect()
99 } else if is_composer_json {
100 serde_json_lenient::Value::from_str(&contents.text)
101 .ok()?
102 .get("scripts")?
103 .as_object()?
104 .keys()
105 .map(|key| TaskTemplate {
106 label: format!("run {key}"),
107 command: "composer".to_owned(),
108 args: vec!["-d".into(), "$ZED_DIRNAME".into(), key.into()],
109 ..TaskTemplate::default()
110 })
111 .chain([TaskTemplate {
112 label: "composer script $ZED_CUSTOM_script".to_owned(),
113 command: "composer".to_owned(),
114 args: vec![
115 "-d".into(),
116 "$ZED_DIRNAME".into(),
117 VariableName::Custom("script".into()).template_value(),
118 ],
119 tags: vec!["composer-script".into()],
120 ..TaskTemplate::default()
121 }])
122 .collect()
123 } else {
124 vec![]
125 };
126
127 Some(TaskTemplates(task_templates))
128 })
129 }
130}
131
132fn server_binary_arguments(server_path: &Path) -> Vec<OsString> {
133 vec![server_path.into(), "--stdio".into()]
134}
135
136pub struct JsonLspAdapter {
137 node: NodeRuntime,
138 languages: Arc<LanguageRegistry>,
139 workspace_config: RwLock<Option<Value>>,
140}
141
142impl JsonLspAdapter {
143 const PACKAGE_NAME: &str = "vscode-langservers-extracted";
144
145 pub fn new(node: NodeRuntime, languages: Arc<LanguageRegistry>) -> Self {
146 Self {
147 node,
148 languages,
149 workspace_config: Default::default(),
150 }
151 }
152
153 fn get_workspace_config(
154 language_names: Vec<String>,
155 adapter_schemas: AdapterSchemas,
156 cx: &mut App,
157 ) -> Value {
158 let keymap_schema = KeymapFile::generate_json_schema_for_registered_actions(cx);
159 let font_names = &cx.text_system().all_font_names();
160 let theme_names = &ThemeRegistry::global(cx).list_names();
161 let icon_theme_names = &ThemeRegistry::global(cx)
162 .list_icon_themes()
163 .into_iter()
164 .map(|icon_theme| icon_theme.name)
165 .collect::<Vec<SharedString>>();
166 let settings_schema = cx
167 .global::<SettingsStore>()
168 .json_schema(&SettingsJsonSchemaParams {
169 language_names: &language_names,
170 font_names,
171 theme_names,
172 icon_theme_names,
173 });
174
175 let tasks_schema = task::TaskTemplates::generate_json_schema();
176 let debug_schema = task::DebugTaskFile::generate_json_schema(&adapter_schemas);
177 let snippets_schema = snippet_provider::format::VsSnippetsFile::generate_json_schema();
178 let tsconfig_schema = serde_json::Value::from_str(TSCONFIG_SCHEMA).unwrap();
179 let package_json_schema = serde_json::Value::from_str(PACKAGE_JSON_SCHEMA).unwrap();
180
181 #[allow(unused_mut)]
182 let mut schemas = serde_json::json!([
183 {
184 "fileMatch": ["tsconfig.json"],
185 "schema":tsconfig_schema
186 },
187 {
188 "fileMatch": ["package.json"],
189 "schema":package_json_schema
190 },
191 {
192 "fileMatch": [
193 schema_file_match(paths::settings_file()),
194 paths::local_settings_file_relative_path()
195 ],
196 "schema": settings_schema,
197 },
198 {
199 "fileMatch": [schema_file_match(paths::keymap_file())],
200 "schema": keymap_schema,
201 },
202 {
203 "fileMatch": [
204 schema_file_match(paths::tasks_file()),
205 paths::local_tasks_file_relative_path()
206 ],
207 "schema": tasks_schema,
208 },
209 {
210 "fileMatch": [
211 schema_file_match(
212 paths::snippets_dir()
213 .join("*.json")
214 .as_path()
215 )
216 ],
217 "schema": snippets_schema,
218 },
219 {
220 "fileMatch": [
221 schema_file_match(paths::debug_scenarios_file()),
222 paths::local_debug_file_relative_path()
223 ],
224 "schema": debug_schema,
225 },
226 ]);
227
228 #[cfg(debug_assertions)]
229 {
230 schemas.as_array_mut().unwrap().push(serde_json::json!(
231 {
232 "fileMatch": [
233 "zed-inspector-style.json"
234 ],
235 "schema": generate_inspector_style_schema(),
236 }
237 ))
238 }
239
240 schemas
241 .as_array_mut()
242 .unwrap()
243 .extend(cx.all_action_names().iter().map(|&name| {
244 project::lsp_store::json_language_server_ext::url_schema_for_action(name)
245 }));
246
247 // This can be viewed via `dev: open language server logs` -> `json-language-server` ->
248 // `Server Info`
249 serde_json::json!({
250 "json": {
251 "format": {
252 "enable": true,
253 },
254 "validate":
255 {
256 "enable": true,
257 },
258 "schemas": schemas
259 }
260 })
261 }
262
263 async fn get_or_init_workspace_config(&self, cx: &mut AsyncApp) -> Result<Value> {
264 {
265 let reader = self.workspace_config.read().await;
266 if let Some(config) = reader.as_ref() {
267 return Ok(config.clone());
268 }
269 }
270 let mut writer = self.workspace_config.write().await;
271
272 let adapter_schemas = cx
273 .read_global::<DapRegistry, _>(|dap_registry, _| dap_registry.to_owned())?
274 .adapters_schema()
275 .await;
276
277 let config = cx.update(|cx| {
278 Self::get_workspace_config(
279 self.languages
280 .language_names()
281 .into_iter()
282 .map(|name| name.to_string())
283 .collect(),
284 adapter_schemas,
285 cx,
286 )
287 })?;
288 writer.replace(config.clone());
289 Ok(config)
290 }
291}
292
293#[cfg(debug_assertions)]
294fn generate_inspector_style_schema() -> serde_json_lenient::Value {
295 let schema = schemars::generate::SchemaSettings::draft2019_09()
296 .with_transform(util::schemars::DefaultDenyUnknownFields)
297 .into_generator()
298 .root_schema_for::<gpui::StyleRefinement>();
299
300 serde_json_lenient::to_value(schema).unwrap()
301}
302
303impl LspInstaller for JsonLspAdapter {
304 type BinaryVersion = String;
305
306 async fn fetch_latest_server_version(
307 &self,
308 _: &dyn LspAdapterDelegate,
309 _: bool,
310 _: &mut AsyncApp,
311 ) -> Result<String> {
312 self.node
313 .npm_package_latest_version(Self::PACKAGE_NAME)
314 .await
315 }
316
317 async fn check_if_user_installed(
318 &self,
319 delegate: &dyn LspAdapterDelegate,
320 _: Option<Toolchain>,
321 _: &AsyncApp,
322 ) -> Option<LanguageServerBinary> {
323 let path = delegate
324 .which("vscode-json-language-server".as_ref())
325 .await?;
326 let env = delegate.shell_env().await;
327
328 Some(LanguageServerBinary {
329 path,
330 env: Some(env),
331 arguments: vec!["--stdio".into()],
332 })
333 }
334
335 async fn check_if_version_installed(
336 &self,
337 version: &String,
338 container_dir: &PathBuf,
339 _: &dyn LspAdapterDelegate,
340 ) -> Option<LanguageServerBinary> {
341 let server_path = container_dir.join(SERVER_PATH);
342
343 let should_install_language_server = self
344 .node
345 .should_install_npm_package(
346 Self::PACKAGE_NAME,
347 &server_path,
348 container_dir,
349 VersionStrategy::Latest(version),
350 )
351 .await;
352
353 if should_install_language_server {
354 None
355 } else {
356 Some(LanguageServerBinary {
357 path: self.node.binary_path().await.ok()?,
358 env: None,
359 arguments: server_binary_arguments(&server_path),
360 })
361 }
362 }
363
364 async fn fetch_server_binary(
365 &self,
366 latest_version: String,
367 container_dir: PathBuf,
368 _: &dyn LspAdapterDelegate,
369 ) -> Result<LanguageServerBinary> {
370 let server_path = container_dir.join(SERVER_PATH);
371
372 self.node
373 .npm_install_packages(
374 &container_dir,
375 &[(Self::PACKAGE_NAME, latest_version.as_str())],
376 )
377 .await?;
378
379 Ok(LanguageServerBinary {
380 path: self.node.binary_path().await?,
381 env: None,
382 arguments: server_binary_arguments(&server_path),
383 })
384 }
385
386 async fn cached_server_binary(
387 &self,
388 container_dir: PathBuf,
389 _: &dyn LspAdapterDelegate,
390 ) -> Option<LanguageServerBinary> {
391 get_cached_server_binary(container_dir, &self.node).await
392 }
393}
394
395#[async_trait(?Send)]
396impl LspAdapter for JsonLspAdapter {
397 fn name(&self) -> LanguageServerName {
398 LanguageServerName("json-language-server".into())
399 }
400
401 async fn initialization_options(
402 self: Arc<Self>,
403 _: &Arc<dyn LspAdapterDelegate>,
404 ) -> Result<Option<serde_json::Value>> {
405 Ok(Some(json!({
406 "provideFormatter": true
407 })))
408 }
409
410 async fn workspace_configuration(
411 self: Arc<Self>,
412 delegate: &Arc<dyn LspAdapterDelegate>,
413 _: Option<Toolchain>,
414 cx: &mut AsyncApp,
415 ) -> Result<Value> {
416 let mut config = self.get_or_init_workspace_config(cx).await?;
417
418 let project_options = cx.update(|cx| {
419 language_server_settings(delegate.as_ref(), &self.name(), cx)
420 .and_then(|s| s.settings.clone())
421 })?;
422
423 if let Some(override_options) = project_options {
424 merge_json_value_into(override_options, &mut config);
425 }
426
427 Ok(config)
428 }
429
430 fn language_ids(&self) -> HashMap<LanguageName, String> {
431 [
432 (LanguageName::new("JSON"), "json".into()),
433 (LanguageName::new("JSONC"), "jsonc".into()),
434 ]
435 .into_iter()
436 .collect()
437 }
438
439 fn is_primary_zed_json_schema_adapter(&self) -> bool {
440 true
441 }
442
443 async fn clear_zed_json_schema_cache(&self) {
444 self.workspace_config.write().await.take();
445 }
446}
447
448async fn get_cached_server_binary(
449 container_dir: PathBuf,
450 node: &NodeRuntime,
451) -> Option<LanguageServerBinary> {
452 maybe!(async {
453 let mut last_version_dir = None;
454 let mut entries = fs::read_dir(&container_dir).await?;
455 while let Some(entry) = entries.next().await {
456 let entry = entry?;
457 if entry.file_type().await?.is_dir() {
458 last_version_dir = Some(entry.path());
459 }
460 }
461
462 let last_version_dir = last_version_dir.context("no cached binary")?;
463 let server_path = last_version_dir.join(SERVER_PATH);
464 anyhow::ensure!(
465 server_path.exists(),
466 "missing executable in directory {last_version_dir:?}"
467 );
468 Ok(LanguageServerBinary {
469 path: node.binary_path().await?,
470 env: None,
471 arguments: server_binary_arguments(&server_path),
472 })
473 })
474 .await
475 .log_err()
476}
477
478#[inline]
479fn schema_file_match(path: &Path) -> String {
480 path.strip_prefix(path.parent().unwrap().parent().unwrap())
481 .unwrap()
482 .display()
483 .to_string()
484 .replace('\\', "/")
485}
486
487pub struct NodeVersionAdapter;
488
489impl NodeVersionAdapter {
490 const SERVER_NAME: LanguageServerName =
491 LanguageServerName::new_static("package-version-server");
492}
493
494impl LspInstaller for NodeVersionAdapter {
495 type BinaryVersion = GitHubLspBinaryVersion;
496
497 async fn fetch_latest_server_version(
498 &self,
499 delegate: &dyn LspAdapterDelegate,
500 _: bool,
501 _: &mut AsyncApp,
502 ) -> Result<GitHubLspBinaryVersion> {
503 let release = latest_github_release(
504 "zed-industries/package-version-server",
505 true,
506 false,
507 delegate.http_client(),
508 )
509 .await?;
510 let os = match consts::OS {
511 "macos" => "apple-darwin",
512 "linux" => "unknown-linux-gnu",
513 "windows" => "pc-windows-msvc",
514 other => bail!("Running on unsupported os: {other}"),
515 };
516 let suffix = if consts::OS == "windows" {
517 ".zip"
518 } else {
519 ".tar.gz"
520 };
521 let asset_name = format!("{}-{}-{os}{suffix}", Self::SERVER_NAME, consts::ARCH);
522 let asset = release
523 .assets
524 .iter()
525 .find(|asset| asset.name == asset_name)
526 .with_context(|| format!("no asset found matching `{asset_name:?}`"))?;
527 Ok(GitHubLspBinaryVersion {
528 name: release.tag_name,
529 url: asset.browser_download_url.clone(),
530 digest: asset.digest.clone(),
531 })
532 }
533
534 async fn check_if_user_installed(
535 &self,
536 delegate: &dyn LspAdapterDelegate,
537 _: Option<Toolchain>,
538 _: &AsyncApp,
539 ) -> Option<LanguageServerBinary> {
540 let path = delegate.which(Self::SERVER_NAME.as_ref()).await?;
541 Some(LanguageServerBinary {
542 path,
543 env: None,
544 arguments: Default::default(),
545 })
546 }
547
548 async fn fetch_server_binary(
549 &self,
550 latest_version: GitHubLspBinaryVersion,
551 container_dir: PathBuf,
552 delegate: &dyn LspAdapterDelegate,
553 ) -> Result<LanguageServerBinary> {
554 let version = &latest_version;
555 let destination_path = container_dir.join(format!(
556 "{}-{}{}",
557 Self::SERVER_NAME,
558 version.name,
559 std::env::consts::EXE_SUFFIX
560 ));
561 let destination_container_path =
562 container_dir.join(format!("{}-{}-tmp", Self::SERVER_NAME, version.name));
563 if fs::metadata(&destination_path).await.is_err() {
564 let mut response = delegate
565 .http_client()
566 .get(&version.url, Default::default(), true)
567 .await
568 .context("downloading release")?;
569 if version.url.ends_with(".zip") {
570 extract_zip(&destination_container_path, response.body_mut()).await?;
571 } else if version.url.ends_with(".tar.gz") {
572 let decompressed_bytes = GzipDecoder::new(BufReader::new(response.body_mut()));
573 let archive = Archive::new(decompressed_bytes);
574 archive.unpack(&destination_container_path).await?;
575 }
576
577 fs::copy(
578 destination_container_path.join(format!(
579 "{}{}",
580 Self::SERVER_NAME,
581 std::env::consts::EXE_SUFFIX
582 )),
583 &destination_path,
584 )
585 .await?;
586 remove_matching(&container_dir, |entry| entry != destination_path).await;
587 }
588 Ok(LanguageServerBinary {
589 path: destination_path,
590 env: None,
591 arguments: Default::default(),
592 })
593 }
594
595 async fn cached_server_binary(
596 &self,
597 container_dir: PathBuf,
598 _delegate: &dyn LspAdapterDelegate,
599 ) -> Option<LanguageServerBinary> {
600 get_cached_version_server_binary(container_dir).await
601 }
602}
603
604#[async_trait(?Send)]
605impl LspAdapter for NodeVersionAdapter {
606 fn name(&self) -> LanguageServerName {
607 Self::SERVER_NAME
608 }
609}
610
611async fn get_cached_version_server_binary(container_dir: PathBuf) -> Option<LanguageServerBinary> {
612 maybe!(async {
613 let mut last = None;
614 let mut entries = fs::read_dir(&container_dir).await?;
615 while let Some(entry) = entries.next().await {
616 last = Some(entry?.path());
617 }
618
619 anyhow::Ok(LanguageServerBinary {
620 path: last.context("no cached binary")?,
621 env: None,
622 arguments: Default::default(),
623 })
624 })
625 .await
626 .log_err()
627}