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 themes = ThemeRegistry::try_global(cx);
161 let theme_names = &themes.clone().map(|t| t.list_names()).unwrap_or_default();
162 let icon_theme_names = &themes
163 .map(|t| {
164 t.list_icon_themes()
165 .into_iter()
166 .map(|icon_theme| icon_theme.name)
167 .collect::<Vec<SharedString>>()
168 })
169 .unwrap_or_default();
170 let settings_schema = cx
171 .global::<SettingsStore>()
172 .json_schema(&SettingsJsonSchemaParams {
173 language_names: &language_names,
174 font_names,
175 theme_names,
176 icon_theme_names,
177 });
178
179 let tasks_schema = task::TaskTemplates::generate_json_schema();
180 let debug_schema = task::DebugTaskFile::generate_json_schema(&adapter_schemas);
181 let snippets_schema = snippet_provider::format::VsSnippetsFile::generate_json_schema();
182 let tsconfig_schema = serde_json::Value::from_str(TSCONFIG_SCHEMA).unwrap();
183 let package_json_schema = serde_json::Value::from_str(PACKAGE_JSON_SCHEMA).unwrap();
184
185 #[allow(unused_mut)]
186 let mut schemas = serde_json::json!([
187 {
188 "fileMatch": ["tsconfig*.json"],
189 "schema":tsconfig_schema
190 },
191 {
192 "fileMatch": ["package.json"],
193 "schema":package_json_schema
194 },
195 {
196 "fileMatch": [
197 schema_file_match(paths::settings_file()),
198 paths::local_settings_file_relative_path()
199 ],
200 "schema": settings_schema,
201 },
202 {
203 "fileMatch": [schema_file_match(paths::keymap_file())],
204 "schema": keymap_schema,
205 },
206 {
207 "fileMatch": [
208 schema_file_match(paths::tasks_file()),
209 paths::local_tasks_file_relative_path()
210 ],
211 "schema": tasks_schema,
212 },
213 {
214 "fileMatch": [
215 schema_file_match(
216 paths::snippets_dir()
217 .join("*.json")
218 .as_path()
219 )
220 ],
221 "schema": snippets_schema,
222 },
223 {
224 "fileMatch": [
225 schema_file_match(paths::debug_scenarios_file()),
226 paths::local_debug_file_relative_path()
227 ],
228 "schema": debug_schema,
229 },
230 ]);
231
232 #[cfg(debug_assertions)]
233 {
234 schemas.as_array_mut().unwrap().push(serde_json::json!(
235 {
236 "fileMatch": [
237 "zed-inspector-style.json"
238 ],
239 "schema": generate_inspector_style_schema(),
240 }
241 ))
242 }
243
244 schemas
245 .as_array_mut()
246 .unwrap()
247 .extend(cx.all_action_names().iter().map(|&name| {
248 project::lsp_store::json_language_server_ext::url_schema_for_action(name)
249 }));
250
251 // This can be viewed via `dev: open language server logs` -> `json-language-server` ->
252 // `Server Info`
253 serde_json::json!({
254 "json": {
255 "format": {
256 "enable": true,
257 },
258 "validate":
259 {
260 "enable": true,
261 },
262 "schemas": schemas
263 }
264 })
265 }
266
267 async fn get_or_init_workspace_config(&self, cx: &mut AsyncApp) -> Result<Value> {
268 {
269 let reader = self.workspace_config.read().await;
270 if let Some(config) = reader.as_ref() {
271 return Ok(config.clone());
272 }
273 }
274 let mut writer = self.workspace_config.write().await;
275
276 let adapter_schemas = cx
277 .read_global::<DapRegistry, _>(|dap_registry, _| dap_registry.to_owned())?
278 .adapters_schema()
279 .await;
280
281 let config = cx.update(|cx| {
282 Self::get_workspace_config(
283 self.languages
284 .language_names()
285 .into_iter()
286 .map(|name| name.to_string())
287 .collect(),
288 adapter_schemas,
289 cx,
290 )
291 })?;
292 writer.replace(config.clone());
293 Ok(config)
294 }
295}
296
297#[cfg(debug_assertions)]
298fn generate_inspector_style_schema() -> serde_json_lenient::Value {
299 let schema = schemars::generate::SchemaSettings::draft2019_09()
300 .with_transform(util::schemars::DefaultDenyUnknownFields)
301 .into_generator()
302 .root_schema_for::<gpui::StyleRefinement>();
303
304 serde_json_lenient::to_value(schema).unwrap()
305}
306
307impl LspInstaller for JsonLspAdapter {
308 type BinaryVersion = String;
309
310 async fn fetch_latest_server_version(
311 &self,
312 _: &dyn LspAdapterDelegate,
313 _: bool,
314 _: &mut AsyncApp,
315 ) -> Result<String> {
316 self.node
317 .npm_package_latest_version(Self::PACKAGE_NAME)
318 .await
319 }
320
321 async fn check_if_user_installed(
322 &self,
323 delegate: &dyn LspAdapterDelegate,
324 _: Option<Toolchain>,
325 _: &AsyncApp,
326 ) -> Option<LanguageServerBinary> {
327 let path = delegate
328 .which("vscode-json-language-server".as_ref())
329 .await?;
330 let env = delegate.shell_env().await;
331
332 Some(LanguageServerBinary {
333 path,
334 env: Some(env),
335 arguments: vec!["--stdio".into()],
336 })
337 }
338
339 async fn check_if_version_installed(
340 &self,
341 version: &String,
342 container_dir: &PathBuf,
343 _: &dyn LspAdapterDelegate,
344 ) -> Option<LanguageServerBinary> {
345 let server_path = container_dir.join(SERVER_PATH);
346
347 let should_install_language_server = self
348 .node
349 .should_install_npm_package(
350 Self::PACKAGE_NAME,
351 &server_path,
352 container_dir,
353 VersionStrategy::Latest(version),
354 )
355 .await;
356
357 if should_install_language_server {
358 None
359 } else {
360 Some(LanguageServerBinary {
361 path: self.node.binary_path().await.ok()?,
362 env: None,
363 arguments: server_binary_arguments(&server_path),
364 })
365 }
366 }
367
368 async fn fetch_server_binary(
369 &self,
370 latest_version: String,
371 container_dir: PathBuf,
372 _: &dyn LspAdapterDelegate,
373 ) -> Result<LanguageServerBinary> {
374 let server_path = container_dir.join(SERVER_PATH);
375
376 self.node
377 .npm_install_packages(
378 &container_dir,
379 &[(Self::PACKAGE_NAME, latest_version.as_str())],
380 )
381 .await?;
382
383 Ok(LanguageServerBinary {
384 path: self.node.binary_path().await?,
385 env: None,
386 arguments: server_binary_arguments(&server_path),
387 })
388 }
389
390 async fn cached_server_binary(
391 &self,
392 container_dir: PathBuf,
393 _: &dyn LspAdapterDelegate,
394 ) -> Option<LanguageServerBinary> {
395 get_cached_server_binary(container_dir, &self.node).await
396 }
397}
398
399#[async_trait(?Send)]
400impl LspAdapter for JsonLspAdapter {
401 fn name(&self) -> LanguageServerName {
402 LanguageServerName("json-language-server".into())
403 }
404
405 async fn initialization_options(
406 self: Arc<Self>,
407 _: &Arc<dyn LspAdapterDelegate>,
408 ) -> Result<Option<serde_json::Value>> {
409 Ok(Some(json!({
410 "provideFormatter": true
411 })))
412 }
413
414 async fn workspace_configuration(
415 self: Arc<Self>,
416 delegate: &Arc<dyn LspAdapterDelegate>,
417 _: Option<Toolchain>,
418 cx: &mut AsyncApp,
419 ) -> Result<Value> {
420 let mut config = self.get_or_init_workspace_config(cx).await?;
421
422 let project_options = cx.update(|cx| {
423 language_server_settings(delegate.as_ref(), &self.name(), cx)
424 .and_then(|s| s.settings.clone())
425 })?;
426
427 if let Some(override_options) = project_options {
428 merge_json_value_into(override_options, &mut config);
429 }
430
431 Ok(config)
432 }
433
434 fn language_ids(&self) -> HashMap<LanguageName, String> {
435 [
436 (LanguageName::new("JSON"), "json".into()),
437 (LanguageName::new("JSONC"), "jsonc".into()),
438 ]
439 .into_iter()
440 .collect()
441 }
442
443 fn is_primary_zed_json_schema_adapter(&self) -> bool {
444 true
445 }
446
447 async fn clear_zed_json_schema_cache(&self) {
448 self.workspace_config.write().await.take();
449 }
450}
451
452async fn get_cached_server_binary(
453 container_dir: PathBuf,
454 node: &NodeRuntime,
455) -> Option<LanguageServerBinary> {
456 maybe!(async {
457 let mut last_version_dir = None;
458 let mut entries = fs::read_dir(&container_dir).await?;
459 while let Some(entry) = entries.next().await {
460 let entry = entry?;
461 if entry.file_type().await?.is_dir() {
462 last_version_dir = Some(entry.path());
463 }
464 }
465
466 let last_version_dir = last_version_dir.context("no cached binary")?;
467 let server_path = last_version_dir.join(SERVER_PATH);
468 anyhow::ensure!(
469 server_path.exists(),
470 "missing executable in directory {last_version_dir:?}"
471 );
472 Ok(LanguageServerBinary {
473 path: node.binary_path().await?,
474 env: None,
475 arguments: server_binary_arguments(&server_path),
476 })
477 })
478 .await
479 .log_err()
480}
481
482#[inline]
483fn schema_file_match(path: &Path) -> String {
484 path.strip_prefix(path.parent().unwrap().parent().unwrap())
485 .unwrap()
486 .display()
487 .to_string()
488 .replace('\\', "/")
489}
490
491pub struct NodeVersionAdapter;
492
493impl NodeVersionAdapter {
494 const SERVER_NAME: LanguageServerName =
495 LanguageServerName::new_static("package-version-server");
496}
497
498impl LspInstaller for NodeVersionAdapter {
499 type BinaryVersion = GitHubLspBinaryVersion;
500
501 async fn fetch_latest_server_version(
502 &self,
503 delegate: &dyn LspAdapterDelegate,
504 _: bool,
505 _: &mut AsyncApp,
506 ) -> Result<GitHubLspBinaryVersion> {
507 let release = latest_github_release(
508 "zed-industries/package-version-server",
509 true,
510 false,
511 delegate.http_client(),
512 )
513 .await?;
514 let os = match consts::OS {
515 "macos" => "apple-darwin",
516 "linux" => "unknown-linux-gnu",
517 "windows" => "pc-windows-msvc",
518 other => bail!("Running on unsupported os: {other}"),
519 };
520 let suffix = if consts::OS == "windows" {
521 ".zip"
522 } else {
523 ".tar.gz"
524 };
525 let asset_name = format!("{}-{}-{os}{suffix}", Self::SERVER_NAME, consts::ARCH);
526 let asset = release
527 .assets
528 .iter()
529 .find(|asset| asset.name == asset_name)
530 .with_context(|| format!("no asset found matching `{asset_name:?}`"))?;
531 Ok(GitHubLspBinaryVersion {
532 name: release.tag_name,
533 url: asset.browser_download_url.clone(),
534 digest: asset.digest.clone(),
535 })
536 }
537
538 async fn check_if_user_installed(
539 &self,
540 delegate: &dyn LspAdapterDelegate,
541 _: Option<Toolchain>,
542 _: &AsyncApp,
543 ) -> Option<LanguageServerBinary> {
544 let path = delegate.which(Self::SERVER_NAME.as_ref()).await?;
545 Some(LanguageServerBinary {
546 path,
547 env: None,
548 arguments: Default::default(),
549 })
550 }
551
552 async fn fetch_server_binary(
553 &self,
554 latest_version: GitHubLspBinaryVersion,
555 container_dir: PathBuf,
556 delegate: &dyn LspAdapterDelegate,
557 ) -> Result<LanguageServerBinary> {
558 let version = &latest_version;
559 let destination_path = container_dir.join(format!(
560 "{}-{}{}",
561 Self::SERVER_NAME,
562 version.name,
563 std::env::consts::EXE_SUFFIX
564 ));
565 let destination_container_path =
566 container_dir.join(format!("{}-{}-tmp", Self::SERVER_NAME, version.name));
567 if fs::metadata(&destination_path).await.is_err() {
568 let mut response = delegate
569 .http_client()
570 .get(&version.url, Default::default(), true)
571 .await
572 .context("downloading release")?;
573 if version.url.ends_with(".zip") {
574 extract_zip(&destination_container_path, response.body_mut()).await?;
575 } else if version.url.ends_with(".tar.gz") {
576 let decompressed_bytes = GzipDecoder::new(BufReader::new(response.body_mut()));
577 let archive = Archive::new(decompressed_bytes);
578 archive.unpack(&destination_container_path).await?;
579 }
580
581 fs::copy(
582 destination_container_path.join(format!(
583 "{}{}",
584 Self::SERVER_NAME,
585 std::env::consts::EXE_SUFFIX
586 )),
587 &destination_path,
588 )
589 .await?;
590 remove_matching(&container_dir, |entry| entry != destination_path).await;
591 }
592 Ok(LanguageServerBinary {
593 path: destination_path,
594 env: None,
595 arguments: Default::default(),
596 })
597 }
598
599 async fn cached_server_binary(
600 &self,
601 container_dir: PathBuf,
602 _delegate: &dyn LspAdapterDelegate,
603 ) -> Option<LanguageServerBinary> {
604 get_cached_version_server_binary(container_dir).await
605 }
606}
607
608#[async_trait(?Send)]
609impl LspAdapter for NodeVersionAdapter {
610 fn name(&self) -> LanguageServerName {
611 Self::SERVER_NAME
612 }
613}
614
615async fn get_cached_version_server_binary(container_dir: PathBuf) -> Option<LanguageServerBinary> {
616 maybe!(async {
617 let mut last = None;
618 let mut entries = fs::read_dir(&container_dir).await?;
619 while let Some(entry) = entries.next().await {
620 last = Some(entry?.path());
621 }
622
623 anyhow::Ok(LanguageServerBinary {
624 path: last.context("no cached binary")?,
625 env: None,
626 arguments: Default::default(),
627 })
628 })
629 .await
630 .log_err()
631}