lib.rs

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