mirror of
https://github.com/zed-industries/zed.git
synced 2026-05-25 23:04:27 +00:00
987 lines
39 KiB
Rust
987 lines
39 KiB
Rust
//! Provides `language`-related settings.
|
|
|
|
use crate::{File, Language, LanguageName, LanguageServerName};
|
|
use collections::{FxHashMap, HashMap, HashSet};
|
|
use ec4rs::{
|
|
Properties as EditorconfigProperties,
|
|
property::{FinalNewline, IndentSize, IndentStyle, MaxLineLen, TabWidth, TrimTrailingWs},
|
|
};
|
|
use globset::{Glob, GlobMatcher, GlobSet, GlobSetBuilder};
|
|
use gpui::{App, Modifiers, SharedString};
|
|
use itertools::{Either, Itertools};
|
|
use settings::{DocumentFoldingRanges, DocumentSymbols, IntoGpui, SemanticTokens};
|
|
|
|
pub use settings::{
|
|
CompletionSettingsContent, EditPredictionProvider, EditPredictionsMode, FormatOnSave,
|
|
Formatter, FormatterList, InlayHintKind, LanguageSettingsContent, LspInsertMode,
|
|
RewrapBehavior, ShowWhitespaceSetting, SoftWrap, WordsCompletionMode,
|
|
};
|
|
use settings::{RegisterSetting, Settings, SettingsLocation, SettingsStore};
|
|
use shellexpand;
|
|
use std::{borrow::Cow, num::NonZeroU32, path::Path, sync::Arc};
|
|
|
|
/// 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, RegisterSetting)]
|
|
pub struct AllLanguageSettings {
|
|
/// The edit prediction settings.
|
|
pub edit_predictions: EditPredictionSettings,
|
|
pub defaults: LanguageSettings,
|
|
languages: HashMap<LanguageName, LanguageSettings>,
|
|
pub file_types: FxHashMap<Arc<str>, (GlobSet, Vec<String>)>,
|
|
}
|
|
|
|
#[derive(Debug, Clone, PartialEq)]
|
|
pub struct WhitespaceMap {
|
|
pub space: SharedString,
|
|
pub tab: SharedString,
|
|
}
|
|
|
|
/// The settings for a particular language.
|
|
#[derive(Debug, Clone, PartialEq)]
|
|
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: settings::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: settings::FormatterList,
|
|
/// Zed's Prettier integration settings.
|
|
pub prettier: PrettierSettings,
|
|
/// Whether to automatically close JSX tags.
|
|
pub jsx_tag_auto_close: bool,
|
|
/// 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 how semantic tokens from language servers are used for syntax highlighting.
|
|
pub semantic_tokens: SemanticTokens,
|
|
/// Controls whether folding ranges from language servers are used instead of
|
|
/// tree-sitter and indent-based folding.
|
|
pub document_folding_ranges: DocumentFoldingRanges,
|
|
/// Controls the source of document symbols used for outlines and breadcrumbs.
|
|
pub document_symbols: DocumentSymbols,
|
|
/// 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: settings::ShowWhitespaceSetting,
|
|
/// Visible characters used to render whitespace when show_whitespaces is enabled.
|
|
pub whitespace_map: WhitespaceMap,
|
|
/// Whether to start a new line with a comment when a previous line is a comment as well.
|
|
pub extend_comment_on_newline: bool,
|
|
/// Whether to continue markdown lists when pressing enter.
|
|
pub extend_list_on_newline: bool,
|
|
/// Whether to indent list items when pressing tab after a list marker.
|
|
pub indent_list_on_tab: 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 should be adjusted based on the context whilst typing.
|
|
pub auto_indent: 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: LanguageTaskSettings,
|
|
/// 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>,
|
|
/// Whether to enable word diff highlighting in the editor.
|
|
///
|
|
/// When enabled, changed words within modified lines are highlighted
|
|
/// to show exactly what changed.
|
|
///
|
|
/// Default: `true`
|
|
pub word_diff_enabled: bool,
|
|
/// Whether to use tree-sitter bracket queries to detect and colorize the brackets in the editor.
|
|
pub colorize_brackets: bool,
|
|
}
|
|
|
|
#[derive(Debug, Clone, PartialEq)]
|
|
pub struct CompletionSettings {
|
|
/// Controls how words are completed.
|
|
/// For large documents, not all words may be fetched for completion.
|
|
///
|
|
/// Default: `fallback`
|
|
pub words: WordsCompletionMode,
|
|
/// How many characters has to be in the completions query to automatically show the words-based completions.
|
|
/// Before that value, it's still possible to trigger the words-based completion manually with the corresponding editor command.
|
|
///
|
|
/// Default: 3
|
|
pub words_min_length: usize,
|
|
/// Whether to fetch LSP completions or not.
|
|
///
|
|
/// 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
|
|
pub lsp_fetch_timeout_ms: u64,
|
|
/// Controls how LSP completions are inserted.
|
|
///
|
|
/// Default: "replace_suffix"
|
|
pub lsp_insert_mode: LspInsertMode,
|
|
}
|
|
|
|
/// The settings for indent guides.
|
|
#[derive(Debug, Clone, PartialEq)]
|
|
pub struct IndentGuideSettings {
|
|
/// Whether to display indent guides in the editor.
|
|
///
|
|
/// Default: true
|
|
pub enabled: bool,
|
|
/// The width of the indent guides in pixels, between 1 and 10.
|
|
///
|
|
/// Default: 1
|
|
pub line_width: u32,
|
|
/// The width of the active indent guide in pixels, between 1 and 10.
|
|
///
|
|
/// Default: 1
|
|
pub active_line_width: u32,
|
|
/// Determines how indent guides are colored.
|
|
///
|
|
/// Default: Fixed
|
|
pub coloring: settings::IndentGuideColoring,
|
|
/// Determines how indent guide backgrounds are colored.
|
|
///
|
|
/// Default: Disabled
|
|
pub background_coloring: settings::IndentGuideBackgroundColoring,
|
|
}
|
|
|
|
#[derive(Debug, Clone, PartialEq)]
|
|
pub struct LanguageTaskSettings {
|
|
/// Extra task variables to set for a particular language.
|
|
pub variables: HashMap<String, String>,
|
|
pub enabled: bool,
|
|
/// Use LSP tasks over Zed language extension ones.
|
|
/// If no LSP tasks are returned due to error/timeout or regular execution,
|
|
/// Zed language extension tasks will be used instead.
|
|
///
|
|
/// Other Zed tasks will still be shown:
|
|
/// * Zed task from either of the task config file
|
|
/// * Zed task from history (e.g. one-off task was spawned before)
|
|
pub prefer_lsp: bool,
|
|
}
|
|
|
|
/// Allows to enable/disable formatting with Prettier
|
|
/// and configure default Prettier, used when no project-level Prettier installation is found.
|
|
/// Prettier formatting is disabled by default.
|
|
#[derive(Debug, Clone, PartialEq)]
|
|
pub struct PrettierSettings {
|
|
/// Enables or disables formatting with Prettier for a given language.
|
|
pub allowed: bool,
|
|
|
|
/// Forces Prettier integration to use a specific parser name when formatting files with the language.
|
|
pub parser: Option<String>,
|
|
|
|
/// Forces Prettier integration to use specific plugins when formatting files with the language.
|
|
/// The default Prettier will be installed with these plugins.
|
|
pub plugins: HashSet<String>,
|
|
|
|
/// Default Prettier options, in the format as in package.json section for Prettier.
|
|
/// If project installs Prettier via its package.json, these options will be ignored.
|
|
pub options: HashMap<String, serde_json::Value>,
|
|
}
|
|
|
|
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]
|
|
}
|
|
})
|
|
.collect::<Vec<_>>()
|
|
}
|
|
}
|
|
|
|
// The settings for inlay hints.
|
|
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
|
|
pub struct InlayHintSettings {
|
|
/// Global switch to toggle hints on and off.
|
|
///
|
|
/// Default: false
|
|
pub enabled: bool,
|
|
/// Global switch to toggle inline values on and off when debugging.
|
|
///
|
|
/// Default: true
|
|
pub show_value_hints: bool,
|
|
/// Whether type hints should be shown.
|
|
///
|
|
/// Default: true
|
|
pub show_type_hints: bool,
|
|
/// Whether parameter hints should be shown.
|
|
///
|
|
/// Default: true
|
|
pub show_parameter_hints: bool,
|
|
/// Whether other hints should be shown.
|
|
///
|
|
/// Default: true
|
|
pub show_other_hints: bool,
|
|
/// Whether to show a background for inlay hints.
|
|
///
|
|
/// If set to `true`, the background will use the `hint.background` color
|
|
/// from the current theme.
|
|
///
|
|
/// Default: false
|
|
pub show_background: bool,
|
|
/// Whether or not to debounce inlay hints updates after buffer edits.
|
|
///
|
|
/// Set to 0 to disable debouncing.
|
|
///
|
|
/// Default: 700
|
|
pub edit_debounce_ms: u64,
|
|
/// Whether or not to debounce inlay hints updates after buffer scrolls.
|
|
///
|
|
/// Set to 0 to disable debouncing.
|
|
///
|
|
/// Default: 50
|
|
pub scroll_debounce_ms: u64,
|
|
/// Toggles inlay hints (hides or shows) when the user presses the modifiers specified.
|
|
/// If only a subset of the modifiers specified is pressed, hints are not toggled.
|
|
/// If no modifiers are specified, this is equivalent to `None`.
|
|
///
|
|
/// Default: None
|
|
pub toggle_on_modifiers_press: Option<Modifiers>,
|
|
}
|
|
|
|
impl InlayHintSettings {
|
|
/// Returns the kinds of inlay hints that are enabled based on the settings.
|
|
pub fn enabled_inlay_hint_kinds(&self) -> HashSet<Option<InlayHintKind>> {
|
|
let mut kinds = HashSet::default();
|
|
if self.show_type_hints {
|
|
kinds.insert(Some(InlayHintKind::Type));
|
|
}
|
|
if self.show_parameter_hints {
|
|
kinds.insert(Some(InlayHintKind::Parameter));
|
|
}
|
|
if self.show_other_hints {
|
|
kinds.insert(None);
|
|
}
|
|
kinds
|
|
}
|
|
}
|
|
|
|
/// 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: settings::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: settings::EditPredictionsMode,
|
|
/// Settings specific to GitHub Copilot.
|
|
pub copilot: CopilotSettings,
|
|
/// Settings specific to Codestral.
|
|
pub codestral: CodestralSettings,
|
|
/// Settings specific to Sweep.
|
|
pub sweep: SweepSettings,
|
|
/// Settings specific to Ollama.
|
|
pub ollama: OllamaSettings,
|
|
/// Whether edit predictions are enabled in the assistant panel.
|
|
/// This setting has no effect if globally disabled.
|
|
pub enabled_in_text_threads: bool,
|
|
pub examples_dir: Option<Arc<Path>>,
|
|
}
|
|
|
|
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()
|
|
.is_some_and(|local| glob.matcher.is_match(local.abs_path(cx)))
|
|
} else {
|
|
glob.matcher.is_match(file.path().as_std_path())
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
#[derive(Clone, Debug)]
|
|
pub struct DisabledGlob {
|
|
matcher: GlobMatcher,
|
|
is_absolute: bool,
|
|
}
|
|
|
|
#[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>,
|
|
/// Whether the Copilot Next Edit Suggestions feature is enabled.
|
|
pub enable_next_edit_suggestions: Option<bool>,
|
|
}
|
|
|
|
#[derive(Clone, Debug, Default)]
|
|
pub struct CodestralSettings {
|
|
/// Model to use for completions.
|
|
pub model: Option<String>,
|
|
/// Maximum tokens to generate.
|
|
pub max_tokens: Option<u32>,
|
|
/// Custom API URL to use for Codestral.
|
|
pub api_url: Option<String>,
|
|
}
|
|
|
|
#[derive(Clone, Debug, Default)]
|
|
pub struct SweepSettings {
|
|
/// When enabled, Sweep will not store edit prediction inputs or outputs.
|
|
/// When disabled, Sweep may collect data including buffer contents,
|
|
/// diagnostics, file paths, repository names, and generated predictions
|
|
/// to improve the service.
|
|
pub privacy_mode: bool,
|
|
}
|
|
|
|
#[derive(Clone, Debug, Default)]
|
|
pub struct OllamaSettings {
|
|
/// Model to use for completions.
|
|
pub model: Option<String>,
|
|
/// Maximum tokens to generate.
|
|
pub max_output_tokens: u32,
|
|
/// Custom API URL to use for Ollama.
|
|
pub api_url: Arc<str>,
|
|
}
|
|
|
|
impl AllLanguageSettings {
|
|
/// Returns the [`LanguageSettings`] for the language with the specified name.
|
|
pub fn language<'a>(
|
|
&'a self,
|
|
location: Option<SettingsLocation<'a>>,
|
|
language_name: Option<&LanguageName>,
|
|
cx: &'a App,
|
|
) -> Cow<'a, LanguageSettings> {
|
|
let settings = language_name
|
|
.and_then(|name| self.languages.get(name))
|
|
.unwrap_or(&self.defaults);
|
|
|
|
let editorconfig_properties = location.and_then(|location| {
|
|
cx.global::<SettingsStore>()
|
|
.editorconfig_store
|
|
.read(cx)
|
|
.properties(location.worktree_id, location.path)
|
|
});
|
|
if let Some(editorconfig_properties) = editorconfig_properties {
|
|
let mut settings = settings.clone();
|
|
merge_with_editorconfig(&mut settings, &editorconfig_properties);
|
|
Cow::Owned(settings)
|
|
} else {
|
|
Cow::Borrowed(settings)
|
|
}
|
|
}
|
|
|
|
/// Returns whether edit predictions are enabled for the given path.
|
|
pub fn edit_predictions_enabled_for_file(&self, file: &Arc<dyn File>, cx: &App) -> bool {
|
|
self.edit_predictions.enabled_for_file(file, cx)
|
|
}
|
|
|
|
/// Returns whether edit predictions are enabled for the given language and path.
|
|
pub fn show_edit_predictions(&self, language: Option<&Arc<Language>>, cx: &App) -> bool {
|
|
self.language(None, language.map(|l| l.name()).as_ref(), cx)
|
|
.show_edit_predictions
|
|
}
|
|
|
|
/// Returns the edit predictions preview mode for the given language and path.
|
|
pub fn edit_predictions_mode(&self) -> EditPredictionsMode {
|
|
self.edit_predictions.mode
|
|
}
|
|
}
|
|
|
|
fn merge_with_editorconfig(settings: &mut LanguageSettings, cfg: &EditorconfigProperties) {
|
|
let preferred_line_length = cfg.get::<MaxLineLen>().ok().and_then(|v| match v {
|
|
MaxLineLen::Value(u) => Some(u as u32),
|
|
MaxLineLen::Off => None,
|
|
});
|
|
let tab_size = cfg.get::<IndentSize>().ok().and_then(|v| match v {
|
|
IndentSize::Value(u) => NonZeroU32::new(u as u32),
|
|
IndentSize::UseTabWidth => cfg.get::<TabWidth>().ok().and_then(|w| match w {
|
|
TabWidth::Value(u) => NonZeroU32::new(u as u32),
|
|
}),
|
|
});
|
|
let hard_tabs = cfg
|
|
.get::<IndentStyle>()
|
|
.map(|v| v.eq(&IndentStyle::Tabs))
|
|
.ok();
|
|
let ensure_final_newline_on_save = cfg
|
|
.get::<FinalNewline>()
|
|
.map(|v| match v {
|
|
FinalNewline::Value(b) => b,
|
|
})
|
|
.ok();
|
|
let remove_trailing_whitespace_on_save = cfg
|
|
.get::<TrimTrailingWs>()
|
|
.map(|v| match v {
|
|
TrimTrailingWs::Value(b) => b,
|
|
})
|
|
.ok();
|
|
fn merge<T>(target: &mut T, value: Option<T>) {
|
|
if let Some(value) = value {
|
|
*target = value;
|
|
}
|
|
}
|
|
merge(&mut settings.preferred_line_length, preferred_line_length);
|
|
merge(&mut settings.tab_size, tab_size);
|
|
merge(&mut settings.hard_tabs, hard_tabs);
|
|
merge(
|
|
&mut settings.remove_trailing_whitespace_on_save,
|
|
remove_trailing_whitespace_on_save,
|
|
);
|
|
merge(
|
|
&mut settings.ensure_final_newline_on_save,
|
|
ensure_final_newline_on_save,
|
|
);
|
|
}
|
|
|
|
impl settings::Settings for AllLanguageSettings {
|
|
fn from_settings(content: &settings::SettingsContent) -> Self {
|
|
let all_languages = &content.project.all_languages;
|
|
|
|
fn load_from_content(settings: LanguageSettingsContent) -> LanguageSettings {
|
|
let inlay_hints = settings.inlay_hints.unwrap();
|
|
let completions = settings.completions.unwrap();
|
|
let prettier = settings.prettier.unwrap();
|
|
let indent_guides = settings.indent_guides.unwrap();
|
|
let tasks = settings.tasks.unwrap();
|
|
let whitespace_map = settings.whitespace_map.unwrap();
|
|
|
|
LanguageSettings {
|
|
tab_size: settings.tab_size.unwrap(),
|
|
hard_tabs: settings.hard_tabs.unwrap(),
|
|
soft_wrap: settings.soft_wrap.unwrap(),
|
|
preferred_line_length: settings.preferred_line_length.unwrap(),
|
|
show_wrap_guides: settings.show_wrap_guides.unwrap(),
|
|
wrap_guides: settings.wrap_guides.unwrap(),
|
|
indent_guides: IndentGuideSettings {
|
|
enabled: indent_guides.enabled.unwrap(),
|
|
line_width: indent_guides.line_width.unwrap(),
|
|
active_line_width: indent_guides.active_line_width.unwrap(),
|
|
coloring: indent_guides.coloring.unwrap(),
|
|
background_coloring: indent_guides.background_coloring.unwrap(),
|
|
},
|
|
format_on_save: settings.format_on_save.unwrap(),
|
|
remove_trailing_whitespace_on_save: settings
|
|
.remove_trailing_whitespace_on_save
|
|
.unwrap(),
|
|
ensure_final_newline_on_save: settings.ensure_final_newline_on_save.unwrap(),
|
|
formatter: settings.formatter.unwrap(),
|
|
prettier: PrettierSettings {
|
|
allowed: prettier.allowed.unwrap(),
|
|
parser: prettier.parser.filter(|parser| !parser.is_empty()),
|
|
plugins: prettier.plugins.unwrap_or_default(),
|
|
options: prettier.options.unwrap_or_default(),
|
|
},
|
|
jsx_tag_auto_close: settings.jsx_tag_auto_close.unwrap().enabled.unwrap(),
|
|
enable_language_server: settings.enable_language_server.unwrap(),
|
|
language_servers: settings.language_servers.unwrap(),
|
|
semantic_tokens: settings.semantic_tokens.unwrap(),
|
|
document_folding_ranges: settings.document_folding_ranges.unwrap(),
|
|
document_symbols: settings.document_symbols.unwrap(),
|
|
allow_rewrap: settings.allow_rewrap.unwrap(),
|
|
show_edit_predictions: settings.show_edit_predictions.unwrap(),
|
|
edit_predictions_disabled_in: settings.edit_predictions_disabled_in.unwrap(),
|
|
show_whitespaces: settings.show_whitespaces.unwrap(),
|
|
whitespace_map: WhitespaceMap {
|
|
space: SharedString::new(whitespace_map.space.unwrap().to_string()),
|
|
tab: SharedString::new(whitespace_map.tab.unwrap().to_string()),
|
|
},
|
|
extend_comment_on_newline: settings.extend_comment_on_newline.unwrap(),
|
|
extend_list_on_newline: settings.extend_list_on_newline.unwrap(),
|
|
indent_list_on_tab: settings.indent_list_on_tab.unwrap(),
|
|
inlay_hints: InlayHintSettings {
|
|
enabled: inlay_hints.enabled.unwrap(),
|
|
show_value_hints: inlay_hints.show_value_hints.unwrap(),
|
|
show_type_hints: inlay_hints.show_type_hints.unwrap(),
|
|
show_parameter_hints: inlay_hints.show_parameter_hints.unwrap(),
|
|
show_other_hints: inlay_hints.show_other_hints.unwrap(),
|
|
show_background: inlay_hints.show_background.unwrap(),
|
|
edit_debounce_ms: inlay_hints.edit_debounce_ms.unwrap(),
|
|
scroll_debounce_ms: inlay_hints.scroll_debounce_ms.unwrap(),
|
|
toggle_on_modifiers_press: inlay_hints
|
|
.toggle_on_modifiers_press
|
|
.map(|m| m.into_gpui()),
|
|
},
|
|
use_autoclose: settings.use_autoclose.unwrap(),
|
|
use_auto_surround: settings.use_auto_surround.unwrap(),
|
|
use_on_type_format: settings.use_on_type_format.unwrap(),
|
|
auto_indent: settings.auto_indent.unwrap(),
|
|
auto_indent_on_paste: settings.auto_indent_on_paste.unwrap(),
|
|
always_treat_brackets_as_autoclosed: settings
|
|
.always_treat_brackets_as_autoclosed
|
|
.unwrap(),
|
|
code_actions_on_format: settings.code_actions_on_format.unwrap(),
|
|
linked_edits: settings.linked_edits.unwrap(),
|
|
tasks: LanguageTaskSettings {
|
|
variables: tasks.variables.unwrap_or_default(),
|
|
enabled: tasks.enabled.unwrap(),
|
|
prefer_lsp: tasks.prefer_lsp.unwrap(),
|
|
},
|
|
show_completions_on_input: settings.show_completions_on_input.unwrap(),
|
|
show_completion_documentation: settings.show_completion_documentation.unwrap(),
|
|
colorize_brackets: settings.colorize_brackets.unwrap(),
|
|
completions: CompletionSettings {
|
|
words: completions.words.unwrap(),
|
|
words_min_length: completions.words_min_length.unwrap() as usize,
|
|
lsp: completions.lsp.unwrap(),
|
|
lsp_fetch_timeout_ms: completions.lsp_fetch_timeout_ms.unwrap(),
|
|
lsp_insert_mode: completions.lsp_insert_mode.unwrap(),
|
|
},
|
|
debuggers: settings.debuggers.unwrap(),
|
|
word_diff_enabled: settings.word_diff_enabled.unwrap(),
|
|
}
|
|
}
|
|
|
|
let default_language_settings = load_from_content(all_languages.defaults.clone());
|
|
|
|
let mut languages = HashMap::default();
|
|
for (language_name, settings) in &all_languages.languages.0 {
|
|
let mut language_settings = all_languages.defaults.clone();
|
|
settings::merge_from::MergeFrom::merge_from(&mut language_settings, settings);
|
|
languages.insert(
|
|
LanguageName(language_name.clone().into()),
|
|
load_from_content(language_settings),
|
|
);
|
|
}
|
|
|
|
let edit_prediction_provider = all_languages
|
|
.edit_predictions
|
|
.as_ref()
|
|
.and_then(|ep| ep.provider);
|
|
|
|
let edit_predictions = all_languages.edit_predictions.clone().unwrap();
|
|
let edit_predictions_mode = edit_predictions.mode.unwrap();
|
|
|
|
let disabled_globs: HashSet<&String> = edit_predictions
|
|
.disabled_globs
|
|
.as_ref()
|
|
.unwrap()
|
|
.iter()
|
|
.collect();
|
|
|
|
let copilot = edit_predictions.copilot.unwrap();
|
|
let copilot_settings = CopilotSettings {
|
|
proxy: copilot.proxy,
|
|
proxy_no_verify: copilot.proxy_no_verify,
|
|
enterprise_uri: copilot.enterprise_uri,
|
|
enable_next_edit_suggestions: copilot.enable_next_edit_suggestions,
|
|
};
|
|
|
|
let codestral = edit_predictions.codestral.unwrap();
|
|
let codestral_settings = CodestralSettings {
|
|
model: codestral.model,
|
|
max_tokens: codestral.max_tokens,
|
|
api_url: codestral.api_url,
|
|
};
|
|
|
|
let sweep = edit_predictions.sweep.unwrap();
|
|
let sweep_settings = SweepSettings {
|
|
privacy_mode: sweep.privacy_mode.unwrap(),
|
|
};
|
|
let ollama = edit_predictions.ollama.unwrap();
|
|
let ollama_settings = OllamaSettings {
|
|
model: ollama.model.map(|m| m.0),
|
|
max_output_tokens: ollama.max_output_tokens.unwrap(),
|
|
api_url: ollama.api_url.unwrap().into(),
|
|
};
|
|
|
|
let enabled_in_text_threads = edit_predictions.enabled_in_text_threads.unwrap();
|
|
|
|
let mut file_types: FxHashMap<Arc<str>, (GlobSet, Vec<String>)> = FxHashMap::default();
|
|
|
|
for (language, patterns) in all_languages.file_types.iter().flatten() {
|
|
let mut builder = GlobSetBuilder::new();
|
|
|
|
for pattern in &patterns.0 {
|
|
builder.add(Glob::new(pattern).unwrap());
|
|
}
|
|
|
|
file_types.insert(
|
|
language.clone(),
|
|
(builder.build().unwrap(), patterns.0.clone()),
|
|
);
|
|
}
|
|
|
|
Self {
|
|
edit_predictions: EditPredictionSettings {
|
|
provider: if let Some(provider) = edit_prediction_provider {
|
|
provider
|
|
} else {
|
|
EditPredictionProvider::None
|
|
},
|
|
disabled_globs: disabled_globs
|
|
.iter()
|
|
.filter_map(|g| {
|
|
let expanded_g = shellexpand::tilde(g).into_owned();
|
|
Some(DisabledGlob {
|
|
matcher: globset::Glob::new(&expanded_g).ok()?.compile_matcher(),
|
|
is_absolute: Path::new(&expanded_g).is_absolute(),
|
|
})
|
|
})
|
|
.collect(),
|
|
mode: edit_predictions_mode,
|
|
copilot: copilot_settings,
|
|
codestral: codestral_settings,
|
|
sweep: sweep_settings,
|
|
ollama: ollama_settings,
|
|
enabled_in_text_threads,
|
|
examples_dir: edit_predictions.examples_dir,
|
|
},
|
|
defaults: default_language_settings,
|
|
languages,
|
|
file_types,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Default, Debug, Clone, PartialEq, Eq)]
|
|
pub struct JsxTagAutoCloseSettings {
|
|
/// Enables or disables auto-closing of JSX tags.
|
|
pub enabled: bool,
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
use gpui::TestAppContext;
|
|
use util::rel_path::rel_path;
|
|
|
|
#[gpui::test]
|
|
fn test_edit_predictions_enabled_for_file(cx: &mut TestAppContext) {
|
|
use crate::TestFile;
|
|
use std::path::PathBuf;
|
|
|
|
let cx = cx.app.borrow_mut();
|
|
|
|
let build_settings = |globs: &[&str]| -> EditPredictionSettings {
|
|
EditPredictionSettings {
|
|
disabled_globs: globs
|
|
.iter()
|
|
.map(|glob_str| {
|
|
#[cfg(windows)]
|
|
let glob_str = {
|
|
let mut g = String::new();
|
|
|
|
if glob_str.starts_with('/') {
|
|
g.push_str("C:");
|
|
}
|
|
|
|
g.push_str(&glob_str.replace('/', "\\"));
|
|
g
|
|
};
|
|
#[cfg(windows)]
|
|
let glob_str = glob_str.as_str();
|
|
let expanded_glob_str = shellexpand::tilde(glob_str).into_owned();
|
|
DisabledGlob {
|
|
matcher: globset::Glob::new(&expanded_glob_str)
|
|
.unwrap()
|
|
.compile_matcher(),
|
|
is_absolute: Path::new(&expanded_glob_str).is_absolute(),
|
|
}
|
|
})
|
|
.collect(),
|
|
..Default::default()
|
|
}
|
|
};
|
|
|
|
const WORKTREE_NAME: &str = "project";
|
|
let make_test_file = |segments: &[&str]| -> Arc<dyn File> {
|
|
let path = segments.join("/");
|
|
let path = rel_path(&path);
|
|
|
|
Arc::new(TestFile {
|
|
path: path.into(),
|
|
root_name: WORKTREE_NAME.to_string(),
|
|
local_root: Some(PathBuf::from(if cfg!(windows) {
|
|
"C:\\absolute\\"
|
|
} else {
|
|
"/absolute/"
|
|
})),
|
|
})
|
|
};
|
|
|
|
let test_file = make_test_file(&["src", "test", "file.rs"]);
|
|
|
|
// Test relative globs
|
|
let settings = build_settings(&["*.rs"]);
|
|
assert!(!settings.enabled_for_file(&test_file, &cx));
|
|
let settings = build_settings(&["*.txt"]);
|
|
assert!(settings.enabled_for_file(&test_file, &cx));
|
|
|
|
// Test absolute globs
|
|
let settings = build_settings(&["/absolute/**/*.rs"]);
|
|
assert!(!settings.enabled_for_file(&test_file, &cx));
|
|
let settings = build_settings(&["/other/**/*.rs"]);
|
|
assert!(settings.enabled_for_file(&test_file, &cx));
|
|
|
|
// Test exact path match relative
|
|
let settings = build_settings(&["src/test/file.rs"]);
|
|
assert!(!settings.enabled_for_file(&test_file, &cx));
|
|
let settings = build_settings(&["src/test/otherfile.rs"]);
|
|
assert!(settings.enabled_for_file(&test_file, &cx));
|
|
|
|
// Test exact path match absolute
|
|
let settings = build_settings(&[&format!("/absolute/{}/src/test/file.rs", WORKTREE_NAME)]);
|
|
assert!(!settings.enabled_for_file(&test_file, &cx));
|
|
let settings = build_settings(&["/other/test/otherfile.rs"]);
|
|
assert!(settings.enabled_for_file(&test_file, &cx));
|
|
|
|
// Test * glob
|
|
let settings = build_settings(&["*"]);
|
|
assert!(!settings.enabled_for_file(&test_file, &cx));
|
|
let settings = build_settings(&["*.txt"]);
|
|
assert!(settings.enabled_for_file(&test_file, &cx));
|
|
|
|
// Test **/* glob
|
|
let settings = build_settings(&["**/*"]);
|
|
assert!(!settings.enabled_for_file(&test_file, &cx));
|
|
let settings = build_settings(&["other/**/*"]);
|
|
assert!(settings.enabled_for_file(&test_file, &cx));
|
|
|
|
// Test directory/** glob
|
|
let settings = build_settings(&["src/**"]);
|
|
assert!(!settings.enabled_for_file(&test_file, &cx));
|
|
|
|
let test_file_root: Arc<dyn File> = Arc::new(TestFile {
|
|
path: rel_path("file.rs").into(),
|
|
root_name: WORKTREE_NAME.to_string(),
|
|
local_root: Some(PathBuf::from("/absolute/")),
|
|
});
|
|
assert!(settings.enabled_for_file(&test_file_root, &cx));
|
|
|
|
let settings = build_settings(&["other/**"]);
|
|
assert!(settings.enabled_for_file(&test_file, &cx));
|
|
|
|
// Test **/directory/* glob
|
|
let settings = build_settings(&["**/test/*"]);
|
|
assert!(!settings.enabled_for_file(&test_file, &cx));
|
|
let settings = build_settings(&["**/other/*"]);
|
|
assert!(settings.enabled_for_file(&test_file, &cx));
|
|
|
|
// Test multiple globs
|
|
let settings = build_settings(&["*.rs", "*.txt", "src/**"]);
|
|
assert!(!settings.enabled_for_file(&test_file, &cx));
|
|
let settings = build_settings(&["*.txt", "*.md", "other/**"]);
|
|
assert!(settings.enabled_for_file(&test_file, &cx));
|
|
|
|
// Test dot files
|
|
let dot_file = make_test_file(&[".config", "settings.json"]);
|
|
let settings = build_settings(&[".*/**"]);
|
|
assert!(!settings.enabled_for_file(&dot_file, &cx));
|
|
|
|
let dot_env_file = make_test_file(&[".env"]);
|
|
let settings = build_settings(&[".env"]);
|
|
assert!(!settings.enabled_for_file(&dot_env_file, &cx));
|
|
|
|
// Test tilde expansion
|
|
let home = shellexpand::tilde("~").into_owned();
|
|
let home_file = Arc::new(TestFile {
|
|
path: rel_path("test.rs").into(),
|
|
root_name: "the-dir".to_string(),
|
|
local_root: Some(PathBuf::from(home)),
|
|
}) as Arc<dyn File>;
|
|
let settings = build_settings(&["~/the-dir/test.rs"]);
|
|
assert!(!settings.enabled_for_file(&home_file, &cx));
|
|
}
|
|
|
|
#[test]
|
|
fn test_resolve_language_servers() {
|
|
fn language_server_names(names: &[&str]) -> Vec<LanguageServerName> {
|
|
names
|
|
.iter()
|
|
.copied()
|
|
.map(|name| LanguageServerName(name.to_string().into()))
|
|
.collect::<Vec<_>>()
|
|
}
|
|
|
|
let available_language_servers = language_server_names(&[
|
|
"typescript-language-server",
|
|
"biome",
|
|
"deno",
|
|
"eslint",
|
|
"tailwind",
|
|
]);
|
|
|
|
// A value of just `["..."]` is the same as taking all of the available language servers.
|
|
assert_eq!(
|
|
LanguageSettings::resolve_language_servers(
|
|
&[LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()],
|
|
&available_language_servers,
|
|
),
|
|
available_language_servers
|
|
);
|
|
|
|
// Referencing one of the available language servers will change its order.
|
|
assert_eq!(
|
|
LanguageSettings::resolve_language_servers(
|
|
&[
|
|
"biome".into(),
|
|
LanguageSettings::REST_OF_LANGUAGE_SERVERS.into(),
|
|
"deno".into()
|
|
],
|
|
&available_language_servers
|
|
),
|
|
language_server_names(&[
|
|
"biome",
|
|
"typescript-language-server",
|
|
"eslint",
|
|
"tailwind",
|
|
"deno",
|
|
])
|
|
);
|
|
|
|
// Negating an available language server removes it from the list.
|
|
assert_eq!(
|
|
LanguageSettings::resolve_language_servers(
|
|
&[
|
|
"deno".into(),
|
|
"!typescript-language-server".into(),
|
|
"!biome".into(),
|
|
LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()
|
|
],
|
|
&available_language_servers
|
|
),
|
|
language_server_names(&["deno", "eslint", "tailwind"])
|
|
);
|
|
|
|
// Adding a language server not in the list of available language servers adds it to the list.
|
|
assert_eq!(
|
|
LanguageSettings::resolve_language_servers(
|
|
&[
|
|
"my-cool-language-server".into(),
|
|
LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()
|
|
],
|
|
&available_language_servers
|
|
),
|
|
language_server_names(&[
|
|
"my-cool-language-server",
|
|
"typescript-language-server",
|
|
"biome",
|
|
"deno",
|
|
"eslint",
|
|
"tailwind",
|
|
])
|
|
);
|
|
}
|
|
}
|