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