yaml.rs

  1use anyhow::Result;
  2use async_trait::async_trait;
  3use gpui::AsyncApp;
  4use language::{
  5    LspAdapter, LspAdapterDelegate, LspInstaller, Toolchain, language_settings::AllLanguageSettings,
  6};
  7use lsp::{LanguageServerBinary, LanguageServerName, Uri};
  8use node_runtime::{NodeRuntime, VersionStrategy};
  9use project::lsp_store::language_server_settings;
 10use serde_json::Value;
 11use settings::{Settings, SettingsLocation};
 12use std::{
 13    ffi::OsString,
 14    path::{Path, PathBuf},
 15    sync::Arc,
 16};
 17use util::{ResultExt, maybe, merge_json_value_into, rel_path::RelPath};
 18
 19const SERVER_PATH: &str = "node_modules/yaml-language-server/bin/yaml-language-server";
 20
 21fn server_binary_arguments(server_path: &Path) -> Vec<OsString> {
 22    vec![server_path.into(), "--stdio".into()]
 23}
 24
 25pub struct YamlLspAdapter {
 26    node: NodeRuntime,
 27}
 28
 29impl YamlLspAdapter {
 30    const SERVER_NAME: LanguageServerName = LanguageServerName::new_static("yaml-language-server");
 31    const PACKAGE_NAME: &str = "yaml-language-server";
 32    pub fn new(node: NodeRuntime) -> Self {
 33        YamlLspAdapter { node }
 34    }
 35}
 36
 37impl LspInstaller for YamlLspAdapter {
 38    type BinaryVersion = String;
 39
 40    async fn fetch_latest_server_version(
 41        &self,
 42        _: &dyn LspAdapterDelegate,
 43        _: bool,
 44        _: &mut AsyncApp,
 45    ) -> Result<String> {
 46        self.node
 47            .npm_package_latest_version("yaml-language-server")
 48            .await
 49    }
 50
 51    async fn check_if_user_installed(
 52        &self,
 53        delegate: &dyn LspAdapterDelegate,
 54        _: Option<Toolchain>,
 55        _: &AsyncApp,
 56    ) -> Option<LanguageServerBinary> {
 57        let path = delegate.which(Self::SERVER_NAME.as_ref()).await?;
 58        let env = delegate.shell_env().await;
 59
 60        Some(LanguageServerBinary {
 61            path,
 62            env: Some(env),
 63            arguments: vec!["--stdio".into()],
 64        })
 65    }
 66
 67    async fn fetch_server_binary(
 68        &self,
 69        latest_version: String,
 70        container_dir: PathBuf,
 71        _: &dyn LspAdapterDelegate,
 72    ) -> Result<LanguageServerBinary> {
 73        let server_path = container_dir.join(SERVER_PATH);
 74
 75        self.node
 76            .npm_install_packages(
 77                &container_dir,
 78                &[(Self::PACKAGE_NAME, latest_version.as_str())],
 79            )
 80            .await?;
 81
 82        Ok(LanguageServerBinary {
 83            path: self.node.binary_path().await?,
 84            env: None,
 85            arguments: server_binary_arguments(&server_path),
 86        })
 87    }
 88
 89    async fn check_if_version_installed(
 90        &self,
 91        version: &String,
 92        container_dir: &PathBuf,
 93        _: &dyn LspAdapterDelegate,
 94    ) -> Option<LanguageServerBinary> {
 95        let server_path = container_dir.join(SERVER_PATH);
 96
 97        let should_install_language_server = self
 98            .node
 99            .should_install_npm_package(
100                Self::PACKAGE_NAME,
101                &server_path,
102                container_dir,
103                VersionStrategy::Latest(version),
104            )
105            .await;
106
107        if should_install_language_server {
108            None
109        } else {
110            Some(LanguageServerBinary {
111                path: self.node.binary_path().await.ok()?,
112                env: None,
113                arguments: server_binary_arguments(&server_path),
114            })
115        }
116    }
117
118    async fn cached_server_binary(
119        &self,
120        container_dir: PathBuf,
121        _: &dyn LspAdapterDelegate,
122    ) -> Option<LanguageServerBinary> {
123        get_cached_server_binary(container_dir, &self.node).await
124    }
125}
126
127#[async_trait(?Send)]
128impl LspAdapter for YamlLspAdapter {
129    fn name(&self) -> LanguageServerName {
130        Self::SERVER_NAME
131    }
132
133    async fn workspace_configuration(
134        self: Arc<Self>,
135        delegate: &Arc<dyn LspAdapterDelegate>,
136        _: Option<Toolchain>,
137        _: Option<Uri>,
138        cx: &mut AsyncApp,
139    ) -> Result<Value> {
140        let location = SettingsLocation {
141            worktree_id: delegate.worktree_id(),
142            path: RelPath::empty(),
143        };
144
145        let tab_size = cx.update(|cx| {
146            AllLanguageSettings::get(Some(location), cx)
147                .language(Some(location), Some(&"YAML".into()), cx)
148                .tab_size
149        })?;
150
151        let mut options = serde_json::json!({
152            "[yaml]": {"editor.tabSize": tab_size},
153            "yaml": {"format": {"enable": true}}
154        });
155
156        let project_options = cx.update(|cx| {
157            language_server_settings(delegate.as_ref(), &Self::SERVER_NAME, cx)
158                .and_then(|s| s.settings.clone())
159        })?;
160        if let Some(override_options) = project_options {
161            merge_json_value_into(override_options, &mut options);
162        }
163        Ok(options)
164    }
165}
166
167async fn get_cached_server_binary(
168    container_dir: PathBuf,
169    node: &NodeRuntime,
170) -> Option<LanguageServerBinary> {
171    maybe!(async {
172        let server_path = container_dir.join(SERVER_PATH);
173        anyhow::ensure!(
174            server_path.exists(),
175            "missing executable in directory {server_path:?}"
176        );
177        Ok(LanguageServerBinary {
178            path: node.binary_path().await?,
179            env: None,
180            arguments: server_binary_arguments(&server_path),
181        })
182    })
183    .await
184    .log_err()
185}