lib.rs

  1use anyhow::Context as _;
  2use feature_flags::{FeatureFlag, FeatureFlagAppExt as _};
  3use gpui::{App, SharedString, UpdateGlobal};
  4use node_runtime::NodeRuntime;
  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::{json::JsonTaskProvider, python::BasedPyrightLspAdapter};
 16
 17mod bash;
 18mod c;
 19mod css;
 20mod github_download;
 21mod go;
 22mod json;
 23mod package_json;
 24mod python;
 25mod rust;
 26mod tailwind;
 27mod typescript;
 28mod vtsls;
 29mod yaml;
 30
 31pub(crate) use package_json::{PackageJson, PackageJsonData};
 32
 33#[derive(RustEmbed)]
 34#[folder = "src/"]
 35#[exclude = "*.rs"]
 36struct LanguageDir;
 37
 38/// A shared grammar for plain text, exposed for reuse by downstream crates.
 39#[cfg(feature = "tree-sitter-gitcommit")]
 40pub static LANGUAGE_GIT_COMMIT: std::sync::LazyLock<Arc<Language>> =
 41    std::sync::LazyLock::new(|| {
 42        Arc::new(Language::new(
 43            LanguageConfig {
 44                name: "Git Commit".into(),
 45                soft_wrap: Some(language::language_settings::SoftWrap::EditorWidth),
 46                matcher: LanguageMatcher {
 47                    path_suffixes: vec!["COMMIT_EDITMSG".to_owned()],
 48                    first_line_pattern: None,
 49                },
 50                line_comments: vec![Arc::from("#")],
 51                ..LanguageConfig::default()
 52            },
 53            Some(tree_sitter_gitcommit::LANGUAGE.into()),
 54        ))
 55    });
 56
 57struct BasedPyrightFeatureFlag;
 58
 59impl FeatureFlag for BasedPyrightFeatureFlag {
 60    const NAME: &'static str = "basedpyright";
 61}
 62
 63pub fn init(languages: Arc<LanguageRegistry>, 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(typescript::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(node.clone(), languages.clone()));
 95    let node_version_lsp_adapter = Arc::new(json::NodeVersionAdapter);
 96    let py_lsp_adapter = Arc::new(python::PyLspAdapter::new());
 97    let python_context_provider = Arc::new(python::PythonContextProvider);
 98    let python_lsp_adapter = Arc::new(python::PythonLspAdapter::new(node.clone()));
 99    let basedpyright_lsp_adapter = Arc::new(BasedPyrightLspAdapter::new());
100    let python_toolchain_provider = Arc::new(python::PythonToolchainProvider);
101    let rust_context_provider = Arc::new(rust::RustContextProvider);
102    let rust_lsp_adapter = Arc::new(rust::RustLspAdapter);
103    let tailwind_adapter = Arc::new(tailwind::TailwindLspAdapter::new(node.clone()));
104    let typescript_context = Arc::new(typescript::TypeScriptContextProvider::new());
105    let typescript_lsp_adapter = Arc::new(typescript::TypeScriptLspAdapter::new(node.clone()));
106    let vtsls_adapter = Arc::new(vtsls::VtslsLspAdapter::new(node.clone()));
107    let yaml_lsp_adapter = Arc::new(yaml::YamlLspAdapter::new(node));
108
109    let built_in_languages = [
110        LanguageInfo {
111            name: "bash",
112            context: Some(Arc::new(bash::bash_task_context())),
113            ..Default::default()
114        },
115        LanguageInfo {
116            name: "c",
117            adapters: vec![c_lsp_adapter.clone()],
118            ..Default::default()
119        },
120        LanguageInfo {
121            name: "cpp",
122            adapters: vec![c_lsp_adapter],
123            ..Default::default()
124        },
125        LanguageInfo {
126            name: "css",
127            adapters: vec![css_lsp_adapter],
128            ..Default::default()
129        },
130        LanguageInfo {
131            name: "diff",
132            adapters: vec![],
133            ..Default::default()
134        },
135        LanguageInfo {
136            name: "go",
137            adapters: vec![go_lsp_adapter.clone()],
138            context: Some(go_context_provider.clone()),
139            ..Default::default()
140        },
141        LanguageInfo {
142            name: "gomod",
143            adapters: vec![go_lsp_adapter.clone()],
144            context: Some(go_context_provider.clone()),
145            ..Default::default()
146        },
147        LanguageInfo {
148            name: "gowork",
149            adapters: vec![go_lsp_adapter],
150            context: Some(go_context_provider),
151            ..Default::default()
152        },
153        LanguageInfo {
154            name: "json",
155            adapters: vec![json_lsp_adapter.clone(), node_version_lsp_adapter],
156            context: Some(json_context_provider.clone()),
157            ..Default::default()
158        },
159        LanguageInfo {
160            name: "jsonc",
161            adapters: vec![json_lsp_adapter],
162            context: Some(json_context_provider),
163            ..Default::default()
164        },
165        LanguageInfo {
166            name: "markdown",
167            adapters: vec![],
168            ..Default::default()
169        },
170        LanguageInfo {
171            name: "markdown-inline",
172            adapters: vec![],
173            ..Default::default()
174        },
175        LanguageInfo {
176            name: "python",
177            adapters: vec![python_lsp_adapter, py_lsp_adapter],
178            context: Some(python_context_provider),
179            toolchain: Some(python_toolchain_provider),
180            manifest_name: Some(SharedString::new_static("pyproject.toml").into()),
181        },
182        LanguageInfo {
183            name: "rust",
184            adapters: vec![rust_lsp_adapter],
185            context: Some(rust_context_provider),
186            manifest_name: Some(SharedString::new_static("Cargo.toml").into()),
187            ..Default::default()
188        },
189        LanguageInfo {
190            name: "tsx",
191            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
192            context: Some(typescript_context.clone()),
193            ..Default::default()
194        },
195        LanguageInfo {
196            name: "typescript",
197            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
198            context: Some(typescript_context.clone()),
199            ..Default::default()
200        },
201        LanguageInfo {
202            name: "javascript",
203            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
204            context: Some(typescript_context),
205            ..Default::default()
206        },
207        LanguageInfo {
208            name: "jsdoc",
209            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
210            ..Default::default()
211        },
212        LanguageInfo {
213            name: "regex",
214            adapters: vec![],
215            ..Default::default()
216        },
217        LanguageInfo {
218            name: "yaml",
219            adapters: vec![yaml_lsp_adapter],
220            ..Default::default()
221        },
222        LanguageInfo {
223            name: "gitcommit",
224            ..Default::default()
225        },
226        LanguageInfo {
227            name: "zed-keybind-context",
228            ..Default::default()
229        },
230    ];
231
232    for registration in built_in_languages {
233        register_language(
234            &languages,
235            registration.name,
236            registration.adapters,
237            registration.context,
238            registration.toolchain,
239            registration.manifest_name,
240        );
241    }
242
243    let mut basedpyright_lsp_adapter = Some(basedpyright_lsp_adapter);
244    cx.observe_flag::<BasedPyrightFeatureFlag, _>({
245        let languages = languages.clone();
246        move |enabled, _| {
247            if enabled && let Some(adapter) = basedpyright_lsp_adapter.take() {
248                languages.register_available_lsp_adapter(adapter.name(), move || adapter.clone());
249            }
250        }
251    })
252    .detach();
253
254    // Register globally available language servers.
255    //
256    // This will allow users to add support for a built-in language server (e.g., Tailwind)
257    // for a given language via the `language_servers` setting:
258    //
259    // ```json
260    // {
261    //   "languages": {
262    //     "My Language": {
263    //       "language_servers": ["tailwindcss-language-server", "..."]
264    //     }
265    //   }
266    // }
267    // ```
268    languages.register_available_lsp_adapter(
269        LanguageServerName("tailwindcss-language-server".into()),
270        {
271            let adapter = tailwind_adapter.clone();
272            move || adapter.clone()
273        },
274    );
275    languages.register_available_lsp_adapter(LanguageServerName("eslint".into()), {
276        let adapter = eslint_adapter.clone();
277        move || adapter.clone()
278    });
279    languages.register_available_lsp_adapter(LanguageServerName("vtsls".into()), {
280        let adapter = vtsls_adapter;
281        move || adapter.clone()
282    });
283    languages.register_available_lsp_adapter(
284        LanguageServerName("typescript-language-server".into()),
285        {
286            let adapter = typescript_lsp_adapter;
287            move || adapter.clone()
288        },
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        "HTML/ERB",
301        "HEEX",
302        "HTML",
303        "JavaScript",
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(language_settings.clone(), cx)
330                            .log_err();
331                    });
332                })?;
333                prev_language_settings = language_settings;
334            }
335        }
336        anyhow::Ok(())
337    })
338    .detach();
339    let manifest_providers: [Arc<dyn ManifestProvider>; 2] = [
340        Arc::from(CargoManifestProvider),
341        Arc::from(PyprojectTomlManifestProvider),
342    ];
343    for provider in manifest_providers {
344        project::ManifestProvidersStore::global(cx).register(provider);
345    }
346}
347
348#[derive(Default)]
349struct LanguageInfo {
350    name: &'static str,
351    adapters: Vec<Arc<dyn LspAdapter>>,
352    context: Option<Arc<dyn ContextProvider>>,
353    toolchain: Option<Arc<dyn ToolchainLister>>,
354    manifest_name: Option<ManifestName>,
355}
356
357fn register_language(
358    languages: &LanguageRegistry,
359    name: &'static str,
360    adapters: Vec<Arc<dyn LspAdapter>>,
361    context: Option<Arc<dyn ContextProvider>>,
362    toolchain: Option<Arc<dyn ToolchainLister>>,
363    manifest_name: Option<ManifestName>,
364) {
365    let config = load_config(name);
366    for adapter in adapters {
367        languages.register_lsp_adapter(config.name.clone(), adapter);
368    }
369    languages.register_language(
370        config.name.clone(),
371        config.grammar.clone(),
372        config.matcher.clone(),
373        config.hidden,
374        manifest_name.clone(),
375        Arc::new(move || {
376            Ok(LoadedLanguage {
377                config: config.clone(),
378                queries: load_queries(name),
379                context_provider: context.clone(),
380                toolchain_provider: toolchain.clone(),
381                manifest_name: manifest_name.clone(),
382            })
383        }),
384    );
385}
386
387#[cfg(any(test, feature = "test-support"))]
388pub fn language(name: &str, grammar: tree_sitter::Language) -> Arc<Language> {
389    Arc::new(
390        Language::new(load_config(name), Some(grammar))
391            .with_queries(load_queries(name))
392            .unwrap(),
393    )
394}
395
396fn load_config(name: &str) -> LanguageConfig {
397    let config_toml = String::from_utf8(
398        LanguageDir::get(&format!("{}/config.toml", name))
399            .unwrap_or_else(|| panic!("missing config for language {:?}", name))
400            .data
401            .to_vec(),
402    )
403    .unwrap();
404
405    #[allow(unused_mut)]
406    let mut config: LanguageConfig = ::toml::from_str(&config_toml)
407        .with_context(|| format!("failed to load config.toml for language {name:?}"))
408        .unwrap();
409
410    #[cfg(not(any(feature = "load-grammars", test)))]
411    {
412        config = LanguageConfig {
413            name: config.name,
414            matcher: config.matcher,
415            jsx_tag_auto_close: config.jsx_tag_auto_close,
416            ..Default::default()
417        }
418    }
419
420    config
421}
422
423fn load_queries(name: &str) -> LanguageQueries {
424    let mut result = LanguageQueries::default();
425    for path in LanguageDir::iter() {
426        if let Some(remainder) = path.strip_prefix(name).and_then(|p| p.strip_prefix('/')) {
427            if !remainder.ends_with(".scm") {
428                continue;
429            }
430            for (name, query) in QUERY_FILENAME_PREFIXES {
431                if remainder.starts_with(name) {
432                    let contents = asset_str::<LanguageDir>(path.as_ref());
433                    match query(&mut result) {
434                        None => *query(&mut result) = Some(contents),
435                        Some(r) => r.to_mut().push_str(contents.as_ref()),
436                    }
437                }
438            }
439        }
440    }
441    result
442}