1use anyhow::{anyhow, Result};
2use async_trait::async_trait;
3use collections::HashMap;
4use gpui::AsyncAppContext;
5use language::{LanguageServerName, LanguageToolchainStore, LspAdapter, LspAdapterDelegate};
6use lsp::{CodeActionKind, LanguageServerBinary};
7use node_runtime::NodeRuntime;
8use project::lsp_store::language_server_settings;
9use serde_json::Value;
10use std::{
11 any::Any,
12 ffi::OsString,
13 path::{Path, PathBuf},
14 sync::Arc,
15};
16use util::{maybe, merge_json_value_into, ResultExt};
17
18fn typescript_server_binary_arguments(server_path: &Path) -> Vec<OsString> {
19 vec![server_path.into(), "--stdio".into()]
20}
21
22pub struct VtslsLspAdapter {
23 node: NodeRuntime,
24}
25
26impl VtslsLspAdapter {
27 const PACKAGE_NAME: &'static str = "@vtsls/language-server";
28 const SERVER_PATH: &'static str = "node_modules/@vtsls/language-server/bin/vtsls.js";
29
30 const TYPESCRIPT_PACKAGE_NAME: &'static str = "typescript";
31 const TYPESCRIPT_TSDK_PATH: &'static str = "node_modules/typescript/lib";
32
33 pub fn new(node: NodeRuntime) -> Self {
34 VtslsLspAdapter { node }
35 }
36
37 async fn tsdk_path(adapter: &Arc<dyn LspAdapterDelegate>) -> &'static str {
38 let is_yarn = adapter
39 .read_text_file(PathBuf::from(".yarn/sdks/typescript/lib/typescript.js"))
40 .await
41 .is_ok();
42
43 if is_yarn {
44 ".yarn/sdks/typescript/lib"
45 } else {
46 Self::TYPESCRIPT_TSDK_PATH
47 }
48 }
49}
50
51struct TypeScriptVersions {
52 typescript_version: String,
53 server_version: String,
54}
55
56const SERVER_NAME: LanguageServerName = LanguageServerName::new_static("vtsls");
57
58#[async_trait(?Send)]
59impl LspAdapter for VtslsLspAdapter {
60 fn name(&self) -> LanguageServerName {
61 SERVER_NAME.clone()
62 }
63
64 async fn fetch_latest_server_version(
65 &self,
66 _: &dyn LspAdapterDelegate,
67 ) -> Result<Box<dyn 'static + Send + Any>> {
68 Ok(Box::new(TypeScriptVersions {
69 typescript_version: self.node.npm_package_latest_version("typescript").await?,
70 server_version: self
71 .node
72 .npm_package_latest_version("@vtsls/language-server")
73 .await?,
74 }) as Box<_>)
75 }
76
77 async fn check_if_user_installed(
78 &self,
79 delegate: &dyn LspAdapterDelegate,
80 _: &AsyncAppContext,
81 ) -> Option<LanguageServerBinary> {
82 let env = delegate.shell_env().await;
83 let path = delegate.which(SERVER_NAME.as_ref()).await?;
84 Some(LanguageServerBinary {
85 path: path.clone(),
86 arguments: typescript_server_binary_arguments(&path),
87 env: Some(env),
88 })
89 }
90
91 async fn fetch_server_binary(
92 &self,
93 latest_version: Box<dyn 'static + Send + Any>,
94 container_dir: PathBuf,
95 _: &dyn LspAdapterDelegate,
96 ) -> Result<LanguageServerBinary> {
97 let latest_version = latest_version.downcast::<TypeScriptVersions>().unwrap();
98 let server_path = container_dir.join(Self::SERVER_PATH);
99
100 let mut packages_to_install = Vec::new();
101
102 if self
103 .node
104 .should_install_npm_package(
105 Self::PACKAGE_NAME,
106 &server_path,
107 &container_dir,
108 &latest_version.server_version,
109 )
110 .await
111 {
112 packages_to_install.push((Self::PACKAGE_NAME, latest_version.server_version.as_str()));
113 }
114
115 if self
116 .node
117 .should_install_npm_package(
118 Self::TYPESCRIPT_PACKAGE_NAME,
119 &container_dir.join(Self::TYPESCRIPT_TSDK_PATH),
120 &container_dir,
121 &latest_version.typescript_version,
122 )
123 .await
124 {
125 packages_to_install.push((
126 Self::TYPESCRIPT_PACKAGE_NAME,
127 latest_version.typescript_version.as_str(),
128 ));
129 }
130
131 self.node
132 .npm_install_packages(&container_dir, &packages_to_install)
133 .await?;
134
135 Ok(LanguageServerBinary {
136 path: self.node.binary_path().await?,
137 env: None,
138 arguments: typescript_server_binary_arguments(&server_path),
139 })
140 }
141
142 async fn cached_server_binary(
143 &self,
144 container_dir: PathBuf,
145 _: &dyn LspAdapterDelegate,
146 ) -> Option<LanguageServerBinary> {
147 get_cached_ts_server_binary(container_dir, &self.node).await
148 }
149
150 fn code_action_kinds(&self) -> Option<Vec<CodeActionKind>> {
151 Some(vec![
152 CodeActionKind::QUICKFIX,
153 CodeActionKind::REFACTOR,
154 CodeActionKind::REFACTOR_EXTRACT,
155 CodeActionKind::SOURCE,
156 ])
157 }
158
159 async fn label_for_completion(
160 &self,
161 item: &lsp::CompletionItem,
162 language: &Arc<language::Language>,
163 ) -> Option<language::CodeLabel> {
164 use lsp::CompletionItemKind as Kind;
165 let len = item.label.len();
166 let grammar = language.grammar()?;
167 let highlight_id = match item.kind? {
168 Kind::CLASS | Kind::INTERFACE | Kind::ENUM => grammar.highlight_id_for_name("type"),
169 Kind::CONSTRUCTOR => grammar.highlight_id_for_name("type"),
170 Kind::CONSTANT => grammar.highlight_id_for_name("constant"),
171 Kind::FUNCTION | Kind::METHOD => grammar.highlight_id_for_name("function"),
172 Kind::PROPERTY | Kind::FIELD => grammar.highlight_id_for_name("property"),
173 Kind::VARIABLE => grammar.highlight_id_for_name("variable"),
174 _ => None,
175 }?;
176
177 let one_line = |s: &str| s.replace(" ", "").replace('\n', " ");
178
179 let text = if let Some(description) = item
180 .label_details
181 .as_ref()
182 .and_then(|label_details| label_details.description.as_ref())
183 {
184 format!("{} {}", item.label, one_line(description))
185 } else if let Some(detail) = &item.detail {
186 format!("{} {}", item.label, one_line(detail))
187 } else {
188 item.label.clone()
189 };
190
191 Some(language::CodeLabel {
192 text,
193 runs: vec![(0..len, highlight_id)],
194 filter_range: 0..len,
195 })
196 }
197
198 async fn workspace_configuration(
199 self: Arc<Self>,
200 delegate: &Arc<dyn LspAdapterDelegate>,
201 _: Arc<dyn LanguageToolchainStore>,
202 cx: &mut AsyncAppContext,
203 ) -> Result<Value> {
204 let tsdk_path = Self::tsdk_path(delegate).await;
205 let config = serde_json::json!({
206 "tsdk": tsdk_path,
207 "suggest": {
208 "completeFunctionCalls": true
209 },
210 "inlayHints": {
211 "parameterNames": {
212 "enabled": "all",
213 "suppressWhenArgumentMatchesName": false
214 },
215 "parameterTypes": {
216 "enabled": true
217 },
218 "variableTypes": {
219 "enabled": true,
220 "suppressWhenTypeMatchesName": false
221 },
222 "propertyDeclarationTypes": {
223 "enabled": true
224 },
225 "functionLikeReturnTypes": {
226 "enabled": true
227 },
228 "enumMemberValues": {
229 "enabled": true
230 }
231 },
232 "tsserver": {
233 "maxTsServerMemory": 8092
234 },
235 });
236
237 let mut default_workspace_configuration = serde_json::json!({
238 "typescript": config,
239 "javascript": config,
240 "vtsls": {
241 "experimental": {
242 "completion": {
243 "enableServerSideFuzzyMatch": true,
244 "entriesLimit": 5000,
245 }
246 },
247 "autoUseWorkspaceTsdk": true
248 }
249 });
250
251 let override_options = cx.update(|cx| {
252 language_server_settings(delegate.as_ref(), &SERVER_NAME, cx)
253 .and_then(|s| s.settings.clone())
254 })?;
255
256 if let Some(override_options) = override_options {
257 merge_json_value_into(override_options, &mut default_workspace_configuration)
258 }
259
260 Ok(default_workspace_configuration)
261 }
262
263 fn language_ids(&self) -> HashMap<String, String> {
264 HashMap::from_iter([
265 ("TypeScript".into(), "typescript".into()),
266 ("JavaScript".into(), "javascript".into()),
267 ("TSX".into(), "typescriptreact".into()),
268 ])
269 }
270}
271
272async fn get_cached_ts_server_binary(
273 container_dir: PathBuf,
274 node: &NodeRuntime,
275) -> Option<LanguageServerBinary> {
276 maybe!(async {
277 let server_path = container_dir.join(VtslsLspAdapter::SERVER_PATH);
278 if server_path.exists() {
279 Ok(LanguageServerBinary {
280 path: node.binary_path().await?,
281 env: None,
282 arguments: typescript_server_binary_arguments(&server_path),
283 })
284 } else {
285 Err(anyhow!(
286 "missing executable in directory {:?}",
287 container_dir
288 ))
289 }
290 })
291 .await
292 .log_err()
293}