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