lib.rs

  1use anyhow::Context;
  2use gpui::{AppContext, BorrowAppContext};
  3pub use language::*;
  4use node_runtime::NodeRuntime;
  5use rust_embed::RustEmbed;
  6use settings::{Settings, SettingsStore};
  7use smol::stream::StreamExt;
  8use std::{str, sync::Arc};
  9use util::{asset_str, ResultExt};
 10
 11use crate::{
 12    bash::bash_task_context, elixir::elixir_task_context, python::python_task_context,
 13    rust::RustContextProvider,
 14};
 15
 16use self::{deno::DenoSettings, elixir::ElixirSettings};
 17
 18mod bash;
 19mod c;
 20mod css;
 21mod deno;
 22mod elixir;
 23mod go;
 24mod json;
 25mod python;
 26mod ruby;
 27mod rust;
 28mod tailwind;
 29mod typescript;
 30mod yaml;
 31
 32// 1. Add tree-sitter-{language} parser to zed crate
 33// 2. Create a language directory in zed/crates/zed/src/languages and add the language to init function below
 34// 3. Add config.toml to the newly created language directory using existing languages as a template
 35// 4. Copy highlights from tree sitter repo for the language into a highlights.scm file.
 36//      Note: github highlights take the last match while zed takes the first
 37// 5. Add indents.scm, outline.scm, and brackets.scm to implement indent on newline, outline/breadcrumbs,
 38//    and autoclosing brackets respectively
 39// 6. If the language has injections add an injections.scm query file
 40
 41#[derive(RustEmbed)]
 42#[folder = "src/"]
 43#[exclude = "*.rs"]
 44struct LanguageDir;
 45
 46pub fn init(
 47    languages: Arc<LanguageRegistry>,
 48    node_runtime: Arc<dyn NodeRuntime>,
 49    cx: &mut AppContext,
 50) {
 51    ElixirSettings::register(cx);
 52    DenoSettings::register(cx);
 53
 54    languages.register_native_grammars([
 55        ("bash", tree_sitter_bash::language()),
 56        ("c", tree_sitter_c::language()),
 57        ("cpp", tree_sitter_cpp::language()),
 58        ("css", tree_sitter_css::language()),
 59        ("elixir", tree_sitter_elixir::language()),
 60        (
 61            "embedded_template",
 62            tree_sitter_embedded_template::language(),
 63        ),
 64        ("go", tree_sitter_go::language()),
 65        ("gomod", tree_sitter_gomod::language()),
 66        ("gowork", tree_sitter_gowork::language()),
 67        ("heex", tree_sitter_heex::language()),
 68        ("jsdoc", tree_sitter_jsdoc::language()),
 69        ("json", tree_sitter_json::language()),
 70        ("markdown", tree_sitter_markdown::language()),
 71        ("proto", tree_sitter_proto::language()),
 72        ("python", tree_sitter_python::language()),
 73        ("regex", tree_sitter_regex::language()),
 74        ("ruby", tree_sitter_ruby::language()),
 75        ("rust", tree_sitter_rust::language()),
 76        ("tsx", tree_sitter_typescript::language_tsx()),
 77        ("typescript", tree_sitter_typescript::language_typescript()),
 78        ("yaml", tree_sitter_yaml::language()),
 79    ]);
 80
 81    macro_rules! language {
 82        ($name:literal) => {
 83            let config = load_config($name);
 84            languages.register_language(
 85                config.name.clone(),
 86                config.grammar.clone(),
 87                config.matcher.clone(),
 88                move || {
 89                    Ok((
 90                        config.clone(),
 91                        load_queries($name),
 92                        Some(Arc::new(language::BasicContextProvider)),
 93                    ))
 94                },
 95            );
 96        };
 97        ($name:literal, $adapters:expr) => {
 98            let config = load_config($name);
 99            // typeck helper
100            let adapters: Vec<Arc<dyn LspAdapter>> = $adapters;
101            for adapter in adapters {
102                languages.register_lsp_adapter(config.name.clone(), adapter);
103            }
104            languages.register_language(
105                config.name.clone(),
106                config.grammar.clone(),
107                config.matcher.clone(),
108                move || {
109                    Ok((
110                        config.clone(),
111                        load_queries($name),
112                        Some(Arc::new(language::BasicContextProvider)),
113                    ))
114                },
115            );
116        };
117        ($name:literal, $adapters:expr, $context_provider:expr) => {
118            let config = load_config($name);
119            // typeck helper
120            let adapters: Vec<Arc<dyn LspAdapter>> = $adapters;
121            for adapter in adapters {
122                languages.register_lsp_adapter(config.name.clone(), adapter);
123            }
124            languages.register_language(
125                config.name.clone(),
126                config.grammar.clone(),
127                config.matcher.clone(),
128                move || {
129                    Ok((
130                        config.clone(),
131                        load_queries($name),
132                        Some(Arc::new($context_provider)),
133                    ))
134                },
135            );
136        };
137    }
138    language!("bash", Vec::new(), bash_task_context());
139    language!("c", vec![Arc::new(c::CLspAdapter) as Arc<dyn LspAdapter>]);
140    language!("cpp", vec![Arc::new(c::CLspAdapter)]);
141    language!(
142        "css",
143        vec![
144            Arc::new(css::CssLspAdapter::new(node_runtime.clone())),
145            Arc::new(tailwind::TailwindLspAdapter::new(node_runtime.clone())),
146        ]
147    );
148
149    match &ElixirSettings::get(None, cx).lsp {
150        elixir::ElixirLspSetting::ElixirLs => {
151            language!(
152                "elixir",
153                vec![
154                    Arc::new(elixir::ElixirLspAdapter),
155                    Arc::new(tailwind::TailwindLspAdapter::new(node_runtime.clone())),
156                ],
157                elixir_task_context()
158            );
159        }
160        elixir::ElixirLspSetting::NextLs => {
161            language!(
162                "elixir",
163                vec![Arc::new(elixir::NextLspAdapter)],
164                elixir_task_context()
165            );
166        }
167        elixir::ElixirLspSetting::Local { path, arguments } => {
168            language!(
169                "elixir",
170                vec![Arc::new(elixir::LocalLspAdapter {
171                    path: path.clone(),
172                    arguments: arguments.clone(),
173                })],
174                elixir_task_context()
175            );
176        }
177    }
178    language!("go", vec![Arc::new(go::GoLspAdapter)]);
179    language!("gomod");
180    language!("gowork");
181    language!(
182        "heex",
183        vec![
184            Arc::new(elixir::ElixirLspAdapter),
185            Arc::new(tailwind::TailwindLspAdapter::new(node_runtime.clone())),
186        ]
187    );
188    language!(
189        "json",
190        vec![Arc::new(json::JsonLspAdapter::new(
191            node_runtime.clone(),
192            languages.clone(),
193        ))]
194    );
195    language!("markdown");
196    language!(
197        "python",
198        vec![Arc::new(python::PythonLspAdapter::new(
199            node_runtime.clone(),
200        ))],
201        python_task_context()
202    );
203    language!(
204        "rust",
205        vec![Arc::new(rust::RustLspAdapter)],
206        RustContextProvider
207    );
208    match &DenoSettings::get(None, cx).enable {
209        true => {
210            language!(
211                "tsx",
212                vec![
213                    Arc::new(deno::DenoLspAdapter::new()),
214                    Arc::new(tailwind::TailwindLspAdapter::new(node_runtime.clone())),
215                ]
216            );
217            language!("typescript", vec![Arc::new(deno::DenoLspAdapter::new())]);
218            language!(
219                "javascript",
220                vec![
221                    Arc::new(deno::DenoLspAdapter::new()),
222                    Arc::new(tailwind::TailwindLspAdapter::new(node_runtime.clone())),
223                ]
224            );
225            language!("jsdoc", vec![Arc::new(deno::DenoLspAdapter::new())]);
226        }
227        false => {
228            language!(
229                "tsx",
230                vec![
231                    Arc::new(typescript::TypeScriptLspAdapter::new(node_runtime.clone())),
232                    Arc::new(typescript::EsLintLspAdapter::new(node_runtime.clone())),
233                    Arc::new(tailwind::TailwindLspAdapter::new(node_runtime.clone())),
234                ]
235            );
236            language!(
237                "typescript",
238                vec![
239                    Arc::new(typescript::TypeScriptLspAdapter::new(node_runtime.clone())),
240                    Arc::new(typescript::EsLintLspAdapter::new(node_runtime.clone())),
241                ]
242            );
243            language!(
244                "javascript",
245                vec![
246                    Arc::new(typescript::TypeScriptLspAdapter::new(node_runtime.clone())),
247                    Arc::new(typescript::EsLintLspAdapter::new(node_runtime.clone())),
248                    Arc::new(tailwind::TailwindLspAdapter::new(node_runtime.clone())),
249                ]
250            );
251            language!(
252                "jsdoc",
253                vec![Arc::new(typescript::TypeScriptLspAdapter::new(
254                    node_runtime.clone(),
255                ))]
256            );
257        }
258    }
259
260    language!("ruby", vec![Arc::new(ruby::RubyLanguageServer)]);
261    language!(
262        "erb",
263        vec![
264            Arc::new(ruby::RubyLanguageServer),
265            Arc::new(tailwind::TailwindLspAdapter::new(node_runtime.clone())),
266        ]
267    );
268    language!("regex");
269    language!(
270        "yaml",
271        vec![Arc::new(yaml::YamlLspAdapter::new(node_runtime.clone()))]
272    );
273    language!("proto");
274
275    languages.register_secondary_lsp_adapter(
276        "Astro".into(),
277        Arc::new(tailwind::TailwindLspAdapter::new(node_runtime.clone())),
278    );
279    languages.register_secondary_lsp_adapter(
280        "HTML".into(),
281        Arc::new(tailwind::TailwindLspAdapter::new(node_runtime.clone())),
282    );
283    languages.register_secondary_lsp_adapter(
284        "PHP".into(),
285        Arc::new(tailwind::TailwindLspAdapter::new(node_runtime.clone())),
286    );
287    languages.register_secondary_lsp_adapter(
288        "Svelte".into(),
289        Arc::new(tailwind::TailwindLspAdapter::new(node_runtime.clone())),
290    );
291    languages.register_secondary_lsp_adapter(
292        "Vue.js".into(),
293        Arc::new(tailwind::TailwindLspAdapter::new(node_runtime.clone())),
294    );
295
296    let mut subscription = languages.subscribe();
297    let mut prev_language_settings = languages.language_settings();
298
299    cx.spawn(|cx| async move {
300        while subscription.next().await.is_some() {
301            let language_settings = languages.language_settings();
302            if language_settings != prev_language_settings {
303                cx.update(|cx| {
304                    cx.update_global(|settings: &mut SettingsStore, cx| {
305                        settings
306                            .set_extension_settings(language_settings.clone(), cx)
307                            .log_err();
308                    });
309                })?;
310                prev_language_settings = language_settings;
311            }
312        }
313        anyhow::Ok(())
314    })
315    .detach();
316}
317
318#[cfg(any(test, feature = "test-support"))]
319pub fn language(name: &str, grammar: tree_sitter::Language) -> Arc<Language> {
320    Arc::new(
321        Language::new(load_config(name), Some(grammar))
322            .with_queries(load_queries(name))
323            .unwrap(),
324    )
325}
326
327fn load_config(name: &str) -> LanguageConfig {
328    let config_toml = String::from_utf8(
329        LanguageDir::get(&format!("{}/config.toml", name))
330            .unwrap()
331            .data
332            .to_vec(),
333    )
334    .unwrap();
335
336    ::toml::from_str(&config_toml)
337        .with_context(|| format!("failed to load config.toml for language {name:?}"))
338        .unwrap()
339}
340
341fn load_queries(name: &str) -> LanguageQueries {
342    let mut result = LanguageQueries::default();
343    for path in LanguageDir::iter() {
344        if let Some(remainder) = path.strip_prefix(name).and_then(|p| p.strip_prefix('/')) {
345            if !remainder.ends_with(".scm") {
346                continue;
347            }
348            for (name, query) in QUERY_FILENAME_PREFIXES {
349                if remainder.starts_with(name) {
350                    let contents = asset_str::<LanguageDir>(path.as_ref());
351                    match query(&mut result) {
352                        None => *query(&mut result) = Some(contents),
353                        Some(r) => r.to_mut().push_str(contents.as_ref()),
354                    }
355                }
356            }
357        }
358    }
359    result
360}