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