1use anyhow::{anyhow, Result};
2use async_compression::futures::bufread::GzipDecoder;
3use async_tar::Archive;
4use async_trait::async_trait;
5use collections::HashMap;
6use gpui::AppContext;
7use language::{LanguageServerName, LspAdapter, LspAdapterDelegate};
8use lsp::{CodeActionKind, LanguageServerBinary};
9use node_runtime::NodeRuntime;
10use project::project_settings::ProjectSettings;
11use serde_json::{json, Value};
12use settings::Settings;
13use smol::{fs, io::BufReader, stream::StreamExt};
14use std::{
15 any::Any,
16 ffi::OsString,
17 path::{Path, PathBuf},
18 sync::Arc,
19};
20use util::{
21 fs::remove_matching,
22 github::{build_tarball_url, GitHubLspBinaryVersion},
23 maybe, ResultExt,
24};
25
26fn typescript_server_binary_arguments(server_path: &Path) -> Vec<OsString> {
27 vec![server_path.into(), "--stdio".into()]
28}
29
30fn eslint_server_binary_arguments(server_path: &Path) -> Vec<OsString> {
31 vec![server_path.into(), "--stdio".into()]
32}
33
34pub struct TypeScriptLspAdapter {
35 node: Arc<dyn NodeRuntime>,
36}
37
38impl TypeScriptLspAdapter {
39 const OLD_SERVER_PATH: &'static str = "node_modules/typescript-language-server/lib/cli.js";
40 const NEW_SERVER_PATH: &'static str = "node_modules/typescript-language-server/lib/cli.mjs";
41
42 pub fn new(node: Arc<dyn NodeRuntime>) -> Self {
43 TypeScriptLspAdapter { node }
44 }
45}
46
47struct TypeScriptVersions {
48 typescript_version: String,
49 server_version: String,
50}
51
52#[async_trait(?Send)]
53impl LspAdapter for TypeScriptLspAdapter {
54 fn name(&self) -> LanguageServerName {
55 LanguageServerName("typescript-language-server".into())
56 }
57
58 async fn fetch_latest_server_version(
59 &self,
60 _: &dyn LspAdapterDelegate,
61 ) -> Result<Box<dyn 'static + Send + Any>> {
62 Ok(Box::new(TypeScriptVersions {
63 typescript_version: self.node.npm_package_latest_version("typescript").await?,
64 server_version: self
65 .node
66 .npm_package_latest_version("typescript-language-server")
67 .await?,
68 }) as Box<_>)
69 }
70
71 async fn fetch_server_binary(
72 &self,
73 latest_version: Box<dyn 'static + Send + Any>,
74 container_dir: PathBuf,
75 _: &dyn LspAdapterDelegate,
76 ) -> Result<LanguageServerBinary> {
77 let latest_version = latest_version.downcast::<TypeScriptVersions>().unwrap();
78 let server_path = container_dir.join(Self::NEW_SERVER_PATH);
79 let package_name = "typescript";
80
81 let should_install_language_server = self
82 .node
83 .should_install_npm_package(
84 package_name,
85 &server_path,
86 &container_dir,
87 latest_version.typescript_version.as_str(),
88 )
89 .await;
90
91 if should_install_language_server {
92 self.node
93 .npm_install_packages(
94 &container_dir,
95 &[
96 (package_name, latest_version.typescript_version.as_str()),
97 (
98 "typescript-language-server",
99 latest_version.server_version.as_str(),
100 ),
101 ],
102 )
103 .await?;
104 }
105
106 Ok(LanguageServerBinary {
107 path: self.node.binary_path().await?,
108 env: None,
109 arguments: typescript_server_binary_arguments(&server_path),
110 })
111 }
112
113 async fn cached_server_binary(
114 &self,
115 container_dir: PathBuf,
116 _: &dyn LspAdapterDelegate,
117 ) -> Option<LanguageServerBinary> {
118 get_cached_ts_server_binary(container_dir, &*self.node).await
119 }
120
121 async fn installation_test_binary(
122 &self,
123 container_dir: PathBuf,
124 ) -> Option<LanguageServerBinary> {
125 get_cached_ts_server_binary(container_dir, &*self.node).await
126 }
127
128 fn code_action_kinds(&self) -> Option<Vec<CodeActionKind>> {
129 Some(vec![
130 CodeActionKind::QUICKFIX,
131 CodeActionKind::REFACTOR,
132 CodeActionKind::REFACTOR_EXTRACT,
133 CodeActionKind::SOURCE,
134 ])
135 }
136
137 async fn label_for_completion(
138 &self,
139 item: &lsp::CompletionItem,
140 language: &Arc<language::Language>,
141 ) -> Option<language::CodeLabel> {
142 use lsp::CompletionItemKind as Kind;
143 let len = item.label.len();
144 let grammar = language.grammar()?;
145 let highlight_id = match item.kind? {
146 Kind::CLASS | Kind::INTERFACE | Kind::ENUM => grammar.highlight_id_for_name("type"),
147 Kind::CONSTRUCTOR => grammar.highlight_id_for_name("type"),
148 Kind::CONSTANT => grammar.highlight_id_for_name("constant"),
149 Kind::FUNCTION | Kind::METHOD => grammar.highlight_id_for_name("function"),
150 Kind::PROPERTY | Kind::FIELD => grammar.highlight_id_for_name("property"),
151 Kind::VARIABLE => grammar.highlight_id_for_name("variable"),
152 _ => None,
153 }?;
154
155 let text = match &item.detail {
156 Some(detail) => format!("{} {}", item.label, detail),
157 None => item.label.clone(),
158 };
159
160 Some(language::CodeLabel {
161 text,
162 runs: vec![(0..len, highlight_id)],
163 filter_range: 0..len,
164 })
165 }
166
167 async fn initialization_options(
168 self: Arc<Self>,
169 _: &Arc<dyn LspAdapterDelegate>,
170 ) -> Result<Option<serde_json::Value>> {
171 Ok(Some(json!({
172 "provideFormatter": true,
173 "tsserver": {
174 "path": "node_modules/typescript/lib",
175 },
176 "preferences": {
177 "includeInlayParameterNameHints": "all",
178 "includeInlayParameterNameHintsWhenArgumentMatchesName": true,
179 "includeInlayFunctionParameterTypeHints": true,
180 "includeInlayVariableTypeHints": true,
181 "includeInlayVariableTypeHintsWhenTypeMatchesName": true,
182 "includeInlayPropertyDeclarationTypeHints": true,
183 "includeInlayFunctionLikeReturnTypeHints": true,
184 "includeInlayEnumMemberValueHints": true,
185 }
186 })))
187 }
188
189 fn language_ids(&self) -> HashMap<String, String> {
190 HashMap::from_iter([
191 ("TypeScript".into(), "typescript".into()),
192 ("JavaScript".into(), "javascript".into()),
193 ("TSX".into(), "typescriptreact".into()),
194 ])
195 }
196}
197
198async fn get_cached_ts_server_binary(
199 container_dir: PathBuf,
200 node: &dyn NodeRuntime,
201) -> Option<LanguageServerBinary> {
202 maybe!(async {
203 let old_server_path = container_dir.join(TypeScriptLspAdapter::OLD_SERVER_PATH);
204 let new_server_path = container_dir.join(TypeScriptLspAdapter::NEW_SERVER_PATH);
205 if new_server_path.exists() {
206 Ok(LanguageServerBinary {
207 path: node.binary_path().await?,
208 env: None,
209 arguments: typescript_server_binary_arguments(&new_server_path),
210 })
211 } else if old_server_path.exists() {
212 Ok(LanguageServerBinary {
213 path: node.binary_path().await?,
214 env: None,
215 arguments: typescript_server_binary_arguments(&old_server_path),
216 })
217 } else {
218 Err(anyhow!(
219 "missing executable in directory {:?}",
220 container_dir
221 ))
222 }
223 })
224 .await
225 .log_err()
226}
227
228pub struct EsLintLspAdapter {
229 node: Arc<dyn NodeRuntime>,
230}
231
232impl EsLintLspAdapter {
233 const CURRENT_VERSION: &'static str = "release/2.4.4";
234
235 const SERVER_PATH: &'static str = "vscode-eslint/server/out/eslintServer.js";
236 const SERVER_NAME: &'static str = "eslint";
237
238 const FLAT_CONFIG_FILE_NAMES: &'static [&'static str] =
239 &["eslint.config.js", "eslint.config.mjs", "eslint.config.cjs"];
240
241 pub fn new(node: Arc<dyn NodeRuntime>) -> Self {
242 EsLintLspAdapter { node }
243 }
244}
245
246#[async_trait(?Send)]
247impl LspAdapter for EsLintLspAdapter {
248 fn workspace_configuration(&self, workspace_root: &Path, cx: &mut AppContext) -> Value {
249 let eslint_user_settings = ProjectSettings::get_global(cx)
250 .lsp
251 .get(Self::SERVER_NAME)
252 .and_then(|s| s.settings.clone())
253 .unwrap_or_default();
254
255 let mut code_action_on_save = json!({
256 // We enable this, but without also configuring `code_actions_on_format`
257 // in the Zed configuration, it doesn't have an effect.
258 "enable": true,
259 });
260
261 if let Some(code_action_settings) = eslint_user_settings
262 .get("codeActionOnSave")
263 .and_then(|settings| settings.as_object())
264 {
265 if let Some(enable) = code_action_settings.get("enable") {
266 code_action_on_save["enable"] = enable.clone();
267 }
268 if let Some(mode) = code_action_settings.get("mode") {
269 code_action_on_save["mode"] = mode.clone();
270 }
271 if let Some(rules) = code_action_settings.get("rules") {
272 code_action_on_save["rules"] = rules.clone();
273 }
274 }
275
276 let node_path = eslint_user_settings.get("nodePath").unwrap_or(&Value::Null);
277 let use_flat_config = Self::FLAT_CONFIG_FILE_NAMES
278 .iter()
279 .any(|file| workspace_root.join(file).is_file());
280
281 json!({
282 "": {
283 "validate": "on",
284 "rulesCustomizations": [],
285 "run": "onType",
286 "nodePath": node_path,
287 "workingDirectory": {"mode": "auto"},
288 "workspaceFolder": {
289 "uri": workspace_root,
290 "name": workspace_root.file_name()
291 .unwrap_or_else(|| workspace_root.as_os_str()),
292 },
293 "problems": {},
294 "codeActionOnSave": code_action_on_save,
295 "experimental": {
296 "useFlatConfig": use_flat_config,
297 },
298 }
299 })
300 }
301
302 fn name(&self) -> LanguageServerName {
303 LanguageServerName(Self::SERVER_NAME.into())
304 }
305
306 async fn fetch_latest_server_version(
307 &self,
308 _delegate: &dyn LspAdapterDelegate,
309 ) -> Result<Box<dyn 'static + Send + Any>> {
310 let url = build_tarball_url("microsoft/vscode-eslint", Self::CURRENT_VERSION)?;
311
312 Ok(Box::new(GitHubLspBinaryVersion {
313 name: Self::CURRENT_VERSION.into(),
314 url,
315 }))
316 }
317
318 async fn fetch_server_binary(
319 &self,
320 version: Box<dyn 'static + Send + Any>,
321 container_dir: PathBuf,
322 delegate: &dyn LspAdapterDelegate,
323 ) -> Result<LanguageServerBinary> {
324 let version = version.downcast::<GitHubLspBinaryVersion>().unwrap();
325 let destination_path = container_dir.join(format!("vscode-eslint-{}", version.name));
326 let server_path = destination_path.join(Self::SERVER_PATH);
327
328 if fs::metadata(&server_path).await.is_err() {
329 remove_matching(&container_dir, |entry| entry != destination_path).await;
330
331 let mut response = delegate
332 .http_client()
333 .get(&version.url, Default::default(), true)
334 .await
335 .map_err(|err| anyhow!("error downloading release: {}", err))?;
336 let decompressed_bytes = GzipDecoder::new(BufReader::new(response.body_mut()));
337 let archive = Archive::new(decompressed_bytes);
338 archive.unpack(&destination_path).await?;
339
340 let mut dir = fs::read_dir(&destination_path).await?;
341 let first = dir.next().await.ok_or(anyhow!("missing first file"))??;
342 let repo_root = destination_path.join("vscode-eslint");
343 fs::rename(first.path(), &repo_root).await?;
344
345 self.node
346 .run_npm_subcommand(Some(&repo_root), "install", &[])
347 .await?;
348
349 self.node
350 .run_npm_subcommand(Some(&repo_root), "run-script", &["compile"])
351 .await?;
352 }
353
354 Ok(LanguageServerBinary {
355 path: self.node.binary_path().await?,
356 env: None,
357 arguments: eslint_server_binary_arguments(&server_path),
358 })
359 }
360
361 async fn cached_server_binary(
362 &self,
363 container_dir: PathBuf,
364 _: &dyn LspAdapterDelegate,
365 ) -> Option<LanguageServerBinary> {
366 get_cached_eslint_server_binary(container_dir, &*self.node).await
367 }
368
369 async fn installation_test_binary(
370 &self,
371 container_dir: PathBuf,
372 ) -> Option<LanguageServerBinary> {
373 get_cached_eslint_server_binary(container_dir, &*self.node).await
374 }
375}
376
377async fn get_cached_eslint_server_binary(
378 container_dir: PathBuf,
379 node: &dyn NodeRuntime,
380) -> Option<LanguageServerBinary> {
381 maybe!(async {
382 // This is unfortunate but we don't know what the version is to build a path directly
383 let mut dir = fs::read_dir(&container_dir).await?;
384 let first = dir.next().await.ok_or(anyhow!("missing first file"))??;
385 if !first.file_type().await?.is_dir() {
386 return Err(anyhow!("First entry is not a directory"));
387 }
388 let server_path = first.path().join(EsLintLspAdapter::SERVER_PATH);
389
390 Ok(LanguageServerBinary {
391 path: node.binary_path().await?,
392 env: None,
393 arguments: eslint_server_binary_arguments(&server_path),
394 })
395 })
396 .await
397 .log_err()
398}
399
400#[cfg(test)]
401mod tests {
402 use gpui::{Context, TestAppContext};
403 use text::BufferId;
404 use unindent::Unindent;
405
406 #[gpui::test]
407 async fn test_outline(cx: &mut TestAppContext) {
408 let language = crate::language("typescript", tree_sitter_typescript::language_typescript());
409
410 let text = r#"
411 function a() {
412 // local variables are omitted
413 let a1 = 1;
414 // all functions are included
415 async function a2() {}
416 }
417 // top-level variables are included
418 let b: C
419 function getB() {}
420 // exported variables are included
421 export const d = e;
422 "#
423 .unindent();
424
425 let buffer = cx.new_model(|cx| {
426 language::Buffer::new(0, BufferId::new(cx.entity_id().as_u64()).unwrap(), text)
427 .with_language(language, cx)
428 });
429 let outline = buffer.update(cx, |buffer, _| buffer.snapshot().outline(None).unwrap());
430 assert_eq!(
431 outline
432 .items
433 .iter()
434 .map(|item| (item.text.as_str(), item.depth))
435 .collect::<Vec<_>>(),
436 &[
437 ("function a()", 0),
438 ("async function a2()", 1),
439 ("let b", 0),
440 ("function getB()", 0),
441 ("const d", 0),
442 ]
443 );
444 }
445}