use collections::HashMap; use fs::Fs; use gpui::{AppContext, AsyncAppContext, BorrowAppContext, Model, ModelContext}; use paths::local_settings_file_relative_path; use rpc::{ proto::{self, AnyProtoClient}, TypedEnvelope, }; use schemars::JsonSchema; use serde::{Deserialize, Serialize}; use settings::{Settings, SettingsSources, SettingsStore}; use std::{ path::{Path, PathBuf}, sync::Arc, time::Duration, }; use util::ResultExt; use worktree::{PathChange, UpdatedEntriesSet, Worktree, WorktreeId}; use crate::worktree_store::{WorktreeStore, WorktreeStoreEvent}; #[derive(Debug, Clone, Default, Serialize, Deserialize, JsonSchema)] pub struct ProjectSettings { /// Configuration for language servers. /// /// The following settings can be overridden for specific language servers: /// - initialization_options /// /// To override settings for a language, add an entry for that language server's /// name to the lsp value. /// Default: null #[serde(default)] pub lsp: HashMap, LspSettings>, /// Configuration for Git-related features #[serde(default)] pub git: GitSettings, /// Configuration for how direnv configuration should be loaded #[serde(default)] pub load_direnv: DirenvSettings, /// Configuration for session-related features #[serde(default)] pub session: SessionSettings, } #[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)] #[serde(rename_all = "snake_case")] pub enum DirenvSettings { /// Load direnv configuration through a shell hook #[default] ShellHook, /// Load direnv configuration directly using `direnv export json` /// /// Warning: This option is experimental and might cause some inconsistent behavior compared to using the shell hook. /// If it does, please report it to GitHub Direct, } #[derive(Copy, Clone, Debug, Default, Serialize, Deserialize, JsonSchema)] pub struct GitSettings { /// Whether or not to show the git gutter. /// /// Default: tracked_files pub git_gutter: Option, pub gutter_debounce: Option, /// Whether or not to show git blame data inline in /// the currently focused line. /// /// Default: on pub inline_blame: Option, } impl GitSettings { pub fn inline_blame_enabled(&self) -> bool { #[allow(unknown_lints, clippy::manual_unwrap_or_default)] match self.inline_blame { Some(InlineBlameSettings { enabled, .. }) => enabled, _ => false, } } pub fn inline_blame_delay(&self) -> Option { match self.inline_blame { Some(InlineBlameSettings { delay_ms: Some(delay_ms), .. }) if delay_ms > 0 => Some(Duration::from_millis(delay_ms)), _ => None, } } } #[derive(Clone, Copy, Debug, Default, Serialize, Deserialize, JsonSchema)] #[serde(rename_all = "snake_case")] pub enum GitGutterSetting { /// Show git gutter in tracked files. #[default] TrackedFiles, /// Hide git gutter Hide, } #[derive(Clone, Copy, Debug, Default, Serialize, Deserialize, JsonSchema)] #[serde(rename_all = "snake_case")] pub struct InlineBlameSettings { /// Whether or not to show git blame data inline in /// the currently focused line. /// /// Default: true #[serde(default = "true_value")] pub enabled: bool, /// Whether to only show the inline blame information /// after a delay once the cursor stops moving. /// /// Default: 0 pub delay_ms: Option, /// The minimum column number to show the inline blame information at /// /// Default: 0 pub min_column: Option, } const fn true_value() -> bool { true } #[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq, Eq, JsonSchema)] pub struct BinarySettings { pub path: Option, pub arguments: Option>, pub path_lookup: Option, } #[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq, Eq, JsonSchema)] #[serde(rename_all = "snake_case")] pub struct LspSettings { pub binary: Option, pub initialization_options: Option, pub settings: Option, } #[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema)] pub struct SessionSettings { /// Whether or not to restore unsaved buffers on restart. /// /// If this is true, user won't be prompted whether to save/discard /// dirty files when closing the application. /// /// Default: true pub restore_unsaved_buffers: bool, } impl Default for SessionSettings { fn default() -> Self { Self { restore_unsaved_buffers: true, } } } impl Settings for ProjectSettings { const KEY: Option<&'static str> = None; type FileContent = Self; fn load( sources: SettingsSources, _: &mut AppContext, ) -> anyhow::Result { sources.json_merge() } } pub enum SettingsObserverMode { Local(Arc), Ssh(AnyProtoClient), Remote, } pub struct SettingsObserver { mode: SettingsObserverMode, downstream_client: Option, worktree_store: Model, project_id: u64, } /// SettingsObserver observers changes to .zed/settings.json files in local worktrees /// (or the equivalent protobuf messages from upstream) and updates local settings /// and sends notifications downstream. /// In ssh mode it also monitors ~/.config/zed/settings.json and sends the content /// upstream. impl SettingsObserver { pub fn init(client: &AnyProtoClient) { client.add_model_message_handler(Self::handle_update_worktree_settings); client.add_model_message_handler(Self::handle_update_user_settings) } pub fn new_local( fs: Arc, worktree_store: Model, cx: &mut ModelContext, ) -> Self { cx.subscribe(&worktree_store, Self::on_worktree_store_event) .detach(); Self { worktree_store, mode: SettingsObserverMode::Local(fs), downstream_client: None, project_id: 0, } } pub fn new_ssh( client: AnyProtoClient, worktree_store: Model, cx: &mut ModelContext, ) -> Self { let this = Self { worktree_store, mode: SettingsObserverMode::Ssh(client.clone()), downstream_client: None, project_id: 0, }; this.maintain_ssh_settings(client, cx); this } pub fn new_remote(worktree_store: Model, _: &mut ModelContext) -> Self { Self { worktree_store, mode: SettingsObserverMode::Remote, downstream_client: None, project_id: 0, } } pub fn shared( &mut self, project_id: u64, downstream_client: AnyProtoClient, cx: &mut ModelContext, ) { self.project_id = project_id; self.downstream_client = Some(downstream_client.clone()); let store = cx.global::(); for worktree in self.worktree_store.read(cx).worktrees() { let worktree_id = worktree.read(cx).id().to_proto(); for (path, content) in store.local_settings(worktree.read(cx).id()) { downstream_client .send(proto::UpdateWorktreeSettings { project_id, worktree_id, path: path.to_string_lossy().into(), content: Some(content), }) .log_err(); } } } pub fn unshared(&mut self, _: &mut ModelContext) { self.downstream_client = None; } async fn handle_update_worktree_settings( this: Model, envelope: TypedEnvelope, mut cx: AsyncAppContext, ) -> anyhow::Result<()> { this.update(&mut cx, |this, cx| { let worktree_id = WorktreeId::from_proto(envelope.payload.worktree_id); let Some(worktree) = this .worktree_store .read(cx) .worktree_for_id(worktree_id, cx) else { return; }; this.update_settings( worktree, [( PathBuf::from(&envelope.payload.path).into(), envelope.payload.content, )], cx, ); })?; Ok(()) } pub async fn handle_update_user_settings( _: Model, envelope: TypedEnvelope, mut cx: AsyncAppContext, ) -> anyhow::Result<()> { cx.update_global(move |settings_store: &mut SettingsStore, cx| { settings_store.set_user_settings(&envelope.payload.content, cx) })??; Ok(()) } pub fn maintain_ssh_settings(&self, ssh: AnyProtoClient, cx: &mut ModelContext) { let mut settings = cx.global::().raw_user_settings().clone(); if let Some(content) = serde_json::to_string(&settings).log_err() { ssh.send(proto::UpdateUserSettings { project_id: 0, content, }) .log_err(); } cx.observe_global::(move |_, cx| { let new_settings = cx.global::().raw_user_settings(); if &settings != new_settings { settings = new_settings.clone() } if let Some(content) = serde_json::to_string(&settings).log_err() { ssh.send(proto::UpdateUserSettings { project_id: 0, content, }) .log_err(); } }) .detach(); } fn on_worktree_store_event( &mut self, _: Model, event: &WorktreeStoreEvent, cx: &mut ModelContext, ) { if let WorktreeStoreEvent::WorktreeAdded(worktree) = event { cx.subscribe(worktree, |this, worktree, event, cx| { if let worktree::Event::UpdatedEntries(changes) = event { this.update_local_worktree_settings(&worktree, changes, cx) } }) .detach() } } fn update_local_worktree_settings( &mut self, worktree: &Model, changes: &UpdatedEntriesSet, cx: &mut ModelContext, ) { let SettingsObserverMode::Local(fs) = &self.mode else { return; }; let mut settings_contents = Vec::new(); for (path, _, change) in changes.iter() { let removed = change == &PathChange::Removed; let abs_path = match worktree.read(cx).absolutize(path) { Ok(abs_path) => abs_path, Err(e) => { log::warn!("Cannot absolutize {path:?} received as {change:?} FS change: {e}"); continue; } }; if path.ends_with(local_settings_file_relative_path()) { let settings_dir = Arc::from( path.ancestors() .nth(local_settings_file_relative_path().components().count()) .unwrap(), ); let fs = fs.clone(); settings_contents.push(async move { ( settings_dir, if removed { None } else { Some(async move { fs.load(&abs_path).await }.await) }, ) }); } } if settings_contents.is_empty() { return; } let worktree = worktree.clone(); cx.spawn(move |this, cx| async move { let settings_contents: Vec<(Arc, _)> = futures::future::join_all(settings_contents).await; cx.update(|cx| { this.update(cx, |this, cx| { this.update_settings( worktree, settings_contents .into_iter() .map(|(path, content)| (path, content.and_then(|c| c.log_err()))), cx, ) }) }) }) .detach(); } fn update_settings( &mut self, worktree: Model, settings_contents: impl IntoIterator, Option)>, cx: &mut ModelContext, ) { let worktree_id = worktree.read(cx).id(); let remote_worktree_id = worktree.read(cx).id(); cx.update_global::(|store, cx| { for (directory, file_content) in settings_contents { store .set_local_settings(worktree_id, directory.clone(), file_content.as_deref(), cx) .log_err(); if let Some(downstream_client) = &self.downstream_client { downstream_client .send(proto::UpdateWorktreeSettings { project_id: self.project_id, worktree_id: remote_worktree_id.to_proto(), path: directory.to_string_lossy().into_owned(), content: file_content, }) .log_err(); } } }) } }