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