vtsls.rs

  1use anyhow::{anyhow, Result};
  2use async_trait::async_trait;
  3use collections::HashMap;
  4use gpui::AsyncAppContext;
  5use language::{LanguageServerName, LspAdapter, LspAdapterDelegate};
  6use lsp::{CodeActionKind, LanguageServerBinary};
  7use node_runtime::NodeRuntime;
  8use serde_json::{json, Value};
  9use std::{
 10    any::Any,
 11    ffi::OsString,
 12    path::{Path, PathBuf},
 13    sync::Arc,
 14};
 15use util::{maybe, ResultExt};
 16
 17fn typescript_server_binary_arguments(server_path: &Path) -> Vec<OsString> {
 18    vec![server_path.into(), "--stdio".into()]
 19}
 20
 21pub struct VtslsLspAdapter {
 22    node: Arc<dyn NodeRuntime>,
 23}
 24
 25impl VtslsLspAdapter {
 26    const SERVER_PATH: &'static str = "node_modules/@vtsls/language-server/bin/vtsls.js";
 27
 28    pub fn new(node: Arc<dyn NodeRuntime>) -> Self {
 29        VtslsLspAdapter { node }
 30    }
 31}
 32
 33struct TypeScriptVersions {
 34    typescript_version: String,
 35    server_version: String,
 36}
 37
 38#[async_trait(?Send)]
 39impl LspAdapter for VtslsLspAdapter {
 40    fn name(&self) -> LanguageServerName {
 41        LanguageServerName("vtsls".into())
 42    }
 43
 44    async fn fetch_latest_server_version(
 45        &self,
 46        _: &dyn LspAdapterDelegate,
 47    ) -> Result<Box<dyn 'static + Send + Any>> {
 48        Ok(Box::new(TypeScriptVersions {
 49            typescript_version: self.node.npm_package_latest_version("typescript").await?,
 50            server_version: self
 51                .node
 52                .npm_package_latest_version("@vtsls/language-server")
 53                .await?,
 54        }) as Box<_>)
 55    }
 56
 57    async fn fetch_server_binary(
 58        &self,
 59        latest_version: Box<dyn 'static + Send + Any>,
 60        container_dir: PathBuf,
 61        _: &dyn LspAdapterDelegate,
 62    ) -> Result<LanguageServerBinary> {
 63        let latest_version = latest_version.downcast::<TypeScriptVersions>().unwrap();
 64        let server_path = container_dir.join(Self::SERVER_PATH);
 65        let package_name = "typescript";
 66
 67        let should_install_language_server = self
 68            .node
 69            .should_install_npm_package(
 70                package_name,
 71                &server_path,
 72                &container_dir,
 73                latest_version.typescript_version.as_str(),
 74            )
 75            .await;
 76
 77        if should_install_language_server {
 78            self.node
 79                .npm_install_packages(
 80                    &container_dir,
 81                    &[
 82                        (package_name, latest_version.typescript_version.as_str()),
 83                        (
 84                            "@vtsls/language-server",
 85                            latest_version.server_version.as_str(),
 86                        ),
 87                    ],
 88                )
 89                .await?;
 90        }
 91
 92        Ok(LanguageServerBinary {
 93            path: self.node.binary_path().await?,
 94            env: None,
 95            arguments: typescript_server_binary_arguments(&server_path),
 96        })
 97    }
 98
 99    async fn cached_server_binary(
100        &self,
101        container_dir: PathBuf,
102        _: &dyn LspAdapterDelegate,
103    ) -> Option<LanguageServerBinary> {
104        get_cached_ts_server_binary(container_dir, &*self.node).await
105    }
106
107    async fn installation_test_binary(
108        &self,
109        container_dir: PathBuf,
110    ) -> Option<LanguageServerBinary> {
111        get_cached_ts_server_binary(container_dir, &*self.node).await
112    }
113
114    fn code_action_kinds(&self) -> Option<Vec<CodeActionKind>> {
115        Some(vec![
116            CodeActionKind::QUICKFIX,
117            CodeActionKind::REFACTOR,
118            CodeActionKind::REFACTOR_EXTRACT,
119            CodeActionKind::SOURCE,
120        ])
121    }
122
123    async fn label_for_completion(
124        &self,
125        item: &lsp::CompletionItem,
126        language: &Arc<language::Language>,
127    ) -> Option<language::CodeLabel> {
128        use lsp::CompletionItemKind as Kind;
129        let len = item.label.len();
130        let grammar = language.grammar()?;
131        let highlight_id = match item.kind? {
132            Kind::CLASS | Kind::INTERFACE | Kind::ENUM => grammar.highlight_id_for_name("type"),
133            Kind::CONSTRUCTOR => grammar.highlight_id_for_name("type"),
134            Kind::CONSTANT => grammar.highlight_id_for_name("constant"),
135            Kind::FUNCTION | Kind::METHOD => grammar.highlight_id_for_name("function"),
136            Kind::PROPERTY | Kind::FIELD => grammar.highlight_id_for_name("property"),
137            Kind::VARIABLE => grammar.highlight_id_for_name("variable"),
138            _ => None,
139        }?;
140
141        let text = match &item.detail {
142            Some(detail) => format!("{} {}", item.label, detail),
143            None => item.label.clone(),
144        };
145
146        Some(language::CodeLabel {
147            text,
148            runs: vec![(0..len, highlight_id)],
149            filter_range: 0..len,
150        })
151    }
152
153    async fn initialization_options(
154        self: Arc<Self>,
155        _: &Arc<dyn LspAdapterDelegate>,
156    ) -> Result<Option<serde_json::Value>> {
157        Ok(Some(json!({
158            "typescript":
159            {
160                "tsdk": "node_modules/typescript/lib",
161                "format": {
162                    "enable": true
163                },
164                "inlayHints":{
165                    "parameterNames":
166                    {
167                        "enabled": "all",
168                        "suppressWhenArgumentMatchesName": false,
169
170                    }
171                    },
172                    "parameterTypes":
173                    {
174                        "enabled": true
175                    },
176                    "variableTypes": {
177                        "enabled": true,
178                        "suppressWhenTypeMatchesName": false,
179                    },
180                    "propertyDeclarationTypes":{
181                        "enabled": true,
182                    },
183                    "functionLikeReturnTypes": {
184                        "enabled": true,
185                    },
186                    "enumMemberValues":{
187                        "enabled": true,
188                    }
189            }
190        })))
191    }
192
193    async fn workspace_configuration(
194        self: Arc<Self>,
195        _: &Arc<dyn LspAdapterDelegate>,
196        _cx: &mut AsyncAppContext,
197    ) -> Result<Value> {
198        Ok(json!({
199            "typescript": {
200                "suggest": {
201                    "completeFunctionCalls": true
202                }
203            }
204        }))
205    }
206
207    fn language_ids(&self) -> HashMap<String, String> {
208        HashMap::from_iter([
209            ("TypeScript".into(), "typescript".into()),
210            ("JavaScript".into(), "javascript".into()),
211            ("TSX".into(), "typescriptreact".into()),
212        ])
213    }
214}
215
216async fn get_cached_ts_server_binary(
217    container_dir: PathBuf,
218    node: &dyn NodeRuntime,
219) -> Option<LanguageServerBinary> {
220    maybe!(async {
221        let server_path = container_dir.join(VtslsLspAdapter::SERVER_PATH);
222        if server_path.exists() {
223            Ok(LanguageServerBinary {
224                path: node.binary_path().await?,
225                env: None,
226                arguments: typescript_server_binary_arguments(&server_path),
227            })
228        } else {
229            Err(anyhow!(
230                "missing executable in directory {:?}",
231                container_dir
232            ))
233        }
234    })
235    .await
236    .log_err()
237}