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::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                    ..LanguageMatcher::default()
 55                },
 56                line_comments: vec![Arc::from("#")],
 57                ..LanguageConfig::default()
 58            },
 59            Some(tree_sitter_gitcommit::LANGUAGE.into()),
 60        ))
 61    });
 62
 63pub fn init(languages: Arc<LanguageRegistry>, fs: Arc<dyn Fs>, node: NodeRuntime, cx: &mut App) {
 64    #[cfg(feature = "load-grammars")]
 65    languages.register_native_grammars([
 66        ("bash", tree_sitter_bash::LANGUAGE),
 67        ("c", tree_sitter_c::LANGUAGE),
 68        ("cpp", tree_sitter_cpp::LANGUAGE),
 69        ("css", tree_sitter_css::LANGUAGE),
 70        ("diff", tree_sitter_diff::LANGUAGE),
 71        ("go", tree_sitter_go::LANGUAGE),
 72        ("gomod", tree_sitter_go_mod::LANGUAGE),
 73        ("gowork", tree_sitter_gowork::LANGUAGE),
 74        ("jsdoc", tree_sitter_jsdoc::LANGUAGE),
 75        ("json", tree_sitter_json::LANGUAGE),
 76        ("jsonc", tree_sitter_json::LANGUAGE),
 77        ("markdown", tree_sitter_md::LANGUAGE),
 78        ("markdown-inline", tree_sitter_md::INLINE_LANGUAGE),
 79        ("python", tree_sitter_python::LANGUAGE),
 80        ("regex", tree_sitter_regex::LANGUAGE),
 81        ("rust", tree_sitter_rust::LANGUAGE),
 82        ("tsx", tree_sitter_typescript::LANGUAGE_TSX),
 83        ("typescript", tree_sitter_typescript::LANGUAGE_TYPESCRIPT),
 84        ("yaml", tree_sitter_yaml::LANGUAGE),
 85        ("gitcommit", tree_sitter_gitcommit::LANGUAGE),
 86    ]);
 87
 88    let c_lsp_adapter = Arc::new(c::CLspAdapter);
 89    let css_lsp_adapter = Arc::new(css::CssLspAdapter::new(node.clone()));
 90    let eslint_adapter = Arc::new(eslint::EsLintLspAdapter::new(node.clone()));
 91    let go_context_provider = Arc::new(go::GoContextProvider);
 92    let go_lsp_adapter = Arc::new(go::GoLspAdapter);
 93    let json_context_provider = Arc::new(JsonTaskProvider);
 94    let json_lsp_adapter = Arc::new(json::JsonLspAdapter::new(languages.clone(), node.clone()));
 95    let node_version_lsp_adapter = Arc::new(json::NodeVersionAdapter);
 96    let py_lsp_adapter = Arc::new(python::PyLspAdapter::new());
 97    let ty_lsp_adapter = Arc::new(python::TyLspAdapter::new(fs.clone()));
 98    let python_context_provider = Arc::new(python::PythonContextProvider);
 99    let python_lsp_adapter = Arc::new(python::PyrightLspAdapter::new(node.clone()));
100    let basedpyright_lsp_adapter = Arc::new(BasedPyrightLspAdapter::new(node.clone()));
101    let ruff_lsp_adapter = Arc::new(RuffLspAdapter::new(fs.clone()));
102    let python_toolchain_provider = Arc::new(python::PythonToolchainProvider);
103    let rust_context_provider = Arc::new(rust::RustContextProvider);
104    let rust_lsp_adapter = Arc::new(rust::RustLspAdapter);
105    let tailwind_adapter = Arc::new(tailwind::TailwindLspAdapter::new(node.clone()));
106    let tailwindcss_adapter = Arc::new(tailwindcss::TailwindCssLspAdapter::new(node.clone()));
107    let typescript_context = Arc::new(typescript::TypeScriptContextProvider::new(fs.clone()));
108    let typescript_lsp_adapter = Arc::new(typescript::TypeScriptLspAdapter::new(
109        node.clone(),
110        fs.clone(),
111    ));
112    let vtsls_adapter = Arc::new(vtsls::VtslsLspAdapter::new(node.clone(), fs.clone()));
113    let yaml_lsp_adapter = Arc::new(yaml::YamlLspAdapter::new(node));
114
115    let built_in_languages = [
116        LanguageInfo {
117            name: "bash",
118            context: Some(Arc::new(bash::bash_task_context())),
119            ..Default::default()
120        },
121        LanguageInfo {
122            name: "c",
123            adapters: vec![c_lsp_adapter.clone()],
124            ..Default::default()
125        },
126        LanguageInfo {
127            name: "cpp",
128            adapters: vec![c_lsp_adapter],
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            ..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![basedpyright_lsp_adapter, ruff_lsp_adapter],
184            context: Some(python_context_provider),
185            toolchain: Some(python_toolchain_provider),
186            manifest_name: Some(SharedString::new_static("pyproject.toml").into()),
187        },
188        LanguageInfo {
189            name: "rust",
190            adapters: vec![rust_lsp_adapter],
191            context: Some(rust_context_provider),
192            manifest_name: Some(SharedString::new_static("Cargo.toml").into()),
193            ..Default::default()
194        },
195        LanguageInfo {
196            name: "tsx",
197            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
198            context: Some(typescript_context.clone()),
199            ..Default::default()
200        },
201        LanguageInfo {
202            name: "typescript",
203            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
204            context: Some(typescript_context.clone()),
205            ..Default::default()
206        },
207        LanguageInfo {
208            name: "javascript",
209            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
210            context: Some(typescript_context),
211            ..Default::default()
212        },
213        LanguageInfo {
214            name: "jsdoc",
215            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
216            ..Default::default()
217        },
218        LanguageInfo {
219            name: "regex",
220            adapters: vec![],
221            ..Default::default()
222        },
223        LanguageInfo {
224            name: "yaml",
225            adapters: vec![yaml_lsp_adapter],
226            ..Default::default()
227        },
228        LanguageInfo {
229            name: "gitcommit",
230            ..Default::default()
231        },
232        LanguageInfo {
233            name: "zed-keybind-context",
234            ..Default::default()
235        },
236    ];
237
238    for registration in built_in_languages {
239        register_language(
240            &languages,
241            registration.name,
242            registration.adapters,
243            registration.context,
244            registration.toolchain,
245            registration.manifest_name,
246        );
247    }
248
249    // Register globally available language servers.
250    //
251    // This will allow users to add support for a built-in language server (e.g., Tailwind)
252    // for a given language via the `language_servers` setting:
253    //
254    // ```json
255    // {
256    //   "languages": {
257    //     "My Language": {
258    //       "language_servers": ["tailwindcss-language-server", "..."]
259    //     }
260    //   }
261    // }
262    // ```
263    languages.register_available_lsp_adapter(
264        LanguageServerName("tailwindcss-language-server".into()),
265        tailwind_adapter.clone(),
266    );
267    languages.register_available_lsp_adapter(
268        LanguageServerName("tailwindcss-intellisense-css".into()),
269        tailwindcss_adapter,
270    );
271    languages.register_available_lsp_adapter(
272        LanguageServerName("eslint".into()),
273        eslint_adapter.clone(),
274    );
275    languages.register_available_lsp_adapter(LanguageServerName("vtsls".into()), vtsls_adapter);
276    languages.register_available_lsp_adapter(
277        LanguageServerName("typescript-language-server".into()),
278        typescript_lsp_adapter,
279    );
280
281    languages.register_available_lsp_adapter(python_lsp_adapter.name(), python_lsp_adapter);
282    languages.register_available_lsp_adapter(py_lsp_adapter.name(), py_lsp_adapter);
283    languages.register_available_lsp_adapter(ty_lsp_adapter.name(), ty_lsp_adapter);
284    // Register Tailwind for the existing languages that should have it by default.
285    //
286    // This can be driven by the `language_servers` setting once we have a way for
287    // extensions to provide their own default value for that setting.
288    let tailwind_languages = [
289        "Astro",
290        "CSS",
291        "ERB",
292        "HTML+ERB",
293        "HEEX",
294        "HTML",
295        "JavaScript",
296        "TypeScript",
297        "PHP",
298        "Svelte",
299        "TSX",
300        "Vue.js",
301    ];
302
303    for language in tailwind_languages {
304        languages.register_lsp_adapter(language.into(), tailwind_adapter.clone());
305    }
306
307    let eslint_languages = ["TSX", "TypeScript", "JavaScript", "Vue.js", "Svelte"];
308    for language in eslint_languages {
309        languages.register_lsp_adapter(language.into(), eslint_adapter.clone());
310    }
311
312    let mut subscription = languages.subscribe();
313    let mut prev_language_settings = languages.language_settings();
314
315    cx.spawn(async move |cx| {
316        while subscription.next().await.is_some() {
317            let language_settings = languages.language_settings();
318            if language_settings != prev_language_settings {
319                cx.update(|cx| {
320                    SettingsStore::update_global(cx, |settings, cx| {
321                        settings
322                            .set_extension_settings(
323                                settings::ExtensionsSettingsContent {
324                                    all_languages: language_settings.clone(),
325                                },
326                                cx,
327                            )
328                            .log_err();
329                    });
330                });
331                prev_language_settings = language_settings;
332            }
333        }
334        anyhow::Ok(())
335    })
336    .detach();
337    let manifest_providers: [Arc<dyn ManifestProvider>; 2] = [
338        Arc::from(CargoManifestProvider),
339        Arc::from(PyprojectTomlManifestProvider),
340    ];
341    for provider in manifest_providers {
342        project::ManifestProvidersStore::global(cx).register(provider);
343    }
344}
345
346#[derive(Default)]
347struct LanguageInfo {
348    name: &'static str,
349    adapters: Vec<Arc<dyn LspAdapter>>,
350    context: Option<Arc<dyn ContextProvider>>,
351    toolchain: Option<Arc<dyn ToolchainLister>>,
352    manifest_name: Option<ManifestName>,
353}
354
355fn register_language(
356    languages: &LanguageRegistry,
357    name: &'static str,
358    adapters: Vec<Arc<dyn LspAdapter>>,
359    context: Option<Arc<dyn ContextProvider>>,
360    toolchain: Option<Arc<dyn ToolchainLister>>,
361    manifest_name: Option<ManifestName>,
362) {
363    let config = load_config(name);
364    for adapter in adapters {
365        languages.register_lsp_adapter(config.name.clone(), adapter);
366    }
367    languages.register_language(
368        config.name.clone(),
369        config.grammar.clone(),
370        config.matcher.clone(),
371        config.hidden,
372        manifest_name.clone(),
373        Arc::new(move || {
374            Ok(LoadedLanguage {
375                config: config.clone(),
376                queries: load_queries(name),
377                context_provider: context.clone(),
378                toolchain_provider: toolchain.clone(),
379                manifest_name: manifest_name.clone(),
380            })
381        }),
382    );
383}
384
385#[cfg(any(test, feature = "test-support"))]
386pub fn language(name: &str, grammar: tree_sitter::Language) -> Arc<Language> {
387    Arc::new(
388        Language::new(load_config(name), Some(grammar))
389            .with_queries(load_queries(name))
390            .unwrap(),
391    )
392}
393
394fn load_config(name: &str) -> LanguageConfig {
395    let config_toml = String::from_utf8(
396        LanguageDir::get(&format!("{}/config.toml", name))
397            .unwrap_or_else(|| panic!("missing config for language {:?}", name))
398            .data
399            .to_vec(),
400    )
401    .unwrap();
402
403    #[allow(unused_mut)]
404    let mut config: LanguageConfig = ::toml::from_str(&config_toml)
405        .with_context(|| format!("failed to load config.toml for language {name:?}"))
406        .unwrap();
407
408    #[cfg(not(any(feature = "load-grammars", test)))]
409    {
410        config = LanguageConfig {
411            name: config.name,
412            matcher: config.matcher,
413            jsx_tag_auto_close: config.jsx_tag_auto_close,
414            ..Default::default()
415        }
416    }
417
418    config
419}
420
421fn load_queries(name: &str) -> LanguageQueries {
422    let mut result = LanguageQueries::default();
423    for path in LanguageDir::iter() {
424        if let Some(remainder) = path.strip_prefix(name).and_then(|p| p.strip_prefix('/')) {
425            if !remainder.ends_with(".scm") {
426                continue;
427            }
428            for (name, query) in QUERY_FILENAME_PREFIXES {
429                if remainder.starts_with(name) {
430                    let contents = asset_str::<LanguageDir>(path.as_ref());
431                    match query(&mut result) {
432                        None => *query(&mut result) = Some(contents),
433                        Some(r) => r.to_mut().push_str(contents.as_ref()),
434                    }
435                }
436            }
437        }
438    }
439    result
440}