lib.rs

  1use anyhow::Context as _;
  2use gpui::{App, UpdateGlobal};
  3use json::json_task_context;
  4use node_runtime::NodeRuntime;
  5use rust_embed::RustEmbed;
  6use settings::SettingsStore;
  7use smol::stream::StreamExt;
  8use std::{str, sync::Arc};
  9use util::{asset_str, ResultExt};
 10
 11pub use language::*;
 12
 13mod bash;
 14mod c;
 15mod css;
 16mod go;
 17mod json;
 18mod python;
 19mod rust;
 20mod tailwind;
 21mod typescript;
 22mod vtsls;
 23mod yaml;
 24
 25#[derive(RustEmbed)]
 26#[folder = "src/"]
 27#[exclude = "*.rs"]
 28struct LanguageDir;
 29
 30/// A shared grammar for plain text, exposed for reuse by downstream crates.
 31#[cfg(feature = "tree-sitter-gitcommit")]
 32pub static LANGUAGE_GIT_COMMIT: std::sync::LazyLock<Arc<Language>> =
 33    std::sync::LazyLock::new(|| {
 34        Arc::new(Language::new(
 35            LanguageConfig {
 36                name: "Git Commit".into(),
 37                soft_wrap: Some(language::language_settings::SoftWrap::EditorWidth),
 38                matcher: LanguageMatcher {
 39                    path_suffixes: vec!["COMMIT_EDITMSG".to_owned()],
 40                    first_line_pattern: None,
 41                },
 42                line_comments: vec![Arc::from("#")],
 43                ..LanguageConfig::default()
 44            },
 45            Some(tree_sitter_gitcommit::LANGUAGE.into()),
 46        ))
 47    });
 48
 49pub fn init(languages: Arc<LanguageRegistry>, node: NodeRuntime, cx: &mut App) {
 50    #[cfg(feature = "load-grammars")]
 51    languages.register_native_grammars([
 52        ("bash", tree_sitter_bash::LANGUAGE),
 53        ("c", tree_sitter_c::LANGUAGE),
 54        ("cpp", tree_sitter_cpp::LANGUAGE),
 55        ("css", tree_sitter_css::LANGUAGE),
 56        ("diff", tree_sitter_diff::LANGUAGE),
 57        ("go", tree_sitter_go::LANGUAGE),
 58        ("gomod", tree_sitter_go_mod::LANGUAGE),
 59        ("gowork", tree_sitter_gowork::LANGUAGE),
 60        ("jsdoc", tree_sitter_jsdoc::LANGUAGE),
 61        ("json", tree_sitter_json::LANGUAGE),
 62        ("jsonc", tree_sitter_json::LANGUAGE),
 63        ("markdown", tree_sitter_md::LANGUAGE),
 64        ("markdown-inline", tree_sitter_md::INLINE_LANGUAGE),
 65        ("python", tree_sitter_python::LANGUAGE),
 66        ("regex", tree_sitter_regex::LANGUAGE),
 67        ("rust", tree_sitter_rust::LANGUAGE),
 68        ("tsx", tree_sitter_typescript::LANGUAGE_TSX),
 69        ("typescript", tree_sitter_typescript::LANGUAGE_TYPESCRIPT),
 70        ("yaml", tree_sitter_yaml::LANGUAGE),
 71        ("gitcommit", tree_sitter_gitcommit::LANGUAGE),
 72    ]);
 73
 74    let c_lsp_adapter = Arc::new(c::CLspAdapter);
 75    let css_lsp_adapter = Arc::new(css::CssLspAdapter::new(node.clone()));
 76    let eslint_adapter = Arc::new(typescript::EsLintLspAdapter::new(node.clone()));
 77    let go_context_provider = Arc::new(go::GoContextProvider);
 78    let go_lsp_adapter = Arc::new(go::GoLspAdapter);
 79    let json_context_provider = Arc::new(json_task_context());
 80    let json_lsp_adapter = Arc::new(json::JsonLspAdapter::new(node.clone(), languages.clone()));
 81    let node_version_lsp_adapter = Arc::new(json::NodeVersionAdapter);
 82    let py_lsp_adapter = Arc::new(python::PyLspAdapter::new());
 83    let python_context_provider = Arc::new(python::PythonContextProvider);
 84    let python_lsp_adapter = Arc::new(python::PythonLspAdapter::new(node.clone()));
 85    let python_toolchain_provider = Arc::new(python::PythonToolchainProvider::default());
 86    let rust_context_provider = Arc::new(rust::RustContextProvider);
 87    let rust_lsp_adapter = Arc::new(rust::RustLspAdapter);
 88    let tailwind_adapter = Arc::new(tailwind::TailwindLspAdapter::new(node.clone()));
 89    let typescript_context = Arc::new(typescript::typescript_task_context());
 90    let typescript_lsp_adapter = Arc::new(typescript::TypeScriptLspAdapter::new(node.clone()));
 91    let vtsls_adapter = Arc::new(vtsls::VtslsLspAdapter::new(node.clone()));
 92    let yaml_lsp_adapter = Arc::new(yaml::YamlLspAdapter::new(node.clone()));
 93
 94    let built_in_languages = [
 95        LanguageInfo {
 96            name: "bash",
 97            context: Some(Arc::new(bash::bash_task_context())),
 98            ..Default::default()
 99        },
100        LanguageInfo {
101            name: "c",
102            adapters: vec![c_lsp_adapter.clone()],
103            ..Default::default()
104        },
105        LanguageInfo {
106            name: "cpp",
107            adapters: vec![c_lsp_adapter.clone()],
108            ..Default::default()
109        },
110        LanguageInfo {
111            name: "css",
112            adapters: vec![css_lsp_adapter.clone()],
113            ..Default::default()
114        },
115        LanguageInfo {
116            name: "diff",
117            adapters: vec![],
118            ..Default::default()
119        },
120        LanguageInfo {
121            name: "go",
122            adapters: vec![go_lsp_adapter.clone()],
123            context: Some(go_context_provider.clone()),
124            ..Default::default()
125        },
126        LanguageInfo {
127            name: "gomod",
128            adapters: vec![go_lsp_adapter.clone()],
129            context: Some(go_context_provider.clone()),
130            ..Default::default()
131        },
132        LanguageInfo {
133            name: "gowork",
134            adapters: vec![go_lsp_adapter.clone()],
135            context: Some(go_context_provider.clone()),
136            ..Default::default()
137        },
138        LanguageInfo {
139            name: "json",
140            adapters: vec![json_lsp_adapter.clone(), node_version_lsp_adapter.clone()],
141            context: Some(json_context_provider.clone()),
142            ..Default::default()
143        },
144        LanguageInfo {
145            name: "jsonc",
146            adapters: vec![json_lsp_adapter.clone()],
147            context: Some(json_context_provider.clone()),
148            ..Default::default()
149        },
150        LanguageInfo {
151            name: "markdown",
152            adapters: vec![],
153            ..Default::default()
154        },
155        LanguageInfo {
156            name: "markdown-inline",
157            adapters: vec![],
158            ..Default::default()
159        },
160        LanguageInfo {
161            name: "python",
162            adapters: vec![python_lsp_adapter.clone(), py_lsp_adapter.clone()],
163            context: Some(python_context_provider),
164            toolchain: Some(python_toolchain_provider),
165        },
166        LanguageInfo {
167            name: "rust",
168            adapters: vec![rust_lsp_adapter],
169            context: Some(rust_context_provider),
170            ..Default::default()
171        },
172        LanguageInfo {
173            name: "tsx",
174            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
175            context: Some(typescript_context.clone()),
176            ..Default::default()
177        },
178        LanguageInfo {
179            name: "typescript",
180            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
181            context: Some(typescript_context.clone()),
182            ..Default::default()
183        },
184        LanguageInfo {
185            name: "javascript",
186            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
187            context: Some(typescript_context.clone()),
188            ..Default::default()
189        },
190        LanguageInfo {
191            name: "jsdoc",
192            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
193            ..Default::default()
194        },
195        LanguageInfo {
196            name: "regex",
197            adapters: vec![],
198            ..Default::default()
199        },
200        LanguageInfo {
201            name: "yaml",
202            adapters: vec![yaml_lsp_adapter],
203            ..Default::default()
204        },
205    ];
206
207    for registration in built_in_languages {
208        register_language(
209            &languages,
210            registration.name,
211            registration.adapters,
212            registration.context,
213            registration.toolchain,
214        );
215    }
216
217    // Register globally available language servers.
218    //
219    // This will allow users to add support for a built-in language server (e.g., Tailwind)
220    // for a given language via the `language_servers` setting:
221    //
222    // ```json
223    // {
224    //   "languages": {
225    //     "My Language": {
226    //       "language_servers": ["tailwindcss-language-server", "..."]
227    //     }
228    //   }
229    // }
230    // ```
231    languages.register_available_lsp_adapter(
232        LanguageServerName("tailwindcss-language-server".into()),
233        {
234            let adapter = tailwind_adapter.clone();
235            move || adapter.clone()
236        },
237    );
238    languages.register_available_lsp_adapter(LanguageServerName("eslint".into()), {
239        let adapter = eslint_adapter.clone();
240        move || adapter.clone()
241    });
242    languages.register_available_lsp_adapter(LanguageServerName("vtsls".into()), {
243        let adapter = vtsls_adapter.clone();
244        move || adapter.clone()
245    });
246    languages.register_available_lsp_adapter(
247        LanguageServerName("typescript-language-server".into()),
248        {
249            let adapter = typescript_lsp_adapter.clone();
250            move || adapter.clone()
251        },
252    );
253
254    // Register Tailwind for the existing languages that should have it by default.
255    //
256    // This can be driven by the `language_servers` setting once we have a way for
257    // extensions to provide their own default value for that setting.
258    let tailwind_languages = [
259        "Astro",
260        "CSS",
261        "ERB",
262        "HEEX",
263        "HTML",
264        "JavaScript",
265        "PHP",
266        "Svelte",
267        "TSX",
268        "Vue.js",
269    ];
270
271    for language in tailwind_languages {
272        languages.register_lsp_adapter(language.into(), tailwind_adapter.clone());
273    }
274
275    let eslint_languages = ["TSX", "TypeScript", "JavaScript", "Vue.js", "Svelte"];
276    for language in eslint_languages {
277        languages.register_lsp_adapter(language.into(), eslint_adapter.clone());
278    }
279
280    let mut subscription = languages.subscribe();
281    let mut prev_language_settings = languages.language_settings();
282
283    cx.spawn(|cx| async move {
284        while subscription.next().await.is_some() {
285            let language_settings = languages.language_settings();
286            if language_settings != prev_language_settings {
287                cx.update(|cx| {
288                    SettingsStore::update_global(cx, |settings, cx| {
289                        settings
290                            .set_extension_settings(language_settings.clone(), cx)
291                            .log_err();
292                    });
293                })?;
294                prev_language_settings = language_settings;
295            }
296        }
297        anyhow::Ok(())
298    })
299    .detach();
300}
301
302#[derive(Default)]
303struct LanguageInfo {
304    name: &'static str,
305    adapters: Vec<Arc<dyn LspAdapter>>,
306    context: Option<Arc<dyn ContextProvider>>,
307    toolchain: Option<Arc<dyn ToolchainLister>>,
308}
309
310fn register_language(
311    languages: &LanguageRegistry,
312    name: &'static str,
313    adapters: Vec<Arc<dyn LspAdapter>>,
314    context: Option<Arc<dyn ContextProvider>>,
315    toolchain: Option<Arc<dyn ToolchainLister>>,
316) {
317    let config = load_config(name);
318    for adapter in adapters {
319        languages.register_lsp_adapter(config.name.clone(), adapter);
320    }
321    languages.register_language(
322        config.name.clone(),
323        config.grammar.clone(),
324        config.matcher.clone(),
325        config.hidden,
326        Arc::new(move || {
327            Ok(LoadedLanguage {
328                config: config.clone(),
329                queries: load_queries(name),
330                context_provider: context.clone(),
331                toolchain_provider: toolchain.clone(),
332            })
333        }),
334    );
335}
336
337#[cfg(any(test, feature = "test-support"))]
338pub fn language(name: &str, grammar: tree_sitter::Language) -> Arc<Language> {
339    Arc::new(
340        Language::new(load_config(name), Some(grammar))
341            .with_queries(load_queries(name))
342            .unwrap(),
343    )
344}
345
346fn load_config(name: &str) -> LanguageConfig {
347    let config_toml = String::from_utf8(
348        LanguageDir::get(&format!("{}/config.toml", name))
349            .unwrap_or_else(|| panic!("missing config for language {:?}", name))
350            .data
351            .to_vec(),
352    )
353    .unwrap();
354
355    #[allow(unused_mut)]
356    let mut config: LanguageConfig = ::toml::from_str(&config_toml)
357        .with_context(|| format!("failed to load config.toml for language {name:?}"))
358        .unwrap();
359
360    #[cfg(not(any(feature = "load-grammars", test)))]
361    {
362        config = LanguageConfig {
363            name: config.name,
364            matcher: config.matcher,
365            jsx_tag_auto_close: config.jsx_tag_auto_close,
366            ..Default::default()
367        }
368    }
369
370    config
371}
372
373fn load_queries(name: &str) -> LanguageQueries {
374    let mut result = LanguageQueries::default();
375    for path in LanguageDir::iter() {
376        if let Some(remainder) = path.strip_prefix(name).and_then(|p| p.strip_prefix('/')) {
377            if !remainder.ends_with(".scm") {
378                continue;
379            }
380            for (name, query) in QUERY_FILENAME_PREFIXES {
381                if remainder.starts_with(name) {
382                    let contents = asset_str::<LanguageDir>(path.as_ref());
383                    match query(&mut result) {
384                        None => *query(&mut result) = Some(contents),
385                        Some(r) => r.to_mut().push_str(contents.as_ref()),
386                    }
387                }
388            }
389        }
390    }
391    result
392}