1use anyhow::{anyhow, Result};
  2use async_compression::futures::bufread::GzipDecoder;
  3use async_tar::Archive;
  4use async_trait::async_trait;
  5use collections::HashMap;
  6use gpui::AsyncAppContext;
  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    async fn workspace_configuration(
249        self: Arc<Self>,
250        delegate: &Arc<dyn LspAdapterDelegate>,
251        cx: &mut AsyncAppContext,
252    ) -> Result<Value> {
253        let workspace_root = delegate.worktree_root_path();
254
255        let eslint_user_settings = cx.update(|cx| {
256            ProjectSettings::get_global(cx)
257                .lsp
258                .get(Self::SERVER_NAME)
259                .and_then(|s| s.settings.clone())
260                .unwrap_or_default()
261        })?;
262
263        let mut code_action_on_save = json!({
264            // We enable this, but without also configuring `code_actions_on_format`
265            // in the Zed configuration, it doesn't have an effect.
266            "enable": true,
267        });
268
269        if let Some(code_action_settings) = eslint_user_settings
270            .get("codeActionOnSave")
271            .and_then(|settings| settings.as_object())
272        {
273            if let Some(enable) = code_action_settings.get("enable") {
274                code_action_on_save["enable"] = enable.clone();
275            }
276            if let Some(mode) = code_action_settings.get("mode") {
277                code_action_on_save["mode"] = mode.clone();
278            }
279            if let Some(rules) = code_action_settings.get("rules") {
280                code_action_on_save["rules"] = rules.clone();
281            }
282        }
283
284        let problems = eslint_user_settings
285            .get("problems")
286            .cloned()
287            .unwrap_or_else(|| json!({}));
288
289        let rules_customizations = eslint_user_settings
290            .get("rulesCustomizations")
291            .cloned()
292            .unwrap_or_else(|| json!([]));
293
294        let node_path = eslint_user_settings.get("nodePath").unwrap_or(&Value::Null);
295        let use_flat_config = Self::FLAT_CONFIG_FILE_NAMES
296            .iter()
297            .any(|file| workspace_root.join(file).is_file());
298
299        Ok(json!({
300            "": {
301                "validate": "on",
302                "rulesCustomizations": rules_customizations,
303                "run": "onType",
304                "nodePath": node_path,
305                "workingDirectory": {"mode": "auto"},
306                "workspaceFolder": {
307                    "uri": workspace_root,
308                    "name": workspace_root.file_name()
309                        .unwrap_or_else(|| workspace_root.as_os_str()),
310                },
311                "problems": problems,
312                "codeActionOnSave": code_action_on_save,
313                "experimental": {
314                    "useFlatConfig": use_flat_config,
315                },
316            }
317        }))
318    }
319
320    fn name(&self) -> LanguageServerName {
321        LanguageServerName(Self::SERVER_NAME.into())
322    }
323
324    async fn fetch_latest_server_version(
325        &self,
326        _delegate: &dyn LspAdapterDelegate,
327    ) -> Result<Box<dyn 'static + Send + Any>> {
328        let url = build_tarball_url("microsoft/vscode-eslint", Self::CURRENT_VERSION)?;
329
330        Ok(Box::new(GitHubLspBinaryVersion {
331            name: Self::CURRENT_VERSION.into(),
332            url,
333        }))
334    }
335
336    async fn fetch_server_binary(
337        &self,
338        version: Box<dyn 'static + Send + Any>,
339        container_dir: PathBuf,
340        delegate: &dyn LspAdapterDelegate,
341    ) -> Result<LanguageServerBinary> {
342        let version = version.downcast::<GitHubLspBinaryVersion>().unwrap();
343        let destination_path = container_dir.join(format!("vscode-eslint-{}", version.name));
344        let server_path = destination_path.join(Self::SERVER_PATH);
345
346        if fs::metadata(&server_path).await.is_err() {
347            remove_matching(&container_dir, |entry| entry != destination_path).await;
348
349            let mut response = delegate
350                .http_client()
351                .get(&version.url, Default::default(), true)
352                .await
353                .map_err(|err| anyhow!("error downloading release: {}", err))?;
354            let decompressed_bytes = GzipDecoder::new(BufReader::new(response.body_mut()));
355            let archive = Archive::new(decompressed_bytes);
356            archive.unpack(&destination_path).await?;
357
358            let mut dir = fs::read_dir(&destination_path).await?;
359            let first = dir.next().await.ok_or(anyhow!("missing first file"))??;
360            let repo_root = destination_path.join("vscode-eslint");
361            fs::rename(first.path(), &repo_root).await?;
362
363            self.node
364                .run_npm_subcommand(Some(&repo_root), "install", &[])
365                .await?;
366
367            self.node
368                .run_npm_subcommand(Some(&repo_root), "run-script", &["compile"])
369                .await?;
370        }
371
372        Ok(LanguageServerBinary {
373            path: self.node.binary_path().await?,
374            env: None,
375            arguments: eslint_server_binary_arguments(&server_path),
376        })
377    }
378
379    async fn cached_server_binary(
380        &self,
381        container_dir: PathBuf,
382        _: &dyn LspAdapterDelegate,
383    ) -> Option<LanguageServerBinary> {
384        get_cached_eslint_server_binary(container_dir, &*self.node).await
385    }
386
387    async fn installation_test_binary(
388        &self,
389        container_dir: PathBuf,
390    ) -> Option<LanguageServerBinary> {
391        get_cached_eslint_server_binary(container_dir, &*self.node).await
392    }
393}
394
395async fn get_cached_eslint_server_binary(
396    container_dir: PathBuf,
397    node: &dyn NodeRuntime,
398) -> Option<LanguageServerBinary> {
399    maybe!(async {
400        // This is unfortunate but we don't know what the version is to build a path directly
401        let mut dir = fs::read_dir(&container_dir).await?;
402        let first = dir.next().await.ok_or(anyhow!("missing first file"))??;
403        if !first.file_type().await?.is_dir() {
404            return Err(anyhow!("First entry is not a directory"));
405        }
406        let server_path = first.path().join(EsLintLspAdapter::SERVER_PATH);
407
408        Ok(LanguageServerBinary {
409            path: node.binary_path().await?,
410            env: None,
411            arguments: eslint_server_binary_arguments(&server_path),
412        })
413    })
414    .await
415    .log_err()
416}
417
418#[cfg(test)]
419mod tests {
420    use gpui::{Context, TestAppContext};
421    use unindent::Unindent;
422
423    #[gpui::test]
424    async fn test_outline(cx: &mut TestAppContext) {
425        let language = crate::language("typescript", tree_sitter_typescript::language_typescript());
426
427        let text = r#"
428            function a() {
429              // local variables are omitted
430              let a1 = 1;
431              // all functions are included
432              async function a2() {}
433            }
434            // top-level variables are included
435            let b: C
436            function getB() {}
437            // exported variables are included
438            export const d = e;
439        "#
440        .unindent();
441
442        let buffer =
443            cx.new_model(|cx| language::Buffer::local(text, cx).with_language(language, cx));
444        let outline = buffer.update(cx, |buffer, _| buffer.snapshot().outline(None).unwrap());
445        assert_eq!(
446            outline
447                .items
448                .iter()
449                .map(|item| (item.text.as_str(), item.depth))
450                .collect::<Vec<_>>(),
451            &[
452                ("function a()", 0),
453                ("async function a2()", 1),
454                ("let b", 0),
455                ("function getB()", 0),
456                ("const d", 0),
457            ]
458        );
459    }
460}