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