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            semantic_token_rules: Some(cpp::semantic_token_rules()),
129            ..Default::default()
130        },
131        LanguageInfo {
132            name: "css",
133            adapters: vec![css_lsp_adapter],
134            ..Default::default()
135        },
136        LanguageInfo {
137            name: "diff",
138            adapters: vec![],
139            ..Default::default()
140        },
141        LanguageInfo {
142            name: "go",
143            adapters: vec![go_lsp_adapter.clone()],
144            context: Some(go_context_provider.clone()),
145            semantic_token_rules: Some(go::semantic_token_rules()),
146            ..Default::default()
147        },
148        LanguageInfo {
149            name: "gomod",
150            adapters: vec![go_lsp_adapter.clone()],
151            context: Some(go_context_provider.clone()),
152            ..Default::default()
153        },
154        LanguageInfo {
155            name: "gowork",
156            adapters: vec![go_lsp_adapter],
157            context: Some(go_context_provider),
158            ..Default::default()
159        },
160        LanguageInfo {
161            name: "json",
162            adapters: vec![json_lsp_adapter.clone(), node_version_lsp_adapter],
163            context: Some(json_context_provider.clone()),
164            ..Default::default()
165        },
166        LanguageInfo {
167            name: "jsonc",
168            adapters: vec![json_lsp_adapter],
169            context: Some(json_context_provider),
170            ..Default::default()
171        },
172        LanguageInfo {
173            name: "markdown",
174            adapters: vec![],
175            ..Default::default()
176        },
177        LanguageInfo {
178            name: "markdown-inline",
179            adapters: vec![],
180            ..Default::default()
181        },
182        LanguageInfo {
183            name: "python",
184            adapters: vec![
185                basedpyright_lsp_adapter,
186                ruff_lsp_adapter,
187                ty_lsp_adapter,
188                py_lsp_adapter,
189                python_lsp_adapter,
190            ],
191            context: Some(python_context_provider),
192            toolchain: Some(python_toolchain_provider),
193            manifest_name: Some(SharedString::new_static("pyproject.toml").into()),
194            ..Default::default()
195        },
196        LanguageInfo {
197            name: "rust",
198            adapters: vec![rust_lsp_adapter],
199            context: Some(rust_context_provider),
200            manifest_name: Some(SharedString::new_static("Cargo.toml").into()),
201            semantic_token_rules: Some(rust::semantic_token_rules()),
202            ..Default::default()
203        },
204        LanguageInfo {
205            name: "tsx",
206            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
207            context: Some(typescript_context.clone()),
208            ..Default::default()
209        },
210        LanguageInfo {
211            name: "typescript",
212            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
213            context: Some(typescript_context.clone()),
214            ..Default::default()
215        },
216        LanguageInfo {
217            name: "javascript",
218            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
219            context: Some(typescript_context),
220            ..Default::default()
221        },
222        LanguageInfo {
223            name: "jsdoc",
224            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
225            ..Default::default()
226        },
227        LanguageInfo {
228            name: "regex",
229            adapters: vec![],
230            ..Default::default()
231        },
232        LanguageInfo {
233            name: "yaml",
234            adapters: vec![yaml_lsp_adapter],
235            ..Default::default()
236        },
237        LanguageInfo {
238            name: "gitcommit",
239            ..Default::default()
240        },
241        LanguageInfo {
242            name: "zed-keybind-context",
243            ..Default::default()
244        },
245    ];
246
247    for registration in built_in_languages {
248        register_language(
249            &languages,
250            registration.name,
251            registration.adapters,
252            registration.context,
253            registration.toolchain,
254            registration.manifest_name,
255            registration.semantic_token_rules,
256            cx,
257        );
258    }
259
260    // Register globally available language servers.
261    //
262    // This will allow users to add support for a built-in language server (e.g., Tailwind)
263    // for a given language via the `language_servers` setting:
264    //
265    // ```json
266    // {
267    //   "languages": {
268    //     "My Language": {
269    //       "language_servers": ["tailwindcss-language-server", "..."]
270    //     }
271    //   }
272    // }
273    // ```
274    languages.register_available_lsp_adapter(
275        LanguageServerName("tailwindcss-language-server".into()),
276        tailwind_adapter.clone(),
277    );
278    languages.register_available_lsp_adapter(
279        LanguageServerName("tailwindcss-intellisense-css".into()),
280        tailwindcss_adapter,
281    );
282    languages.register_available_lsp_adapter(
283        LanguageServerName("eslint".into()),
284        eslint_adapter.clone(),
285    );
286    languages.register_available_lsp_adapter(LanguageServerName("vtsls".into()), vtsls_adapter);
287    languages.register_available_lsp_adapter(
288        LanguageServerName("typescript-language-server".into()),
289        typescript_lsp_adapter,
290    );
291
292    // Register Tailwind for the existing languages that should have it by default.
293    //
294    // This can be driven by the `language_servers` setting once we have a way for
295    // extensions to provide their own default value for that setting.
296    let tailwind_languages = [
297        "Astro",
298        "CSS",
299        "ERB",
300        "HTML+ERB",
301        "HEEx",
302        "HTML",
303        "JavaScript",
304        "TypeScript",
305        "PHP",
306        "Svelte",
307        "TSX",
308        "Vue.js",
309    ];
310
311    for language in tailwind_languages {
312        languages.register_lsp_adapter(language.into(), tailwind_adapter.clone());
313    }
314
315    let eslint_languages = ["TSX", "TypeScript", "JavaScript", "Vue.js", "Svelte"];
316    for language in eslint_languages {
317        languages.register_lsp_adapter(language.into(), eslint_adapter.clone());
318    }
319
320    let mut subscription = languages.subscribe();
321    let mut prev_language_settings = languages.language_settings();
322
323    cx.spawn(async move |cx| {
324        while subscription.next().await.is_some() {
325            let language_settings = languages.language_settings();
326            if language_settings != prev_language_settings {
327                cx.update(|cx| {
328                    SettingsStore::update_global(cx, |settings, cx| {
329                        settings
330                            .set_extension_settings(
331                                settings::ExtensionsSettingsContent {
332                                    all_languages: language_settings.clone(),
333                                },
334                                cx,
335                            )
336                            .log_err();
337                    });
338                });
339                prev_language_settings = language_settings;
340            }
341        }
342        anyhow::Ok(())
343    })
344    .detach();
345    let manifest_providers: [Arc<dyn ManifestProvider>; 2] = [
346        Arc::from(CargoManifestProvider),
347        Arc::from(PyprojectTomlManifestProvider),
348    ];
349    for provider in manifest_providers {
350        project::ManifestProvidersStore::global(cx).register(provider);
351    }
352}
353
354#[derive(Default)]
355struct LanguageInfo {
356    name: &'static str,
357    adapters: Vec<Arc<dyn LspAdapter>>,
358    context: Option<Arc<dyn ContextProvider>>,
359    toolchain: Option<Arc<dyn ToolchainLister>>,
360    manifest_name: Option<ManifestName>,
361    semantic_token_rules: Option<SemanticTokenRules>,
362}
363
364fn register_language(
365    languages: &LanguageRegistry,
366    name: &'static str,
367    adapters: Vec<Arc<dyn LspAdapter>>,
368    context: Option<Arc<dyn ContextProvider>>,
369    toolchain: Option<Arc<dyn ToolchainLister>>,
370    manifest_name: Option<ManifestName>,
371    semantic_token_rules: Option<SemanticTokenRules>,
372    cx: &mut App,
373) {
374    let config = load_config(name);
375    if let Some(rules) = &semantic_token_rules {
376        SettingsStore::update_global(cx, |store, cx| {
377            store.set_language_semantic_token_rules(config.name.0.clone(), rules.clone(), cx);
378        });
379    }
380    for adapter in adapters {
381        languages.register_lsp_adapter(config.name.clone(), adapter);
382    }
383    languages.register_language(
384        config.name.clone(),
385        config.grammar.clone(),
386        config.matcher.clone(),
387        config.hidden,
388        manifest_name.clone(),
389        Arc::new(move || {
390            Ok(LoadedLanguage {
391                config: config.clone(),
392                queries: load_queries(name),
393                context_provider: context.clone(),
394                toolchain_provider: toolchain.clone(),
395                manifest_name: manifest_name.clone(),
396            })
397        }),
398    );
399}
400
401#[cfg(any(test, feature = "test-support"))]
402pub fn language(name: &str, grammar: tree_sitter::Language) -> Arc<Language> {
403    Arc::new(
404        Language::new(load_config(name), Some(grammar))
405            .with_queries(load_queries(name))
406            .unwrap(),
407    )
408}
409
410fn load_config(name: &str) -> LanguageConfig {
411    let config_toml = String::from_utf8(
412        LanguageDir::get(&format!("{}/config.toml", name))
413            .unwrap_or_else(|| panic!("missing config for language {:?}", name))
414            .data
415            .to_vec(),
416    )
417    .unwrap();
418
419    #[allow(unused_mut)]
420    let mut config: LanguageConfig = ::toml::from_str(&config_toml)
421        .with_context(|| format!("failed to load config.toml for language {name:?}"))
422        .unwrap();
423
424    #[cfg(not(any(feature = "load-grammars", test)))]
425    {
426        config = LanguageConfig {
427            name: config.name,
428            matcher: config.matcher,
429            jsx_tag_auto_close: config.jsx_tag_auto_close,
430            ..Default::default()
431        }
432    }
433
434    config
435}
436
437fn load_queries(name: &str) -> LanguageQueries {
438    let mut result = LanguageQueries::default();
439    for path in LanguageDir::iter() {
440        if let Some(remainder) = path.strip_prefix(name).and_then(|p| p.strip_prefix('/')) {
441            if !remainder.ends_with(".scm") {
442                continue;
443            }
444            for (name, query) in QUERY_FILENAME_PREFIXES {
445                if remainder.starts_with(name) {
446                    let contents = asset_str::<LanguageDir>(path.as_ref());
447                    match query(&mut result) {
448                        None => *query(&mut result) = Some(contents),
449                        Some(r) => r.to_mut().push_str(contents.as_ref()),
450                    }
451                }
452            }
453        }
454    }
455    result
456}