//! Provides `language`-related settings. use crate::{File, Language, LanguageName, LanguageServerName};use anyhow::Result;use collections::{FxHashMap, HashMap, HashSet};use core::slice;use ec4rs::{ Properties as EditorconfigProperties, property::{FinalNewline, IndentSize, IndentStyle, TabWidth, TrimTrailingWs},};use globset::{Glob, GlobMatcher, GlobSet, GlobSetBuilder};use gpui::{App, Modifiers};use itertools::{Either, Itertools};use schemars::{ JsonSchema, schema::{InstanceType, ObjectValidation, Schema, SchemaObject, SingleOrVec},};use serde::{ Deserialize, Deserializer, Serialize, de::{self, IntoDeserializer, MapAccess, SeqAccess, Visitor},};use serde_json::Value;use settings::{ Settings, SettingsLocation, SettingsSources, SettingsStore, add_references_to_properties,};use shellexpand;use std::{borrow::Cow, num::NonZeroU32, path::Path, sync::Arc};use util::serde::default_true; /// Initializes the language settings.pub fn init(cx: &mut App) { AllLanguageSettings::register(cx);} /// Returns the settings for the specified language from the provided file.pub fn language_settings<'a>( language: Option<LanguageName>, file: Option<&'a Arc<dyn File>>, cx: &'a App,) -> Cow<'a, LanguageSettings> { let location = file.map(|f| SettingsLocation { worktree_id: f.worktree_id(cx), path: f.path().as_ref(), }); AllLanguageSettings::get(location, cx).language(location, language.as_ref(), cx)} /// Returns the settings for all languages from the provided file.pub fn all_language_settings<'a>( file: Option<&'a Arc<dyn File>>, cx: &'a App,) -> &'a AllLanguageSettings { let location = file.map(|f| SettingsLocation { worktree_id: f.worktree_id(cx), path: f.path().as_ref(), }); AllLanguageSettings::get(location, cx)} /// The settings for all languages.#[derive(Debug, Clone)]pub struct AllLanguageSettings { /// The edit prediction settings. pub edit_predictions: EditPredictionSettings, pub defaults: LanguageSettings, languages: HashMap<LanguageName, LanguageSettings>, pub(crate) file_types: FxHashMap<Arc<str>, GlobSet>,} /// The settings for a particular language.#[derive(Debug, Clone, Deserialize)]pub struct LanguageSettings { /// How many columns a tab should occupy. pub tab_size: NonZeroU32, /// Whether to indent lines using tab characters, as opposed to multiple /// spaces. pub hard_tabs: bool, /// How to soft-wrap long lines of text. pub soft_wrap: SoftWrap, /// The column at which to soft-wrap lines, for buffers where soft-wrap /// is enabled. pub preferred_line_length: u32, /// Whether to show wrap guides (vertical rulers) in the editor. /// Setting this to true will show a guide at the 'preferred_line_length' value /// if softwrap is set to 'preferred_line_length', and will show any /// additional guides as specified by the 'wrap_guides' setting. pub show_wrap_guides: bool, /// Character counts at which to show wrap guides (vertical rulers) in the editor. pub wrap_guides: Vec<usize>, /// Indent guide related settings. pub indent_guides: IndentGuideSettings, /// Whether or not to perform a buffer format before saving. pub format_on_save: FormatOnSave, /// Whether or not to remove any trailing whitespace from lines of a buffer /// before saving it. pub remove_trailing_whitespace_on_save: bool, /// Whether or not to ensure there's a single newline at the end of a buffer /// when saving it. pub ensure_final_newline_on_save: bool, /// How to perform a buffer format. pub formatter: SelectedFormatter, /// Zed's Prettier integration settings. pub prettier: PrettierSettings, /// Whether to automatically close JSX tags. pub jsx_tag_auto_close: JsxTagAutoCloseSettings, /// Whether to use language servers to provide code intelligence. pub enable_language_server: bool, /// The list of language servers to use (or disable) for this language. /// /// This array should consist of language server IDs, as well as the following /// special tokens: /// - `"!<language_server_id>"` - A language server ID prefixed with a `!` will be disabled. /// - `"..."` - A placeholder to refer to the **rest** of the registered language servers for this language. pub language_servers: Vec<String>, /// Controls where the `editor::Rewrap` action is allowed for this language. /// /// Note: This setting has no effect in Vim mode, as rewrap is already /// allowed everywhere. pub allow_rewrap: RewrapBehavior, /// Controls whether edit predictions are shown immediately (true) /// or manually by triggering `editor::ShowEditPrediction` (false). pub show_edit_predictions: bool, /// Controls whether edit predictions are shown in the given language /// scopes. pub edit_predictions_disabled_in: Vec<String>, /// Whether to show tabs and spaces in the editor. pub show_whitespaces: ShowWhitespaceSetting, /// Whether to start a new line with a comment when a previous line is a comment as well. pub extend_comment_on_newline: bool, /// Inlay hint related settings. pub inlay_hints: InlayHintSettings, /// Whether to automatically close brackets. pub use_autoclose: bool, /// Whether to automatically surround text with brackets. pub use_auto_surround: bool, /// Whether to use additional LSP queries to format (and amend) the code after /// every "trigger" symbol input, defined by LSP server capabilities. pub use_on_type_format: bool, /// Whether indentation of pasted content should be adjusted based on the context. pub auto_indent_on_paste: bool, /// Controls how the editor handles the autoclosed characters. pub always_treat_brackets_as_autoclosed: bool, /// Which code actions to run on save pub code_actions_on_format: HashMap<String, bool>, /// Whether to perform linked edits pub linked_edits: bool, /// Task configuration for this language. pub tasks: LanguageTaskConfig, /// Whether to pop the completions menu while typing in an editor without /// explicitly requesting it. pub show_completions_on_input: bool, /// Whether to display inline and alongside documentation for items in the /// completions menu. pub show_completion_documentation: bool, /// Completion settings for this language. pub completions: CompletionSettings, /// Preferred debuggers for this language. pub debuggers: Vec<String>,} impl LanguageSettings { /// A token representing the rest of the available language servers. const REST_OF_LANGUAGE_SERVERS: &'static str = "..."; /// Returns the customized list of language servers from the list of /// available language servers. pub fn customized_language_servers( &self, available_language_servers: &[LanguageServerName], ) -> Vec<LanguageServerName> { Self::resolve_language_servers(&self.language_servers, available_language_servers) } pub(crate) fn resolve_language_servers( configured_language_servers: &[String], available_language_servers: &[LanguageServerName], ) -> Vec<LanguageServerName> { let (disabled_language_servers, enabled_language_servers): ( Vec<LanguageServerName>, Vec<LanguageServerName>, ) = configured_language_servers.iter().partition_map( |language_server| match language_server.strip_prefix('!') { Some(disabled) => Either::Left(LanguageServerName(disabled.to_string().into())), None => Either::Right(LanguageServerName(language_server.clone().into())), }, ); let rest = available_language_servers .iter() .filter(|&available_language_server| { !disabled_language_servers.contains(&available_language_server) && !enabled_language_servers.contains(&available_language_server) }) .cloned() .collect::<Vec<_>>(); enabled_language_servers .into_iter() .flat_map(|language_server| { if language_server.0.as_ref() == Self::REST_OF_LANGUAGE_SERVERS { rest.clone() } else { vec![language_server.clone()] } }) .collect::<Vec<_>>() }} /// The provider that supplies edit predictions.#[derive(Copy, Clone, Debug, Default, Eq, PartialEq, Serialize, Deserialize, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum EditPredictionProvider { None, #[default] Copilot, Supermaven, Zed,} impl EditPredictionProvider { pub fn is_zed(&self) -> bool { match self { EditPredictionProvider::Zed => true, EditPredictionProvider::None | EditPredictionProvider::Copilot | EditPredictionProvider::Supermaven => false, } }} /// The settings for edit predictions, such as [GitHub Copilot](https://github.com/features/copilot)/// or [Supermaven](https://supermaven.com).#[derive(Clone, Debug, Default)]pub struct EditPredictionSettings { /// The provider that supplies edit predictions. pub provider: EditPredictionProvider, /// A list of globs representing files that edit predictions should be disabled for. /// This list adds to a pre-existing, sensible default set of globs. /// Any additional ones you add are combined with them. pub disabled_globs: Vec<DisabledGlob>, /// Configures how edit predictions are displayed in the buffer. pub mode: EditPredictionsMode, /// Settings specific to GitHub Copilot. pub copilot: CopilotSettings, /// Whether edit predictions are enabled in the assistant panel. /// This setting has no effect if globally disabled. pub enabled_in_text_threads: bool,} impl EditPredictionSettings { /// Returns whether edit predictions are enabled for the given path. pub fn enabled_for_file(&self, file: &Arc<dyn File>, cx: &App) -> bool { !self.disabled_globs.iter().any(|glob| { if glob.is_absolute { file.as_local() .map_or(false, |local| glob.matcher.is_match(local.abs_path(cx))) } else { glob.matcher.is_match(file.path()) } }) }} #[derive(Clone, Debug)]pub struct DisabledGlob { matcher: GlobMatcher, is_absolute: bool,} /// The mode in which edit predictions should be displayed.#[derive(Copy, Clone, Debug, Default, Eq, PartialEq, Serialize, Deserialize, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum EditPredictionsMode { /// If provider supports it, display inline when holding modifier key (e.g., alt). /// Otherwise, eager preview is used. #[serde(alias = "auto")] Subtle, /// Display inline when there are no language server completions available. #[default] #[serde(alias = "eager_preview")] Eager,} #[derive(Clone, Debug, Default)]pub struct CopilotSettings { /// HTTP/HTTPS proxy to use for Copilot. pub proxy: Option<String>, /// Disable certificate verification for proxy (not recommended). pub proxy_no_verify: Option<bool>, /// Enterprise URI for Copilot. pub enterprise_uri: Option<String>,} /// The settings for all languages.#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize, JsonSchema)]pub struct AllLanguageSettingsContent { /// The settings for enabling/disabling features. #[serde(default)] pub features: Option<FeaturesContent>, /// The edit prediction settings. #[serde(default)] pub edit_predictions: Option<EditPredictionSettingsContent>, /// The default language settings. #[serde(flatten)] pub defaults: LanguageSettingsContent, /// The settings for individual languages. #[serde(default)] pub languages: HashMap<LanguageName, LanguageSettingsContent>, /// Settings for associating file extensions and filenames /// with languages. #[serde(default)] pub file_types: HashMap<Arc<str>, Vec<String>>,} /// Controls how completions are processed for this language.#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]#[serde(rename_all = "snake_case")]pub struct CompletionSettings { /// Controls how words are completed. /// For large documents, not all words may be fetched for completion. /// /// Default: `fallback` #[serde(default = "default_words_completion_mode")] pub words: WordsCompletionMode, /// Whether to fetch LSP completions or not. /// /// Default: true #[serde(default = "default_true")] pub lsp: bool, /// When fetching LSP completions, determines how long to wait for a response of a particular server. /// When set to 0, waits indefinitely. /// /// Default: 0 #[serde(default = "default_lsp_fetch_timeout_ms")] pub lsp_fetch_timeout_ms: u64, /// Controls how LSP completions are inserted. /// /// Default: "replace_suffix" #[serde(default = "default_lsp_insert_mode")] pub lsp_insert_mode: LspInsertMode,} /// Controls how document's words are completed.#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum WordsCompletionMode { /// Always fetch document's words for completions along with LSP completions. Enabled, /// Only if LSP response errors or times out, /// use document's words to show completions. Fallback, /// Never fetch or complete document's words for completions. /// (Word-based completions can still be queried via a separate action) Disabled,} #[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]#[serde(rename_all = "snake_case")]pub enum LspInsertMode { /// Replaces text before the cursor, using the `insert` range described in the LSP specification. Insert, /// Replaces text before and after the cursor, using the `replace` range described in the LSP specification. Replace, /// Behaves like `"replace"` if the text that would be replaced is a subsequence of the completion text, /// and like `"insert"` otherwise. ReplaceSubsequence, /// Behaves like `"replace"` if the text after the cursor is a suffix of the completion, and like /// `"insert"` otherwise. ReplaceSuffix,} fn default_words_completion_mode() -> WordsCompletionMode { WordsCompletionMode::Fallback} fn default_lsp_insert_mode() -> LspInsertMode { LspInsertMode::ReplaceSuffix} fn default_lsp_fetch_timeout_ms() -> u64 { 0} /// The settings for a particular language.#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize, JsonSchema)]#[schemars(deny_unknown_fields)]pub struct LanguageSettingsContent { /// How many columns a tab should occupy. /// /// Default: 4 #[serde(default)] pub tab_size: Option<NonZeroU32>, /// Whether to indent lines using tab characters, as opposed to multiple /// spaces. /// /// Default: false #[serde(default)] pub hard_tabs: Option<bool>, /// How to soft-wrap long lines of text. /// /// Default: none #[serde(default)] pub soft_wrap: Option<SoftWrap>, /// The column at which to soft-wrap lines, for buffers where soft-wrap /// is enabled. /// /// Default: 80 #[serde(default)] pub preferred_line_length: Option<u32>, /// Whether to show wrap guides in the editor. Setting this to true will /// show a guide at the 'preferred_line_length' value if softwrap is set to /// 'preferred_line_length', and will show any additional guides as specified /// by the 'wrap_guides' setting. /// /// Default: true #[serde(default)] pub show_wrap_guides: Option<bool>, /// Character counts at which to show wrap guides in the editor. /// /// Default: [] #[serde(default)] pub wrap_guides: Option<Vec<usize>>, /// Indent guide related settings. #[serde(default)] pub indent_guides: Option<IndentGuideSettings>, /// Whether or not to perform a buffer format before saving. /// /// Default: on #[serde(default)] pub format_on_save: Option<FormatOnSave>, /// Whether or not to remove any trailing whitespace from lines of a buffer /// before saving it. /// /// Default: true #[serde(default)] pub remove_trailing_whitespace_on_save: Option<bool>, /// Whether or not to ensure there's a single newline at the end of a buffer /// when saving it. /// /// Default: true #[serde(default)] pub ensure_final_newline_on_save: Option<bool>, /// How to perform a buffer format. /// /// Default: auto #[serde(default)] pub formatter: Option<SelectedFormatter>, /// Zed's Prettier integration settings. /// Allows to enable/disable formatting with Prettier /// and configure default Prettier, used when no project-level Prettier installation is found. /// /// Default: off #[serde(default)] pub prettier: Option<PrettierSettings>, /// Whether to automatically close JSX tags. #[serde(default)] pub jsx_tag_auto_close: Option<JsxTagAutoCloseSettings>, /// Whether to use language servers to provide code intelligence. /// /// Default: true #[serde(default)] pub enable_language_server: Option<bool>, /// The list of language servers to use (or disable) for this language. /// /// This array should consist of language server IDs, as well as the following /// special tokens: /// - `"!<language_server_id>"` - A language server ID prefixed with a `!` will be disabled. /// - `"..."` - A placeholder to refer to the **rest** of the registered language servers for this language. /// /// Default: ["..."] #[serde(default)] pub language_servers: Option<Vec<String>>, /// Controls where the `editor::Rewrap` action is allowed for this language. /// /// Note: This setting has no effect in Vim mode, as rewrap is already /// allowed everywhere. /// /// Default: "in_comments" #[serde(default)] pub allow_rewrap: Option<RewrapBehavior>, /// Controls whether edit predictions are shown immediately (true) /// or manually by triggering `editor::ShowEditPrediction` (false). /// /// Default: true #[serde(default)] pub show_edit_predictions: Option<bool>, /// Controls whether edit predictions are shown in the given language /// scopes. /// /// Example: ["string", "comment"] /// /// Default: [] #[serde(default)] pub edit_predictions_disabled_in: Option<Vec<String>>, /// Whether to show tabs and spaces in the editor. #[serde(default)] pub show_whitespaces: Option<ShowWhitespaceSetting>, /// Whether to start a new line with a comment when a previous line is a comment as well. ///Lines 1–500 of 1923. Load more
//! Provides `language`-related settings. use crate::{File, Language, LanguageName, LanguageServerName}; use anyhow::Result; use collections::{FxHashMap, HashMap, HashSet}; use core::slice; use ec4rs::{ Properties as EditorconfigProperties, property::{FinalNewline, IndentSize, IndentStyle, TabWidth, TrimTrailingWs}, }; use globset::{Glob, GlobMatcher, GlobSet, GlobSetBuilder}; use gpui::{App, Modifiers}; use itertools::{Either, Itertools}; use schemars::{ JsonSchema, schema::{InstanceType, ObjectValidation, Schema, SchemaObject, SingleOrVec}, }; use serde::{ Deserialize, Deserializer, Serialize, de::{self, IntoDeserializer, MapAccess, SeqAccess, Visitor}, }; use serde_json::Value; use settings::{ Settings, SettingsLocation, SettingsSources, SettingsStore, add_references_to_properties, }; use shellexpand; use std::{borrow::Cow, num::NonZeroU32, path::Path, sync::Arc}; use util::serde::default_true; /// Initializes the language settings. pub fn init(cx: &mut App) { AllLanguageSettings::register(cx); } /// Returns the settings for the specified language from the provided file. pub fn language_settings<'a>( language: Option<LanguageName>, file: Option<&'a Arc<dyn File>>, cx: &'a App, ) -> Cow<'a, LanguageSettings> { let location = file.map(|f| SettingsLocation { worktree_id: f.worktree_id(cx), path: f.path().as_ref(), }); AllLanguageSettings::get(location, cx).language(location, language.as_ref(), cx) } /// Returns the settings for all languages from the provided file. pub fn all_language_settings<'a>( file: Option<&'a Arc<dyn File>>, cx: &'a App, ) -> &'a AllLanguageSettings { let location = file.map(|f| SettingsLocation { worktree_id: f.worktree_id(cx), path: f.path().as_ref(), }); AllLanguageSettings::get(location, cx) } /// The settings for all languages. #[derive(Debug, Clone)] pub struct AllLanguageSettings { /// The edit prediction settings. pub edit_predictions: EditPredictionSettings, pub defaults: LanguageSettings, languages: HashMap<LanguageName, LanguageSettings>, pub(crate) file_types: FxHashMap<Arc<str>, GlobSet>, } /// The settings for a particular language. #[derive(Debug, Clone, Deserialize)] pub struct LanguageSettings { /// How many columns a tab should occupy. pub tab_size: NonZeroU32, /// Whether to indent lines using tab characters, as opposed to multiple /// spaces. pub hard_tabs: bool, /// How to soft-wrap long lines of text. pub soft_wrap: SoftWrap, /// The column at which to soft-wrap lines, for buffers where soft-wrap /// is enabled. pub preferred_line_length: u32, /// Whether to show wrap guides (vertical rulers) in the editor. /// Setting this to true will show a guide at the 'preferred_line_length' value /// if softwrap is set to 'preferred_line_length', and will show any /// additional guides as specified by the 'wrap_guides' setting. pub show_wrap_guides: bool, /// Character counts at which to show wrap guides (vertical rulers) in the editor. pub wrap_guides: Vec<usize>, /// Indent guide related settings. pub indent_guides: IndentGuideSettings, /// Whether or not to perform a buffer format before saving. pub format_on_save: FormatOnSave, /// Whether or not to remove any trailing whitespace from lines of a buffer /// before saving it. pub remove_trailing_whitespace_on_save: bool, /// Whether or not to ensure there's a single newline at the end of a buffer /// when saving it. pub ensure_final_newline_on_save: bool, /// How to perform a buffer format. pub formatter: SelectedFormatter, /// Zed's Prettier integration settings. pub prettier: PrettierSettings, /// Whether to automatically close JSX tags. pub jsx_tag_auto_close: JsxTagAutoCloseSettings, /// Whether to use language servers to provide code intelligence. pub enable_language_server: bool, /// The list of language servers to use (or disable) for this language. /// /// This array should consist of language server IDs, as well as the following /// special tokens: /// - `"!<language_server_id>"` - A language server ID prefixed with a `!` will be disabled. /// - `"..."` - A placeholder to refer to the **rest** of the registered language servers for this language. pub language_servers: Vec<String>, /// Controls where the `editor::Rewrap` action is allowed for this language. /// /// Note: This setting has no effect in Vim mode, as rewrap is already /// allowed everywhere. pub allow_rewrap: RewrapBehavior, /// Controls whether edit predictions are shown immediately (true) /// or manually by triggering `editor::ShowEditPrediction` (false). pub show_edit_predictions: bool, /// Controls whether edit predictions are shown in the given language /// scopes. pub edit_predictions_disabled_in: Vec<String>, /// Whether to show tabs and spaces in the editor. pub show_whitespaces: ShowWhitespaceSetting, /// Whether to start a new line with a comment when a previous line is a comment as well. pub extend_comment_on_newline: bool, /// Inlay hint related settings. pub inlay_hints: InlayHintSettings, /// Whether to automatically close brackets. pub use_autoclose: bool, /// Whether to automatically surround text with brackets. pub use_auto_surround: bool, /// Whether to use additional LSP queries to format (and amend) the code after /// every "trigger" symbol input, defined by LSP server capabilities. pub use_on_type_format: bool, /// Whether indentation of pasted content should be adjusted based on the context. pub auto_indent_on_paste: bool, /// Controls how the editor handles the autoclosed characters. pub always_treat_brackets_as_autoclosed: bool, /// Which code actions to run on save pub code_actions_on_format: HashMap<String, bool>, /// Whether to perform linked edits pub linked_edits: bool, /// Task configuration for this language. pub tasks: LanguageTaskConfig, /// Whether to pop the completions menu while typing in an editor without /// explicitly requesting it. pub show_completions_on_input: bool, /// Whether to display inline and alongside documentation for items in the /// completions menu. pub show_completion_documentation: bool, /// Completion settings for this language. pub completions: CompletionSettings, /// Preferred debuggers for this language. pub debuggers: Vec<String>, } impl LanguageSettings { /// A token representing the rest of the available language servers. const REST_OF_LANGUAGE_SERVERS: &'static str = "..."; /// Returns the customized list of language servers from the list of /// available language servers. pub fn customized_language_servers( &self, available_language_servers: &[LanguageServerName], ) -> Vec<LanguageServerName> { Self::resolve_language_servers(&self.language_servers, available_language_servers) } pub(crate) fn resolve_language_servers( configured_language_servers: &[String], available_language_servers: &[LanguageServerName], ) -> Vec<LanguageServerName> { let (disabled_language_servers, enabled_language_servers): ( Vec<LanguageServerName>, Vec<LanguageServerName>, ) = configured_language_servers.iter().partition_map( |language_server| match language_server.strip_prefix('!') { Some(disabled) => Either::Left(LanguageServerName(disabled.to_string().into())), None => Either::Right(LanguageServerName(language_server.clone().into())), }, ); let rest = available_language_servers .iter() .filter(|&available_language_server| { !disabled_language_servers.contains(&available_language_server) && !enabled_language_servers.contains(&available_language_server) }) .cloned() .collect::<Vec<_>>(); enabled_language_servers .into_iter() .flat_map(|language_server| { if language_server.0.as_ref() == Self::REST_OF_LANGUAGE_SERVERS { rest.clone() } else { vec![language_server.clone()] } }) .collect::<Vec<_>>() } } /// The provider that supplies edit predictions. #[derive(Copy, Clone, Debug, Default, Eq, PartialEq, Serialize, Deserialize, JsonSchema)] #[serde(rename_all = "snake_case")] pub enum EditPredictionProvider { None, #[default] Copilot, Supermaven, Zed, } impl EditPredictionProvider { pub fn is_zed(&self) -> bool { match self { EditPredictionProvider::Zed => true, EditPredictionProvider::None | EditPredictionProvider::Copilot | EditPredictionProvider::Supermaven => false, } } } /// The settings for edit predictions, such as [GitHub Copilot](https://github.com/features/copilot) /// or [Supermaven](https://supermaven.com). #[derive(Clone, Debug, Default)] pub struct EditPredictionSettings { /// The provider that supplies edit predictions. pub provider: EditPredictionProvider, /// A list of globs representing files that edit predictions should be disabled for. /// This list adds to a pre-existing, sensible default set of globs. /// Any additional ones you add are combined with them. pub disabled_globs: Vec<DisabledGlob>, /// Configures how edit predictions are displayed in the buffer. pub mode: EditPredictionsMode, /// Settings specific to GitHub Copilot. pub copilot: CopilotSettings, /// Whether edit predictions are enabled in the assistant panel. /// This setting has no effect if globally disabled. pub enabled_in_text_threads: bool, } impl EditPredictionSettings { /// Returns whether edit predictions are enabled for the given path. pub fn enabled_for_file(&self, file: &Arc<dyn File>, cx: &App) -> bool { !self.disabled_globs.iter().any(|glob| { if glob.is_absolute { file.as_local() .map_or(false, |local| glob.matcher.is_match(local.abs_path(cx))) } else { glob.matcher.is_match(file.path()) } }) } } #[derive(Clone, Debug)] pub struct DisabledGlob { matcher: GlobMatcher, is_absolute: bool, } /// The mode in which edit predictions should be displayed. #[derive(Copy, Clone, Debug, Default, Eq, PartialEq, Serialize, Deserialize, JsonSchema)] #[serde(rename_all = "snake_case")] pub enum EditPredictionsMode { /// If provider supports it, display inline when holding modifier key (e.g., alt). /// Otherwise, eager preview is used. #[serde(alias = "auto")] Subtle, /// Display inline when there are no language server completions available. #[default] #[serde(alias = "eager_preview")] Eager, } #[derive(Clone, Debug, Default)] pub struct CopilotSettings { /// HTTP/HTTPS proxy to use for Copilot. pub proxy: Option<String>, /// Disable certificate verification for proxy (not recommended). pub proxy_no_verify: Option<bool>, /// Enterprise URI for Copilot. pub enterprise_uri: Option<String>, } /// The settings for all languages. #[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize, JsonSchema)] pub struct AllLanguageSettingsContent { /// The settings for enabling/disabling features. #[serde(default)] pub features: Option<FeaturesContent>, /// The edit prediction settings. #[serde(default)] pub edit_predictions: Option<EditPredictionSettingsContent>, /// The default language settings. #[serde(flatten)] pub defaults: LanguageSettingsContent, /// The settings for individual languages. #[serde(default)] pub languages: HashMap<LanguageName, LanguageSettingsContent>, /// Settings for associating file extensions and filenames /// with languages. #[serde(default)] pub file_types: HashMap<Arc<str>, Vec<String>>, } /// Controls how completions are processed for this language. #[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)] #[serde(rename_all = "snake_case")] pub struct CompletionSettings { /// Controls how words are completed. /// For large documents, not all words may be fetched for completion. /// /// Default: `fallback` #[serde(default = "default_words_completion_mode")] pub words: WordsCompletionMode, /// Whether to fetch LSP completions or not. /// /// Default: true #[serde(default = "default_true")] pub lsp: bool, /// When fetching LSP completions, determines how long to wait for a response of a particular server. /// When set to 0, waits indefinitely. /// /// Default: 0 #[serde(default = "default_lsp_fetch_timeout_ms")] pub lsp_fetch_timeout_ms: u64, /// Controls how LSP completions are inserted. /// /// Default: "replace_suffix" #[serde(default = "default_lsp_insert_mode")] pub lsp_insert_mode: LspInsertMode, } /// Controls how document's words are completed. #[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)] #[serde(rename_all = "snake_case")] pub enum WordsCompletionMode { /// Always fetch document's words for completions along with LSP completions. Enabled, /// Only if LSP response errors or times out, /// use document's words to show completions. Fallback, /// Never fetch or complete document's words for completions. /// (Word-based completions can still be queried via a separate action) Disabled, } #[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)] #[serde(rename_all = "snake_case")] pub enum LspInsertMode { /// Replaces text before the cursor, using the `insert` range described in the LSP specification. Insert, /// Replaces text before and after the cursor, using the `replace` range described in the LSP specification. Replace, /// Behaves like `"replace"` if the text that would be replaced is a subsequence of the completion text, /// and like `"insert"` otherwise. ReplaceSubsequence, /// Behaves like `"replace"` if the text after the cursor is a suffix of the completion, and like /// `"insert"` otherwise. ReplaceSuffix, } fn default_words_completion_mode() -> WordsCompletionMode { WordsCompletionMode::Fallback } fn default_lsp_insert_mode() -> LspInsertMode { LspInsertMode::ReplaceSuffix } fn default_lsp_fetch_timeout_ms() -> u64 { 0 } /// The settings for a particular language. #[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize, JsonSchema)] #[schemars(deny_unknown_fields)] pub struct LanguageSettingsContent { /// How many columns a tab should occupy. /// /// Default: 4 #[serde(default)] pub tab_size: Option<NonZeroU32>, /// Whether to indent lines using tab characters, as opposed to multiple /// spaces. /// /// Default: false #[serde(default)] pub hard_tabs: Option<bool>, /// How to soft-wrap long lines of text. /// /// Default: none #[serde(default)] pub soft_wrap: Option<SoftWrap>, /// The column at which to soft-wrap lines, for buffers where soft-wrap /// is enabled. /// /// Default: 80 #[serde(default)] pub preferred_line_length: Option<u32>, /// Whether to show wrap guides in the editor. Setting this to true will /// show a guide at the 'preferred_line_length' value if softwrap is set to /// 'preferred_line_length', and will show any additional guides as specified /// by the 'wrap_guides' setting. /// /// Default: true #[serde(default)] pub show_wrap_guides: Option<bool>, /// Character counts at which to show wrap guides in the editor. /// /// Default: [] #[serde(default)] pub wrap_guides: Option<Vec<usize>>, /// Indent guide related settings. #[serde(default)] pub indent_guides: Option<IndentGuideSettings>, /// Whether or not to perform a buffer format before saving. /// /// Default: on #[serde(default)] pub format_on_save: Option<FormatOnSave>, /// Whether or not to remove any trailing whitespace from lines of a buffer /// before saving it. /// /// Default: true #[serde(default)] pub remove_trailing_whitespace_on_save: Option<bool>, /// Whether or not to ensure there's a single newline at the end of a buffer /// when saving it. /// /// Default: true #[serde(default)] pub ensure_final_newline_on_save: Option<bool>, /// How to perform a buffer format. /// /// Default: auto #[serde(default)] pub formatter: Option<SelectedFormatter>, /// Zed's Prettier integration settings. /// Allows to enable/disable formatting with Prettier /// and configure default Prettier, used when no project-level Prettier installation is found. /// /// Default: off #[serde(default)] pub prettier: Option<PrettierSettings>, /// Whether to automatically close JSX tags. #[serde(default)] pub jsx_tag_auto_close: Option<JsxTagAutoCloseSettings>, /// Whether to use language servers to provide code intelligence. /// /// Default: true #[serde(default)] pub enable_language_server: Option<bool>, /// The list of language servers to use (or disable) for this language. /// /// This array should consist of language server IDs, as well as the following /// special tokens: /// - `"!<language_server_id>"` - A language server ID prefixed with a `!` will be disabled. /// - `"..."` - A placeholder to refer to the **rest** of the registered language servers for this language. /// /// Default: ["..."] #[serde(default)] pub language_servers: Option<Vec<String>>, /// Controls where the `editor::Rewrap` action is allowed for this language. /// /// Note: This setting has no effect in Vim mode, as rewrap is already /// allowed everywhere. /// /// Default: "in_comments" #[serde(default)] pub allow_rewrap: Option<RewrapBehavior>, /// Controls whether edit predictions are shown immediately (true) /// or manually by triggering `editor::ShowEditPrediction` (false). /// /// Default: true #[serde(default)] pub show_edit_predictions: Option<bool>, /// Controls whether edit predictions are shown in the given language /// scopes. /// /// Example: ["string", "comment"] /// /// Default: [] #[serde(default)] pub edit_predictions_disabled_in: Option<Vec<String>>, /// Whether to show tabs and spaces in the editor. #[serde(default)] pub show_whitespaces: Option<ShowWhitespaceSetting>, /// Whether to start a new line with a comment when a previous line is a comment as well. ///