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