lib.rs

  1use anyhow::Context as _;
  2use feature_flags::{FeatureFlag, FeatureFlagAppExt as _};
  3use gpui::{App, 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::default());
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.clone()));
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.clone()],
123            ..Default::default()
124        },
125        LanguageInfo {
126            name: "css",
127            adapters: vec![css_lsp_adapter.clone()],
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.clone()],
150            context: Some(go_context_provider.clone()),
151            ..Default::default()
152        },
153        LanguageInfo {
154            name: "json",
155            adapters: vec![json_lsp_adapter.clone(), node_version_lsp_adapter.clone()],
156            context: Some(json_context_provider.clone()),
157            ..Default::default()
158        },
159        LanguageInfo {
160            name: "jsonc",
161            adapters: vec![json_lsp_adapter.clone()],
162            context: Some(json_context_provider.clone()),
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.clone(), py_lsp_adapter.clone()],
178            context: Some(python_context_provider),
179            toolchain: Some(python_toolchain_provider),
180        },
181        LanguageInfo {
182            name: "rust",
183            adapters: vec![rust_lsp_adapter],
184            context: Some(rust_context_provider),
185            ..Default::default()
186        },
187        LanguageInfo {
188            name: "tsx",
189            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
190            context: Some(typescript_context.clone()),
191            ..Default::default()
192        },
193        LanguageInfo {
194            name: "typescript",
195            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
196            context: Some(typescript_context.clone()),
197            ..Default::default()
198        },
199        LanguageInfo {
200            name: "javascript",
201            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
202            context: Some(typescript_context.clone()),
203            ..Default::default()
204        },
205        LanguageInfo {
206            name: "jsdoc",
207            adapters: vec![typescript_lsp_adapter.clone(), vtsls_adapter.clone()],
208            ..Default::default()
209        },
210        LanguageInfo {
211            name: "regex",
212            adapters: vec![],
213            ..Default::default()
214        },
215        LanguageInfo {
216            name: "yaml",
217            adapters: vec![yaml_lsp_adapter],
218            ..Default::default()
219        },
220        LanguageInfo {
221            name: "gitcommit",
222            ..Default::default()
223        },
224        LanguageInfo {
225            name: "zed-keybind-context",
226            ..Default::default()
227        },
228    ];
229
230    for registration in built_in_languages {
231        register_language(
232            &languages,
233            registration.name,
234            registration.adapters,
235            registration.context,
236            registration.toolchain,
237        );
238    }
239
240    let mut basedpyright_lsp_adapter = Some(basedpyright_lsp_adapter);
241    cx.observe_flag::<BasedPyrightFeatureFlag, _>({
242        let languages = languages.clone();
243        move |enabled, _| {
244            if enabled {
245                if let Some(adapter) = basedpyright_lsp_adapter.take() {
246                    languages
247                        .register_available_lsp_adapter(adapter.name(), move || adapter.clone());
248                }
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.clone();
281        move || adapter.clone()
282    });
283    languages.register_available_lsp_adapter(
284        LanguageServerName("typescript-language-server".into()),
285        {
286            let adapter = typescript_lsp_adapter.clone();
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        "HEEX",
301        "HTML",
302        "JavaScript",
303        "PHP",
304        "Svelte",
305        "TSX",
306        "Vue.js",
307    ];
308
309    for language in tailwind_languages {
310        languages.register_lsp_adapter(language.into(), tailwind_adapter.clone());
311    }
312
313    let eslint_languages = ["TSX", "TypeScript", "JavaScript", "Vue.js", "Svelte"];
314    for language in eslint_languages {
315        languages.register_lsp_adapter(language.into(), eslint_adapter.clone());
316    }
317
318    let mut subscription = languages.subscribe();
319    let mut prev_language_settings = languages.language_settings();
320
321    cx.spawn(async move |cx| {
322        while subscription.next().await.is_some() {
323            let language_settings = languages.language_settings();
324            if language_settings != prev_language_settings {
325                cx.update(|cx| {
326                    SettingsStore::update_global(cx, |settings, cx| {
327                        settings
328                            .set_extension_settings(language_settings.clone(), cx)
329                            .log_err();
330                    });
331                })?;
332                prev_language_settings = language_settings;
333            }
334        }
335        anyhow::Ok(())
336    })
337    .detach();
338    let manifest_providers: [Arc<dyn ManifestProvider>; 2] = [
339        Arc::from(CargoManifestProvider),
340        Arc::from(PyprojectTomlManifestProvider),
341    ];
342    for provider in manifest_providers {
343        project::ManifestProviders::global(cx).register(provider);
344    }
345}
346
347#[derive(Default)]
348struct LanguageInfo {
349    name: &'static str,
350    adapters: Vec<Arc<dyn LspAdapter>>,
351    context: Option<Arc<dyn ContextProvider>>,
352    toolchain: Option<Arc<dyn ToolchainLister>>,
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) {
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        Arc::new(move || {
372            Ok(LoadedLanguage {
373                config: config.clone(),
374                queries: load_queries(name),
375                context_provider: context.clone(),
376                toolchain_provider: toolchain.clone(),
377            })
378        }),
379    );
380}
381
382#[cfg(any(test, feature = "test-support"))]
383pub fn language(name: &str, grammar: tree_sitter::Language) -> Arc<Language> {
384    Arc::new(
385        Language::new(load_config(name), Some(grammar))
386            .with_queries(load_queries(name))
387            .unwrap(),
388    )
389}
390
391fn load_config(name: &str) -> LanguageConfig {
392    let config_toml = String::from_utf8(
393        LanguageDir::get(&format!("{}/config.toml", name))
394            .unwrap_or_else(|| panic!("missing config for language {:?}", name))
395            .data
396            .to_vec(),
397    )
398    .unwrap();
399
400    #[allow(unused_mut)]
401    let mut config: LanguageConfig = ::toml::from_str(&config_toml)
402        .with_context(|| format!("failed to load config.toml for language {name:?}"))
403        .unwrap();
404
405    #[cfg(not(any(feature = "load-grammars", test)))]
406    {
407        config = LanguageConfig {
408            name: config.name,
409            matcher: config.matcher,
410            jsx_tag_auto_close: config.jsx_tag_auto_close,
411            ..Default::default()
412        }
413    }
414
415    config
416}
417
418fn load_queries(name: &str) -> LanguageQueries {
419    let mut result = LanguageQueries::default();
420    for path in LanguageDir::iter() {
421        if let Some(remainder) = path.strip_prefix(name).and_then(|p| p.strip_prefix('/')) {
422            if !remainder.ends_with(".scm") {
423                continue;
424            }
425            for (name, query) in QUERY_FILENAME_PREFIXES {
426                if remainder.starts_with(name) {
427                    let contents = asset_str::<LanguageDir>(path.as_ref());
428                    match query(&mut result) {
429                        None => *query(&mut result) = Some(contents),
430                        Some(r) => r.to_mut().push_str(contents.as_ref()),
431                    }
432                }
433            }
434        }
435    }
436    result
437}