//! Paths to locations used by Zed. use std::path::{Path, PathBuf}; use std::sync::OnceLock; pub use util::paths::home_dir; /// A default editorconfig file name to use when resolving project settings. pub const EDITORCONFIG_NAME: &str = ".editorconfig"; /// A custom data directory override, set only by `set_custom_data_dir`. /// This is used to override the default data directory location. /// The directory will be created if it doesn't exist when set. static CUSTOM_DATA_DIR: OnceLock = OnceLock::new(); /// The resolved data directory, combining custom override or platform defaults. /// This is set once and cached for subsequent calls. /// On macOS, this is `~/Library/Application Support/Zed`. /// On Linux/FreeBSD, this is `$XDG_DATA_HOME/zed`. /// On Windows, this is `%LOCALAPPDATA%\Zed`. static CURRENT_DATA_DIR: OnceLock = OnceLock::new(); /// The resolved config directory, combining custom override or platform defaults. /// This is set once and cached for subsequent calls. /// On macOS, this is `~/.config/zed`. /// On Linux/FreeBSD, this is `$XDG_CONFIG_HOME/zed`. /// On Windows, this is `%APPDATA%\Zed`. static CONFIG_DIR: OnceLock = OnceLock::new(); /// Returns the relative path to the zed_server directory on the ssh host. pub fn remote_server_dir_relative() -> &'static Path { Path::new(".zed_server") } /// Sets a custom directory for all user data, overriding the default data directory. /// This function must be called before any other path operations that depend on the data directory. /// The directory will be created if it doesn't exist. /// /// # Arguments /// /// * `dir` - The path to use as the custom data directory. This will be used as the base /// directory for all user data, including databases, extensions, and logs. /// /// # Returns /// /// A reference to the static `PathBuf` containing the custom data directory path. /// /// # Panics /// /// Panics if: /// * Called after the data directory has been initialized (e.g., via `data_dir` or `config_dir`) /// * The directory cannot be created pub fn set_custom_data_dir(dir: &str) -> &'static PathBuf { if CURRENT_DATA_DIR.get().is_some() || CONFIG_DIR.get().is_some() { panic!("set_custom_data_dir called after data_dir or config_dir was initialized"); } CUSTOM_DATA_DIR.get_or_init(|| { let path = PathBuf::from(dir); std::fs::create_dir_all(&path).expect("failed to create custom data directory"); path }) } /// Returns the path to the configuration directory used by Zed. pub fn config_dir() -> &'static PathBuf { CONFIG_DIR.get_or_init(|| { if let Some(custom_dir) = CUSTOM_DATA_DIR.get() { custom_dir.join("config") } else if cfg!(target_os = "windows") { dirs::config_dir() .expect("failed to determine RoamingAppData directory") .join("Zed") } else if cfg!(any(target_os = "linux", target_os = "freebsd")) { if let Ok(flatpak_xdg_config) = std::env::var("FLATPAK_XDG_CONFIG_HOME") { flatpak_xdg_config.into() } else { dirs::config_dir().expect("failed to determine XDG_CONFIG_HOME directory") } .join("zed") } else { home_dir().join(".config").join("zed") } }) } /// Returns the path to the data directory used by Zed. pub fn data_dir() -> &'static PathBuf { CURRENT_DATA_DIR.get_or_init(|| { if let Some(custom_dir) = CUSTOM_DATA_DIR.get() { custom_dir.clone() } else if cfg!(target_os = "macos") { home_dir().join("Library/Application Support/Zed") } else if cfg!(any(target_os = "linux", target_os = "freebsd")) { if let Ok(flatpak_xdg_data) = std::env::var("FLATPAK_XDG_DATA_HOME") { flatpak_xdg_data.into() } else { dirs::data_local_dir().expect("failed to determine XDG_DATA_HOME directory") } .join("zed") } else if cfg!(target_os = "windows") { dirs::data_local_dir() .expect("failed to determine LocalAppData directory") .join("Zed") } else { config_dir().clone() // Fallback } }) } /// Returns the path to the temp directory used by Zed. pub fn temp_dir() -> &'static PathBuf { static TEMP_DIR: OnceLock = OnceLock::new(); TEMP_DIR.get_or_init(|| { if cfg!(target_os = "macos") { return dirs::cache_dir() .expect("failed to determine cachesDirectory directory") .join("Zed"); } if cfg!(target_os = "windows") { return dirs::cache_dir() .expect("failed to determine LocalAppData directory") .join("Zed"); } if cfg!(any(target_os = "linux", target_os = "freebsd")) { return if let Ok(flatpak_xdg_cache) = std::env::var("FLATPAK_XDG_CACHE_HOME") { flatpak_xdg_cache.into() } else { dirs::cache_dir().expect("failed to determine XDG_CACHE_HOME directory") } .join("zed"); } home_dir().join(".cache").join("zed") }) } /// Returns the path to the logs directory. pub fn logs_dir() -> &'static PathBuf { static LOGS_DIR: OnceLock = OnceLock::new(); LOGS_DIR.get_or_init(|| { if cfg!(target_os = "macos") { home_dir().join("Library/Logs/Zed") } else { data_dir().join("logs") } }) } /// Returns the path to the Zed server directory on this SSH host. pub fn remote_server_state_dir() -> &'static PathBuf { static REMOTE_SERVER_STATE: OnceLock = OnceLock::new(); REMOTE_SERVER_STATE.get_or_init(|| data_dir().join("server_state")) } /// Returns the path to the `Zed.log` file. pub fn log_file() -> &'static PathBuf { static LOG_FILE: OnceLock = OnceLock::new(); LOG_FILE.get_or_init(|| logs_dir().join("Zed.log")) } /// Returns the path to the `Zed.log.old` file. pub fn old_log_file() -> &'static PathBuf { static OLD_LOG_FILE: OnceLock = OnceLock::new(); OLD_LOG_FILE.get_or_init(|| logs_dir().join("Zed.log.old")) } /// Returns the path to the database directory. pub fn database_dir() -> &'static PathBuf { static DATABASE_DIR: OnceLock = OnceLock::new(); DATABASE_DIR.get_or_init(|| data_dir().join("db")) } /// Returns the path to the crashes directory, if it exists for the current platform. pub fn crashes_dir() -> &'static Option { static CRASHES_DIR: OnceLock> = OnceLock::new(); CRASHES_DIR.get_or_init(|| { cfg!(target_os = "macos").then_some(home_dir().join("Library/Logs/DiagnosticReports")) }) } /// Returns the path to the retired crashes directory, if it exists for the current platform. pub fn crashes_retired_dir() -> &'static Option { static CRASHES_RETIRED_DIR: OnceLock> = OnceLock::new(); CRASHES_RETIRED_DIR.get_or_init(|| crashes_dir().as_ref().map(|dir| dir.join("Retired"))) } /// Returns the path to the `settings.json` file. pub fn settings_file() -> &'static PathBuf { static SETTINGS_FILE: OnceLock = OnceLock::new(); SETTINGS_FILE.get_or_init(|| config_dir().join("settings.json")) } /// Returns the path to the global settings file. pub fn global_settings_file() -> &'static PathBuf { static GLOBAL_SETTINGS_FILE: OnceLock = OnceLock::new(); GLOBAL_SETTINGS_FILE.get_or_init(|| config_dir().join("global_settings.json")) } /// Returns the path to the `settings_backup.json` file. pub fn settings_backup_file() -> &'static PathBuf { static SETTINGS_FILE: OnceLock = OnceLock::new(); SETTINGS_FILE.get_or_init(|| config_dir().join("settings_backup.json")) } /// Returns the path to the `keymap.json` file. pub fn keymap_file() -> &'static PathBuf { static KEYMAP_FILE: OnceLock = OnceLock::new(); KEYMAP_FILE.get_or_init(|| config_dir().join("keymap.json")) } /// Returns the path to the `keymap_backup.json` file. pub fn keymap_backup_file() -> &'static PathBuf { static KEYMAP_FILE: OnceLock = OnceLock::new(); KEYMAP_FILE.get_or_init(|| config_dir().join("keymap_backup.json")) } /// Returns the path to the `tasks.json` file. pub fn tasks_file() -> &'static PathBuf { static TASKS_FILE: OnceLock = OnceLock::new(); TASKS_FILE.get_or_init(|| config_dir().join("tasks.json")) } /// Returns the path to the `debug.json` file. pub fn debug_scenarios_file() -> &'static PathBuf { static DEBUG_SCENARIOS_FILE: OnceLock = OnceLock::new(); DEBUG_SCENARIOS_FILE.get_or_init(|| config_dir().join("debug.json")) } /// Returns the path to the extensions directory. /// /// This is where installed extensions are stored. pub fn extensions_dir() -> &'static PathBuf { static EXTENSIONS_DIR: OnceLock = OnceLock::new(); EXTENSIONS_DIR.get_or_init(|| data_dir().join("extensions")) } /// Returns the path to the extensions directory. /// /// This is where installed extensions are stored on a remote. pub fn remote_extensions_dir() -> &'static PathBuf { static EXTENSIONS_DIR: OnceLock = OnceLock::new(); EXTENSIONS_DIR.get_or_init(|| data_dir().join("remote_extensions")) } /// Returns the path to the extensions directory. /// /// This is where installed extensions are stored on a remote. pub fn remote_extensions_uploads_dir() -> &'static PathBuf { static UPLOAD_DIR: OnceLock = OnceLock::new(); UPLOAD_DIR.get_or_init(|| remote_extensions_dir().join("uploads")) } /// Returns the path to the themes directory. /// /// This is where themes that are not provided by extensions are stored. pub fn themes_dir() -> &'static PathBuf { static THEMES_DIR: OnceLock = OnceLock::new(); THEMES_DIR.get_or_init(|| config_dir().join("themes")) } /// Returns the path to the snippets directory. pub fn snippets_dir() -> &'static PathBuf { static SNIPPETS_DIR: OnceLock = OnceLock::new(); SNIPPETS_DIR.get_or_init(|| config_dir().join("snippets")) } /// Returns the path to the contexts directory. /// /// This is where the saved contexts from the Assistant are stored. pub fn contexts_dir() -> &'static PathBuf { static CONTEXTS_DIR: OnceLock = OnceLock::new(); CONTEXTS_DIR.get_or_init(|| { if cfg!(target_os = "macos") { config_dir().join("conversations") } else { data_dir().join("conversations") } }) } /// Returns the path to the contexts directory. /// /// This is where the prompts for use with the Assistant are stored. pub fn prompts_dir() -> &'static PathBuf { static PROMPTS_DIR: OnceLock = OnceLock::new(); PROMPTS_DIR.get_or_init(|| { if cfg!(target_os = "macos") { config_dir().join("prompts") } else { data_dir().join("prompts") } }) } /// Returns the path to the prompt templates directory. /// /// This is where the prompt templates for core features can be overridden with templates. /// /// # Arguments /// /// * `dev_mode` - If true, assumes the current working directory is the Zed repository. pub fn prompt_overrides_dir(repo_path: Option<&Path>) -> PathBuf { if let Some(path) = repo_path { let dev_path = path.join("assets").join("prompts"); if dev_path.exists() { return dev_path; } } static PROMPT_TEMPLATES_DIR: OnceLock = OnceLock::new(); PROMPT_TEMPLATES_DIR .get_or_init(|| { if cfg!(target_os = "macos") { config_dir().join("prompt_overrides") } else { data_dir().join("prompt_overrides") } }) .clone() } /// Returns the path to the semantic search's embeddings directory. /// /// This is where the embeddings used to power semantic search are stored. pub fn embeddings_dir() -> &'static PathBuf { static EMBEDDINGS_DIR: OnceLock = OnceLock::new(); EMBEDDINGS_DIR.get_or_init(|| { if cfg!(target_os = "macos") { config_dir().join("embeddings") } else { data_dir().join("embeddings") } }) } /// Returns the path to the languages directory. /// /// This is where language servers are downloaded to for languages built-in to Zed. pub fn languages_dir() -> &'static PathBuf { static LANGUAGES_DIR: OnceLock = OnceLock::new(); LANGUAGES_DIR.get_or_init(|| data_dir().join("languages")) } /// Returns the path to the debug adapters directory /// /// This is where debug adapters are downloaded to for DAPs that are built-in to Zed. pub fn debug_adapters_dir() -> &'static PathBuf { static DEBUG_ADAPTERS_DIR: OnceLock = OnceLock::new(); DEBUG_ADAPTERS_DIR.get_or_init(|| data_dir().join("debug_adapters")) } /// Returns the path to the Copilot directory. pub fn copilot_dir() -> &'static PathBuf { static COPILOT_DIR: OnceLock = OnceLock::new(); COPILOT_DIR.get_or_init(|| data_dir().join("copilot")) } /// Returns the path to the Supermaven directory. pub fn supermaven_dir() -> &'static PathBuf { static SUPERMAVEN_DIR: OnceLock = OnceLock::new(); SUPERMAVEN_DIR.get_or_init(|| data_dir().join("supermaven")) } /// Returns the path to the default Prettier directory. pub fn default_prettier_dir() -> &'static PathBuf { static DEFAULT_PRETTIER_DIR: OnceLock = OnceLock::new(); DEFAULT_PRETTIER_DIR.get_or_init(|| data_dir().join("prettier")) } /// Returns the path to the remote server binaries directory. pub fn remote_servers_dir() -> &'static PathBuf { static REMOTE_SERVERS_DIR: OnceLock = OnceLock::new(); REMOTE_SERVERS_DIR.get_or_init(|| data_dir().join("remote_servers")) } /// Returns the relative path to a `.zed` folder within a project. pub fn local_settings_folder_relative_path() -> &'static Path { Path::new(".zed") } /// Returns the relative path to a `.vscode` folder within a project. pub fn local_vscode_folder_relative_path() -> &'static Path { Path::new(".vscode") } /// Returns the relative path to a `settings.json` file within a project. pub fn local_settings_file_relative_path() -> &'static Path { Path::new(".zed/settings.json") } /// Returns the relative path to a `tasks.json` file within a project. pub fn local_tasks_file_relative_path() -> &'static Path { Path::new(".zed/tasks.json") } /// Returns the relative path to a `.vscode/tasks.json` file within a project. pub fn local_vscode_tasks_file_relative_path() -> &'static Path { Path::new(".vscode/tasks.json") } pub fn debug_task_file_name() -> &'static str { "debug.json" } pub fn task_file_name() -> &'static str { "tasks.json" } /// Returns the relative path to a `debug.json` file within a project. /// .zed/debug.json pub fn local_debug_file_relative_path() -> &'static Path { Path::new(".zed/debug.json") } /// Returns the relative path to a `.vscode/launch.json` file within a project. pub fn local_vscode_launch_file_relative_path() -> &'static Path { Path::new(".vscode/launch.json") } pub fn user_ssh_config_file() -> PathBuf { home_dir().join(".ssh/config") } pub fn global_ssh_config_file() -> &'static Path { Path::new("/etc/ssh/ssh_config") } /// Returns the path to the vscode user settings file pub fn vscode_settings_file() -> &'static PathBuf { static LOGS_DIR: OnceLock = OnceLock::new(); let rel_path = "Code/User/settings.json"; LOGS_DIR.get_or_init(|| { if cfg!(target_os = "macos") { home_dir() .join("Library/Application Support") .join(rel_path) } else { home_dir().join(".config").join(rel_path) } }) } /// Returns the path to the cursor user settings file pub fn cursor_settings_file() -> &'static PathBuf { static LOGS_DIR: OnceLock = OnceLock::new(); let rel_path = "Cursor/User/settings.json"; LOGS_DIR.get_or_init(|| { if cfg!(target_os = "macos") { home_dir() .join("Library/Application Support") .join(rel_path) } else { config_dir().join(rel_path) } }) }