yaml.rs

  1use anyhow::{Context as _, Result};
  2use async_trait::async_trait;
  3use futures::StreamExt;
  4use gpui::AsyncApp;
  5use language::{
  6    LanguageToolchainStore, LspAdapter, LspAdapterDelegate, language_settings::AllLanguageSettings,
  7};
  8use lsp::{LanguageServerBinary, LanguageServerName};
  9use node_runtime::{NodeRuntime, VersionStrategy};
 10use project::{Fs, lsp_store::language_server_settings};
 11use serde_json::Value;
 12use settings::{Settings, SettingsLocation};
 13use smol::fs;
 14use std::{
 15    any::Any,
 16    ffi::OsString,
 17    path::{Path, PathBuf},
 18    sync::Arc,
 19};
 20use util::{ResultExt, maybe, merge_json_value_into};
 21
 22const SERVER_PATH: &str = "node_modules/yaml-language-server/bin/yaml-language-server";
 23
 24fn server_binary_arguments(server_path: &Path) -> Vec<OsString> {
 25    vec![server_path.into(), "--stdio".into()]
 26}
 27
 28pub struct YamlLspAdapter {
 29    node: NodeRuntime,
 30}
 31
 32impl YamlLspAdapter {
 33    const SERVER_NAME: LanguageServerName = LanguageServerName::new_static("yaml-language-server");
 34    const PACKAGE_NAME: &str = "yaml-language-server";
 35    pub fn new(node: NodeRuntime) -> Self {
 36        YamlLspAdapter { node }
 37    }
 38}
 39
 40#[async_trait(?Send)]
 41impl LspAdapter for YamlLspAdapter {
 42    fn name(&self) -> LanguageServerName {
 43        Self::SERVER_NAME.clone()
 44    }
 45
 46    async fn fetch_latest_server_version(
 47        &self,
 48        _: &dyn LspAdapterDelegate,
 49    ) -> Result<Box<dyn 'static + Any + Send>> {
 50        Ok(Box::new(
 51            self.node
 52                .npm_package_latest_version("yaml-language-server")
 53                .await?,
 54        ) as Box<_>)
 55    }
 56
 57    async fn check_if_user_installed(
 58        &self,
 59        delegate: &dyn LspAdapterDelegate,
 60        _: Arc<dyn LanguageToolchainStore>,
 61        _: &AsyncApp,
 62    ) -> Option<LanguageServerBinary> {
 63        let path = delegate.which(Self::SERVER_NAME.as_ref()).await?;
 64        let env = delegate.shell_env().await;
 65
 66        Some(LanguageServerBinary {
 67            path,
 68            env: Some(env),
 69            arguments: vec!["--stdio".into()],
 70        })
 71    }
 72
 73    async fn fetch_server_binary(
 74        &self,
 75        latest_version: Box<dyn 'static + Send + Any>,
 76        container_dir: PathBuf,
 77        _: &dyn LspAdapterDelegate,
 78    ) -> Result<LanguageServerBinary> {
 79        let latest_version = latest_version.downcast::<String>().unwrap();
 80        let server_path = container_dir.join(SERVER_PATH);
 81
 82        self.node
 83            .npm_install_packages(
 84                &container_dir,
 85                &[(Self::PACKAGE_NAME, latest_version.as_str())],
 86            )
 87            .await?;
 88
 89        Ok(LanguageServerBinary {
 90            path: self.node.binary_path().await?,
 91            env: None,
 92            arguments: server_binary_arguments(&server_path),
 93        })
 94    }
 95
 96    async fn check_if_version_installed(
 97        &self,
 98        version: &(dyn 'static + Send + Any),
 99        container_dir: &PathBuf,
100        _: &dyn LspAdapterDelegate,
101    ) -> Option<LanguageServerBinary> {
102        let version = version.downcast_ref::<String>().unwrap();
103        let server_path = container_dir.join(SERVER_PATH);
104
105        let should_install_language_server = self
106            .node
107            .should_install_npm_package(
108                Self::PACKAGE_NAME,
109                &server_path,
110                &container_dir,
111                VersionStrategy::Latest(version),
112            )
113            .await;
114
115        if should_install_language_server {
116            None
117        } else {
118            Some(LanguageServerBinary {
119                path: self.node.binary_path().await.ok()?,
120                env: None,
121                arguments: server_binary_arguments(&server_path),
122            })
123        }
124    }
125
126    async fn cached_server_binary(
127        &self,
128        container_dir: PathBuf,
129        _: &dyn LspAdapterDelegate,
130    ) -> Option<LanguageServerBinary> {
131        get_cached_server_binary(container_dir, &self.node).await
132    }
133
134    async fn workspace_configuration(
135        self: Arc<Self>,
136        _: &dyn Fs,
137        delegate: &Arc<dyn LspAdapterDelegate>,
138        _: Arc<dyn LanguageToolchainStore>,
139        cx: &mut AsyncApp,
140    ) -> Result<Value> {
141        let location = SettingsLocation {
142            worktree_id: delegate.worktree_id(),
143            path: delegate.worktree_root_path(),
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 mut last_version_dir = None;
174        let mut entries = fs::read_dir(&container_dir).await?;
175        while let Some(entry) = entries.next().await {
176            let entry = entry?;
177            if entry.file_type().await?.is_dir() {
178                last_version_dir = Some(entry.path());
179            }
180        }
181        let last_version_dir = last_version_dir.context("no cached binary")?;
182        let server_path = last_version_dir.join(SERVER_PATH);
183        anyhow::ensure!(
184            server_path.exists(),
185            "missing executable in directory {last_version_dir:?}"
186        );
187        Ok(LanguageServerBinary {
188            path: node.binary_path().await?,
189            env: None,
190            arguments: server_binary_arguments(&server_path),
191        })
192    })
193    .await
194    .log_err()
195}