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 = if let Some(description) = item
142            .label_details
143            .as_ref()
144            .and_then(|label_details| label_details.description.as_ref())
145        {
146            format!("{} {}", item.label, description)
147        } else if let Some(detail) = &item.detail {
148            format!("{} {}", item.label, detail)
149        } else {
150            item.label.clone()
151        };
152
153        Some(language::CodeLabel {
154            text,
155            runs: vec![(0..len, highlight_id)],
156            filter_range: 0..len,
157        })
158    }
159
160    async fn initialization_options(
161        self: Arc<Self>,
162        _: &Arc<dyn LspAdapterDelegate>,
163    ) -> Result<Option<serde_json::Value>> {
164        Ok(Some(json!({
165            "typescript":
166            {
167                "tsdk": "node_modules/typescript/lib",
168                "format": {
169                    "enable": true
170                },
171                "inlayHints":{
172                    "parameterNames":
173                    {
174                        "enabled": "all",
175                        "suppressWhenArgumentMatchesName": false,
176
177                    },
178
179                    "parameterTypes":
180                    {
181                        "enabled": true
182                    },
183                    "variableTypes": {
184                        "enabled": true,
185                        "suppressWhenTypeMatchesName": false,
186                    },
187                    "propertyDeclarationTypes":{
188                        "enabled": true,
189                    },
190                    "functionLikeReturnTypes": {
191                        "enabled": true,
192                    },
193                    "enumMemberValues":{
194                        "enabled": true,
195                    }
196                }
197            },
198            "vtsls":
199            {"experimental": {
200                "completion": {
201                    "enableServerSideFuzzyMatch": true,
202                    "entriesLimit": 5000,
203                }
204            }
205            }
206        })))
207    }
208
209    async fn workspace_configuration(
210        self: Arc<Self>,
211        _: &Arc<dyn LspAdapterDelegate>,
212        _cx: &mut AsyncAppContext,
213    ) -> Result<Value> {
214        Ok(json!({
215            "typescript": {
216                "suggest": {
217                    "completeFunctionCalls": true
218                },
219                "tsdk": "node_modules/typescript/lib",
220                "format": {
221                    "enable": true
222                },
223                "inlayHints":{
224                    "parameterNames":
225                    {
226                        "enabled": "all",
227                        "suppressWhenArgumentMatchesName": false,
228
229                    },
230
231                    "parameterTypes":
232                    {
233                        "enabled": true
234                    },
235                    "variableTypes": {
236                        "enabled": true,
237                        "suppressWhenTypeMatchesName": false,
238                    },
239                    "propertyDeclarationTypes":{
240                        "enabled": true,
241                    },
242                    "functionLikeReturnTypes": {
243                        "enabled": true,
244                    },
245                    "enumMemberValues":{
246                        "enabled": true,
247                    }
248            }
249            },
250            "vtsls":
251            {"experimental": {
252                "completion": {
253                    "enableServerSideFuzzyMatch": true,
254                    "entriesLimit": 5000,
255                }
256            }
257            }
258        }))
259    }
260
261    fn language_ids(&self) -> HashMap<String, String> {
262        HashMap::from_iter([
263            ("TypeScript".into(), "typescript".into()),
264            ("JavaScript".into(), "javascript".into()),
265            ("TSX".into(), "typescriptreact".into()),
266        ])
267    }
268}
269
270async fn get_cached_ts_server_binary(
271    container_dir: PathBuf,
272    node: &dyn NodeRuntime,
273) -> Option<LanguageServerBinary> {
274    maybe!(async {
275        let server_path = container_dir.join(VtslsLspAdapter::SERVER_PATH);
276        if server_path.exists() {
277            Ok(LanguageServerBinary {
278                path: node.binary_path().await?,
279                env: None,
280                arguments: typescript_server_binary_arguments(&server_path),
281            })
282        } else {
283            Err(anyhow!(
284                "missing executable in directory {:?}",
285                container_dir
286            ))
287        }
288    })
289    .await
290    .log_err()
291}