1//! Provides `language`-related settings.
2
3use crate::{File, Language, LanguageName, LanguageServerName};
4use anyhow::Result;
5use collections::{FxHashMap, HashMap, HashSet};
6use ec4rs::{
7 Properties as EditorconfigProperties,
8 property::{FinalNewline, IndentSize, IndentStyle, TabWidth, TrimTrailingWs},
9};
10use globset::{Glob, GlobMatcher, GlobSet, GlobSetBuilder};
11use gpui::{App, Modifiers};
12use itertools::{Either, Itertools};
13use schemars::{JsonSchema, json_schema};
14use serde::{
15 Deserialize, Deserializer, Serialize,
16 de::{self, IntoDeserializer, MapAccess, SeqAccess, Visitor},
17};
18
19use settings::{
20 ParameterizedJsonSchema, Settings, SettingsLocation, SettingsSources, SettingsStore,
21};
22use shellexpand;
23use std::{borrow::Cow, num::NonZeroU32, path::Path, slice, sync::Arc};
24use util::schemars::replace_subschema;
25use util::serde::default_true;
26
27/// Initializes the language settings.
28pub fn init(cx: &mut App) {
29 AllLanguageSettings::register(cx);
30}
31
32/// Returns the settings for the specified language from the provided file.
33pub fn language_settings<'a>(
34 language: Option<LanguageName>,
35 file: Option<&'a Arc<dyn File>>,
36 cx: &'a App,
37) -> Cow<'a, LanguageSettings> {
38 let location = file.map(|f| SettingsLocation {
39 worktree_id: f.worktree_id(cx),
40 path: f.path().as_ref(),
41 });
42 AllLanguageSettings::get(location, cx).language(location, language.as_ref(), cx)
43}
44
45/// Returns the settings for all languages from the provided file.
46pub fn all_language_settings<'a>(
47 file: Option<&'a Arc<dyn File>>,
48 cx: &'a App,
49) -> &'a AllLanguageSettings {
50 let location = file.map(|f| SettingsLocation {
51 worktree_id: f.worktree_id(cx),
52 path: f.path().as_ref(),
53 });
54 AllLanguageSettings::get(location, cx)
55}
56
57/// The settings for all languages.
58#[derive(Debug, Clone)]
59pub struct AllLanguageSettings {
60 /// The edit prediction settings.
61 pub edit_predictions: EditPredictionSettings,
62 pub defaults: LanguageSettings,
63 languages: HashMap<LanguageName, LanguageSettings>,
64 pub(crate) file_types: FxHashMap<Arc<str>, GlobSet>,
65}
66
67/// The settings for a particular language.
68#[derive(Debug, Clone, Deserialize)]
69pub struct LanguageSettings {
70 /// How many columns a tab should occupy.
71 pub tab_size: NonZeroU32,
72 /// Whether to indent lines using tab characters, as opposed to multiple
73 /// spaces.
74 pub hard_tabs: bool,
75 /// How to soft-wrap long lines of text.
76 pub soft_wrap: SoftWrap,
77 /// The column at which to soft-wrap lines, for buffers where soft-wrap
78 /// is enabled.
79 pub preferred_line_length: u32,
80 /// Whether to show wrap guides (vertical rulers) in the editor.
81 /// Setting this to true will show a guide at the 'preferred_line_length' value
82 /// if softwrap is set to 'preferred_line_length', and will show any
83 /// additional guides as specified by the 'wrap_guides' setting.
84 pub show_wrap_guides: bool,
85 /// Character counts at which to show wrap guides (vertical rulers) in the editor.
86 pub wrap_guides: Vec<usize>,
87 /// Indent guide related settings.
88 pub indent_guides: IndentGuideSettings,
89 /// Whether or not to perform a buffer format before saving.
90 pub format_on_save: FormatOnSave,
91 /// Whether or not to remove any trailing whitespace from lines of a buffer
92 /// before saving it.
93 pub remove_trailing_whitespace_on_save: bool,
94 /// Whether or not to ensure there's a single newline at the end of a buffer
95 /// when saving it.
96 pub ensure_final_newline_on_save: bool,
97 /// How to perform a buffer format.
98 pub formatter: SelectedFormatter,
99 /// Zed's Prettier integration settings.
100 pub prettier: PrettierSettings,
101 /// Whether to automatically close JSX tags.
102 pub jsx_tag_auto_close: JsxTagAutoCloseSettings,
103 /// Whether to use language servers to provide code intelligence.
104 pub enable_language_server: bool,
105 /// The list of language servers to use (or disable) for this language.
106 ///
107 /// This array should consist of language server IDs, as well as the following
108 /// special tokens:
109 /// - `"!<language_server_id>"` - A language server ID prefixed with a `!` will be disabled.
110 /// - `"..."` - A placeholder to refer to the **rest** of the registered language servers for this language.
111 pub language_servers: Vec<String>,
112 /// Controls where the `editor::Rewrap` action is allowed for this language.
113 ///
114 /// Note: This setting has no effect in Vim mode, as rewrap is already
115 /// allowed everywhere.
116 pub allow_rewrap: RewrapBehavior,
117 /// Controls whether edit predictions are shown immediately (true)
118 /// or manually by triggering `editor::ShowEditPrediction` (false).
119 pub show_edit_predictions: bool,
120 /// Controls whether edit predictions are shown in the given language
121 /// scopes.
122 pub edit_predictions_disabled_in: Vec<String>,
123 /// Whether to show tabs and spaces in the editor.
124 pub show_whitespaces: ShowWhitespaceSetting,
125 /// Whether to start a new line with a comment when a previous line is a comment as well.
126 pub extend_comment_on_newline: bool,
127 /// Inlay hint related settings.
128 pub inlay_hints: InlayHintSettings,
129 /// Whether to automatically close brackets.
130 pub use_autoclose: bool,
131 /// Whether to automatically surround text with brackets.
132 pub use_auto_surround: bool,
133 /// Whether to use additional LSP queries to format (and amend) the code after
134 /// every "trigger" symbol input, defined by LSP server capabilities.
135 pub use_on_type_format: bool,
136 /// Whether indentation should be adjusted based on the context whilst typing.
137 pub auto_indent: bool,
138 /// Whether indentation of pasted content should be adjusted based on the context.
139 pub auto_indent_on_paste: bool,
140 /// Controls how the editor handles the autoclosed characters.
141 pub always_treat_brackets_as_autoclosed: bool,
142 /// Which code actions to run on save
143 pub code_actions_on_format: HashMap<String, bool>,
144 /// Whether to perform linked edits
145 pub linked_edits: bool,
146 /// Task configuration for this language.
147 pub tasks: LanguageTaskConfig,
148 /// Whether to pop the completions menu while typing in an editor without
149 /// explicitly requesting it.
150 pub show_completions_on_input: bool,
151 /// Whether to display inline and alongside documentation for items in the
152 /// completions menu.
153 pub show_completion_documentation: bool,
154 /// Completion settings for this language.
155 pub completions: CompletionSettings,
156 /// Preferred debuggers for this language.
157 pub debuggers: Vec<String>,
158}
159
160impl LanguageSettings {
161 /// A token representing the rest of the available language servers.
162 const REST_OF_LANGUAGE_SERVERS: &'static str = "...";
163
164 /// Returns the customized list of language servers from the list of
165 /// available language servers.
166 pub fn customized_language_servers(
167 &self,
168 available_language_servers: &[LanguageServerName],
169 ) -> Vec<LanguageServerName> {
170 Self::resolve_language_servers(&self.language_servers, available_language_servers)
171 }
172
173 pub(crate) fn resolve_language_servers(
174 configured_language_servers: &[String],
175 available_language_servers: &[LanguageServerName],
176 ) -> Vec<LanguageServerName> {
177 let (disabled_language_servers, enabled_language_servers): (
178 Vec<LanguageServerName>,
179 Vec<LanguageServerName>,
180 ) = configured_language_servers.iter().partition_map(
181 |language_server| match language_server.strip_prefix('!') {
182 Some(disabled) => Either::Left(LanguageServerName(disabled.to_string().into())),
183 None => Either::Right(LanguageServerName(language_server.clone().into())),
184 },
185 );
186
187 let rest = available_language_servers
188 .iter()
189 .filter(|&available_language_server| {
190 !disabled_language_servers.contains(available_language_server)
191 && !enabled_language_servers.contains(available_language_server)
192 })
193 .cloned()
194 .collect::<Vec<_>>();
195
196 enabled_language_servers
197 .into_iter()
198 .flat_map(|language_server| {
199 if language_server.0.as_ref() == Self::REST_OF_LANGUAGE_SERVERS {
200 rest.clone()
201 } else {
202 vec![language_server]
203 }
204 })
205 .collect::<Vec<_>>()
206 }
207}
208
209/// The provider that supplies edit predictions.
210#[derive(Copy, Clone, Debug, Default, Eq, PartialEq, Serialize, Deserialize, JsonSchema)]
211#[serde(rename_all = "snake_case")]
212pub enum EditPredictionProvider {
213 None,
214 #[default]
215 Copilot,
216 Supermaven,
217 Zed,
218}
219
220impl EditPredictionProvider {
221 pub fn is_zed(&self) -> bool {
222 match self {
223 EditPredictionProvider::Zed => true,
224 EditPredictionProvider::None
225 | EditPredictionProvider::Copilot
226 | EditPredictionProvider::Supermaven => false,
227 }
228 }
229}
230
231/// The settings for edit predictions, such as [GitHub Copilot](https://github.com/features/copilot)
232/// or [Supermaven](https://supermaven.com).
233#[derive(Clone, Debug, Default)]
234pub struct EditPredictionSettings {
235 /// The provider that supplies edit predictions.
236 pub provider: EditPredictionProvider,
237 /// A list of globs representing files that edit predictions should be disabled for.
238 /// This list adds to a pre-existing, sensible default set of globs.
239 /// Any additional ones you add are combined with them.
240 pub disabled_globs: Vec<DisabledGlob>,
241 /// Configures how edit predictions are displayed in the buffer.
242 pub mode: EditPredictionsMode,
243 /// Settings specific to GitHub Copilot.
244 pub copilot: CopilotSettings,
245 /// Whether edit predictions are enabled in the assistant panel.
246 /// This setting has no effect if globally disabled.
247 pub enabled_in_text_threads: bool,
248}
249
250impl EditPredictionSettings {
251 /// Returns whether edit predictions are enabled for the given path.
252 pub fn enabled_for_file(&self, file: &Arc<dyn File>, cx: &App) -> bool {
253 !self.disabled_globs.iter().any(|glob| {
254 if glob.is_absolute {
255 file.as_local()
256 .is_some_and(|local| glob.matcher.is_match(local.abs_path(cx)))
257 } else {
258 glob.matcher.is_match(file.path())
259 }
260 })
261 }
262}
263
264#[derive(Clone, Debug)]
265pub struct DisabledGlob {
266 matcher: GlobMatcher,
267 is_absolute: bool,
268}
269
270/// The mode in which edit predictions should be displayed.
271#[derive(Copy, Clone, Debug, Default, Eq, PartialEq, Serialize, Deserialize, JsonSchema)]
272#[serde(rename_all = "snake_case")]
273pub enum EditPredictionsMode {
274 /// If provider supports it, display inline when holding modifier key (e.g., alt).
275 /// Otherwise, eager preview is used.
276 #[serde(alias = "auto")]
277 Subtle,
278 /// Display inline when there are no language server completions available.
279 #[default]
280 #[serde(alias = "eager_preview")]
281 Eager,
282}
283
284#[derive(Clone, Debug, Default)]
285pub struct CopilotSettings {
286 /// HTTP/HTTPS proxy to use for Copilot.
287 pub proxy: Option<String>,
288 /// Disable certificate verification for proxy (not recommended).
289 pub proxy_no_verify: Option<bool>,
290 /// Enterprise URI for Copilot.
291 pub enterprise_uri: Option<String>,
292}
293
294/// The settings for all languages.
295#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize, JsonSchema)]
296pub struct AllLanguageSettingsContent {
297 /// The settings for enabling/disabling features.
298 #[serde(default)]
299 pub features: Option<FeaturesContent>,
300 /// The edit prediction settings.
301 #[serde(default)]
302 pub edit_predictions: Option<EditPredictionSettingsContent>,
303 /// The default language settings.
304 #[serde(flatten)]
305 pub defaults: LanguageSettingsContent,
306 /// The settings for individual languages.
307 #[serde(default)]
308 pub languages: LanguageToSettingsMap,
309 /// Settings for associating file extensions and filenames
310 /// with languages.
311 #[serde(default)]
312 pub file_types: HashMap<Arc<str>, Vec<String>>,
313}
314
315/// Map from language name to settings. Its `ParameterizedJsonSchema` allows only known language
316/// names in the keys.
317#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize, JsonSchema)]
318pub struct LanguageToSettingsMap(pub HashMap<LanguageName, LanguageSettingsContent>);
319
320inventory::submit! {
321 ParameterizedJsonSchema {
322 add_and_get_ref: |generator, params, _cx| {
323 let language_settings_content_ref = generator
324 .subschema_for::<LanguageSettingsContent>()
325 .to_value();
326 replace_subschema::<LanguageToSettingsMap>(generator, || json_schema!({
327 "type": "object",
328 "properties": params
329 .language_names
330 .iter()
331 .map(|name| {
332 (
333 name.clone(),
334 language_settings_content_ref.clone(),
335 )
336 })
337 .collect::<serde_json::Map<_, _>>()
338 }))
339 }
340 }
341}
342
343/// Controls how completions are processed for this language.
344#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
345#[serde(rename_all = "snake_case")]
346pub struct CompletionSettings {
347 /// Controls how words are completed.
348 /// For large documents, not all words may be fetched for completion.
349 ///
350 /// Default: `fallback`
351 #[serde(default = "default_words_completion_mode")]
352 pub words: WordsCompletionMode,
353 /// Whether to fetch LSP completions or not.
354 ///
355 /// Default: true
356 #[serde(default = "default_true")]
357 pub lsp: bool,
358 /// When fetching LSP completions, determines how long to wait for a response of a particular server.
359 /// When set to 0, waits indefinitely.
360 ///
361 /// Default: 0
362 #[serde(default = "default_lsp_fetch_timeout_ms")]
363 pub lsp_fetch_timeout_ms: u64,
364 /// Controls how LSP completions are inserted.
365 ///
366 /// Default: "replace_suffix"
367 #[serde(default = "default_lsp_insert_mode")]
368 pub lsp_insert_mode: LspInsertMode,
369}
370
371/// Controls how document's words are completed.
372#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
373#[serde(rename_all = "snake_case")]
374pub enum WordsCompletionMode {
375 /// Always fetch document's words for completions along with LSP completions.
376 Enabled,
377 /// Only if LSP response errors or times out,
378 /// use document's words to show completions.
379 Fallback,
380 /// Never fetch or complete document's words for completions.
381 /// (Word-based completions can still be queried via a separate action)
382 Disabled,
383}
384
385#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
386#[serde(rename_all = "snake_case")]
387pub enum LspInsertMode {
388 /// Replaces text before the cursor, using the `insert` range described in the LSP specification.
389 Insert,
390 /// Replaces text before and after the cursor, using the `replace` range described in the LSP specification.
391 Replace,
392 /// Behaves like `"replace"` if the text that would be replaced is a subsequence of the completion text,
393 /// and like `"insert"` otherwise.
394 ReplaceSubsequence,
395 /// Behaves like `"replace"` if the text after the cursor is a suffix of the completion, and like
396 /// `"insert"` otherwise.
397 ReplaceSuffix,
398}
399
400fn default_words_completion_mode() -> WordsCompletionMode {
401 WordsCompletionMode::Fallback
402}
403
404fn default_lsp_insert_mode() -> LspInsertMode {
405 LspInsertMode::ReplaceSuffix
406}
407
408fn default_lsp_fetch_timeout_ms() -> u64 {
409 0
410}
411
412/// The settings for a particular language.
413#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize, JsonSchema)]
414pub struct LanguageSettingsContent {
415 /// How many columns a tab should occupy.
416 ///
417 /// Default: 4
418 #[serde(default)]
419 pub tab_size: Option<NonZeroU32>,
420 /// Whether to indent lines using tab characters, as opposed to multiple
421 /// spaces.
422 ///
423 /// Default: false
424 #[serde(default)]
425 pub hard_tabs: Option<bool>,
426 /// How to soft-wrap long lines of text.
427 ///
428 /// Default: none
429 #[serde(default)]
430 pub soft_wrap: Option<SoftWrap>,
431 /// The column at which to soft-wrap lines, for buffers where soft-wrap
432 /// is enabled.
433 ///
434 /// Default: 80
435 #[serde(default)]
436 pub preferred_line_length: Option<u32>,
437 /// Whether to show wrap guides in the editor. Setting this to true will
438 /// show a guide at the 'preferred_line_length' value if softwrap is set to
439 /// 'preferred_line_length', and will show any additional guides as specified
440 /// by the 'wrap_guides' setting.
441 ///
442 /// Default: true
443 #[serde(default)]
444 pub show_wrap_guides: Option<bool>,
445 /// Character counts at which to show wrap guides in the editor.
446 ///
447 /// Default: []
448 #[serde(default)]
449 pub wrap_guides: Option<Vec<usize>>,
450 /// Indent guide related settings.
451 #[serde(default)]
452 pub indent_guides: Option<IndentGuideSettings>,
453 /// Whether or not to perform a buffer format before saving.
454 ///
455 /// Default: on
456 #[serde(default)]
457 pub format_on_save: Option<FormatOnSave>,
458 /// Whether or not to remove any trailing whitespace from lines of a buffer
459 /// before saving it.
460 ///
461 /// Default: true
462 #[serde(default)]
463 pub remove_trailing_whitespace_on_save: Option<bool>,
464 /// Whether or not to ensure there's a single newline at the end of a buffer
465 /// when saving it.
466 ///
467 /// Default: true
468 #[serde(default)]
469 pub ensure_final_newline_on_save: Option<bool>,
470 /// How to perform a buffer format.
471 ///
472 /// Default: auto
473 #[serde(default)]
474 pub formatter: Option<SelectedFormatter>,
475 /// Zed's Prettier integration settings.
476 /// Allows to enable/disable formatting with Prettier
477 /// and configure default Prettier, used when no project-level Prettier installation is found.
478 ///
479 /// Default: off
480 #[serde(default)]
481 pub prettier: Option<PrettierSettings>,
482 /// Whether to automatically close JSX tags.
483 #[serde(default)]
484 pub jsx_tag_auto_close: Option<JsxTagAutoCloseSettings>,
485 /// Whether to use language servers to provide code intelligence.
486 ///
487 /// Default: true
488 #[serde(default)]
489 pub enable_language_server: Option<bool>,
490 /// The list of language servers to use (or disable) for this language.
491 ///
492 /// This array should consist of language server IDs, as well as the following
493 /// special tokens:
494 /// - `"!<language_server_id>"` - A language server ID prefixed with a `!` will be disabled.
495 /// - `"..."` - A placeholder to refer to the **rest** of the registered language servers for this language.
496 ///
497 /// Default: ["..."]
498 #[serde(default)]
499 pub language_servers: Option<Vec<String>>,
500 /// Controls where the `editor::Rewrap` action is allowed for this language.
501 ///
502 /// Note: This setting has no effect in Vim mode, as rewrap is already
503 /// allowed everywhere.
504 ///
505 /// Default: "in_comments"
506 #[serde(default)]
507 pub allow_rewrap: Option<RewrapBehavior>,
508 /// Controls whether edit predictions are shown immediately (true)
509 /// or manually by triggering `editor::ShowEditPrediction` (false).
510 ///
511 /// Default: true
512 #[serde(default)]
513 pub show_edit_predictions: Option<bool>,
514 /// Controls whether edit predictions are shown in the given language
515 /// scopes.
516 ///
517 /// Example: ["string", "comment"]
518 ///
519 /// Default: []
520 #[serde(default)]
521 pub edit_predictions_disabled_in: Option<Vec<String>>,
522 /// Whether to show tabs and spaces in the editor.
523 #[serde(default)]
524 pub show_whitespaces: Option<ShowWhitespaceSetting>,
525 /// Whether to start a new line with a comment when a previous line is a comment as well.
526 ///
527 /// Default: true
528 #[serde(default)]
529 pub extend_comment_on_newline: Option<bool>,
530 /// Inlay hint related settings.
531 #[serde(default)]
532 pub inlay_hints: Option<InlayHintSettings>,
533 /// Whether to automatically type closing characters for you. For example,
534 /// when you type (, Zed will automatically add a closing ) at the correct position.
535 ///
536 /// Default: true
537 pub use_autoclose: Option<bool>,
538 /// Whether to automatically surround text with characters for you. For example,
539 /// when you select text and type (, Zed will automatically surround text with ().
540 ///
541 /// Default: true
542 pub use_auto_surround: Option<bool>,
543 /// Controls how the editor handles the autoclosed characters.
544 /// When set to `false`(default), skipping over and auto-removing of the closing characters
545 /// happen only for auto-inserted characters.
546 /// Otherwise(when `true`), the closing characters are always skipped over and auto-removed
547 /// no matter how they were inserted.
548 ///
549 /// Default: false
550 pub always_treat_brackets_as_autoclosed: Option<bool>,
551 /// Whether to use additional LSP queries to format (and amend) the code after
552 /// every "trigger" symbol input, defined by LSP server capabilities.
553 ///
554 /// Default: true
555 pub use_on_type_format: Option<bool>,
556 /// Which code actions to run on save after the formatter.
557 /// These are not run if formatting is off.
558 ///
559 /// Default: {} (or {"source.organizeImports": true} for Go).
560 pub code_actions_on_format: Option<HashMap<String, bool>>,
561 /// Whether to perform linked edits of associated ranges, if the language server supports it.
562 /// For example, when editing opening <html> tag, the contents of the closing </html> tag will be edited as well.
563 ///
564 /// Default: true
565 pub linked_edits: Option<bool>,
566 /// Whether indentation should be adjusted based on the context whilst typing.
567 ///
568 /// Default: true
569 pub auto_indent: Option<bool>,
570 /// Whether indentation of pasted content should be adjusted based on the context.
571 ///
572 /// Default: true
573 pub auto_indent_on_paste: Option<bool>,
574 /// Task configuration for this language.
575 ///
576 /// Default: {}
577 pub tasks: Option<LanguageTaskConfig>,
578 /// Whether to pop the completions menu while typing in an editor without
579 /// explicitly requesting it.
580 ///
581 /// Default: true
582 pub show_completions_on_input: Option<bool>,
583 /// Whether to display inline and alongside documentation for items in the
584 /// completions menu.
585 ///
586 /// Default: true
587 pub show_completion_documentation: Option<bool>,
588 /// Controls how completions are processed for this language.
589 pub completions: Option<CompletionSettings>,
590 /// Preferred debuggers for this language.
591 ///
592 /// Default: []
593 pub debuggers: Option<Vec<String>>,
594}
595
596/// The behavior of `editor::Rewrap`.
597#[derive(Debug, PartialEq, Clone, Copy, Default, Serialize, Deserialize, JsonSchema)]
598#[serde(rename_all = "snake_case")]
599pub enum RewrapBehavior {
600 /// Only rewrap within comments.
601 #[default]
602 InComments,
603 /// Only rewrap within the current selection(s).
604 InSelections,
605 /// Allow rewrapping anywhere.
606 Anywhere,
607}
608
609/// The contents of the edit prediction settings.
610#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema, PartialEq)]
611pub struct EditPredictionSettingsContent {
612 /// A list of globs representing files that edit predictions should be disabled for.
613 /// This list adds to a pre-existing, sensible default set of globs.
614 /// Any additional ones you add are combined with them.
615 #[serde(default)]
616 pub disabled_globs: Option<Vec<String>>,
617 /// The mode used to display edit predictions in the buffer.
618 /// Provider support required.
619 #[serde(default)]
620 pub mode: EditPredictionsMode,
621 /// Settings specific to GitHub Copilot.
622 #[serde(default)]
623 pub copilot: CopilotSettingsContent,
624 /// Whether edit predictions are enabled in the assistant prompt editor.
625 /// This has no effect if globally disabled.
626 #[serde(default = "default_true")]
627 pub enabled_in_text_threads: bool,
628}
629
630#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema, PartialEq)]
631pub struct CopilotSettingsContent {
632 /// HTTP/HTTPS proxy to use for Copilot.
633 ///
634 /// Default: none
635 #[serde(default)]
636 pub proxy: Option<String>,
637 /// Disable certificate verification for the proxy (not recommended).
638 ///
639 /// Default: false
640 #[serde(default)]
641 pub proxy_no_verify: Option<bool>,
642 /// Enterprise URI for Copilot.
643 ///
644 /// Default: none
645 #[serde(default)]
646 pub enterprise_uri: Option<String>,
647}
648
649/// The settings for enabling/disabling features.
650#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema)]
651#[serde(rename_all = "snake_case")]
652pub struct FeaturesContent {
653 /// Determines which edit prediction provider to use.
654 pub edit_prediction_provider: Option<EditPredictionProvider>,
655}
656
657/// Controls the soft-wrapping behavior in the editor.
658#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
659#[serde(rename_all = "snake_case")]
660pub enum SoftWrap {
661 /// Prefer a single line generally, unless an overly long line is encountered.
662 None,
663 /// Deprecated: use None instead. Left to avoid breaking existing users' configs.
664 /// Prefer a single line generally, unless an overly long line is encountered.
665 PreferLine,
666 /// Soft wrap lines that exceed the editor width.
667 EditorWidth,
668 /// Soft wrap lines at the preferred line length.
669 PreferredLineLength,
670 /// Soft wrap line at the preferred line length or the editor width (whichever is smaller).
671 Bounded,
672}
673
674/// Controls the behavior of formatting files when they are saved.
675#[derive(Debug, Clone, PartialEq, Eq)]
676pub enum FormatOnSave {
677 /// Files should be formatted on save.
678 On,
679 /// Files should not be formatted on save.
680 Off,
681 List(FormatterList),
682}
683
684impl JsonSchema for FormatOnSave {
685 fn schema_name() -> Cow<'static, str> {
686 "OnSaveFormatter".into()
687 }
688
689 fn json_schema(generator: &mut schemars::SchemaGenerator) -> schemars::Schema {
690 let formatter_schema = Formatter::json_schema(generator);
691
692 json_schema!({
693 "oneOf": [
694 {
695 "type": "array",
696 "items": formatter_schema
697 },
698 {
699 "type": "string",
700 "enum": ["on", "off", "language_server"]
701 },
702 formatter_schema
703 ]
704 })
705 }
706}
707
708impl Serialize for FormatOnSave {
709 fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
710 where
711 S: serde::Serializer,
712 {
713 match self {
714 Self::On => serializer.serialize_str("on"),
715 Self::Off => serializer.serialize_str("off"),
716 Self::List(list) => list.serialize(serializer),
717 }
718 }
719}
720
721impl<'de> Deserialize<'de> for FormatOnSave {
722 fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
723 where
724 D: Deserializer<'de>,
725 {
726 struct FormatDeserializer;
727
728 impl<'d> Visitor<'d> for FormatDeserializer {
729 type Value = FormatOnSave;
730
731 fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
732 formatter.write_str("a valid on-save formatter kind")
733 }
734 fn visit_str<E>(self, v: &str) -> std::result::Result<Self::Value, E>
735 where
736 E: serde::de::Error,
737 {
738 if v == "on" {
739 Ok(Self::Value::On)
740 } else if v == "off" {
741 Ok(Self::Value::Off)
742 } else if v == "language_server" {
743 Ok(Self::Value::List(FormatterList::Single(
744 Formatter::LanguageServer { name: None },
745 )))
746 } else {
747 let ret: Result<FormatterList, _> =
748 Deserialize::deserialize(v.into_deserializer());
749 ret.map(Self::Value::List)
750 }
751 }
752 fn visit_map<A>(self, map: A) -> Result<Self::Value, A::Error>
753 where
754 A: MapAccess<'d>,
755 {
756 let ret: Result<FormatterList, _> =
757 Deserialize::deserialize(de::value::MapAccessDeserializer::new(map));
758 ret.map(Self::Value::List)
759 }
760 fn visit_seq<A>(self, map: A) -> Result<Self::Value, A::Error>
761 where
762 A: SeqAccess<'d>,
763 {
764 let ret: Result<FormatterList, _> =
765 Deserialize::deserialize(de::value::SeqAccessDeserializer::new(map));
766 ret.map(Self::Value::List)
767 }
768 }
769 deserializer.deserialize_any(FormatDeserializer)
770 }
771}
772
773/// Controls how whitespace should be displayedin the editor.
774#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
775#[serde(rename_all = "snake_case")]
776pub enum ShowWhitespaceSetting {
777 /// Draw whitespace only for the selected text.
778 Selection,
779 /// Do not draw any tabs or spaces.
780 None,
781 /// Draw all invisible symbols.
782 All,
783 /// Draw whitespaces at boundaries only.
784 ///
785 /// For a whitespace to be on a boundary, any of the following conditions need to be met:
786 /// - It is a tab
787 /// - It is adjacent to an edge (start or end)
788 /// - It is adjacent to a whitespace (left or right)
789 Boundary,
790 /// Draw whitespaces only after non-whitespace characters.
791 Trailing,
792}
793
794/// Controls which formatter should be used when formatting code.
795#[derive(Clone, Debug, Default, PartialEq, Eq)]
796pub enum SelectedFormatter {
797 /// Format files using Zed's Prettier integration (if applicable),
798 /// or falling back to formatting via language server.
799 #[default]
800 Auto,
801 List(FormatterList),
802}
803
804impl JsonSchema for SelectedFormatter {
805 fn schema_name() -> Cow<'static, str> {
806 "Formatter".into()
807 }
808
809 fn json_schema(generator: &mut schemars::SchemaGenerator) -> schemars::Schema {
810 let formatter_schema = Formatter::json_schema(generator);
811
812 json_schema!({
813 "oneOf": [
814 {
815 "type": "array",
816 "items": formatter_schema
817 },
818 {
819 "type": "string",
820 "enum": ["auto", "language_server"]
821 },
822 formatter_schema
823 ]
824 })
825 }
826}
827
828impl Serialize for SelectedFormatter {
829 fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
830 where
831 S: serde::Serializer,
832 {
833 match self {
834 SelectedFormatter::Auto => serializer.serialize_str("auto"),
835 SelectedFormatter::List(list) => list.serialize(serializer),
836 }
837 }
838}
839
840impl<'de> Deserialize<'de> for SelectedFormatter {
841 fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
842 where
843 D: Deserializer<'de>,
844 {
845 struct FormatDeserializer;
846
847 impl<'d> Visitor<'d> for FormatDeserializer {
848 type Value = SelectedFormatter;
849
850 fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
851 formatter.write_str("a valid formatter kind")
852 }
853 fn visit_str<E>(self, v: &str) -> std::result::Result<Self::Value, E>
854 where
855 E: serde::de::Error,
856 {
857 if v == "auto" {
858 Ok(Self::Value::Auto)
859 } else if v == "language_server" {
860 Ok(Self::Value::List(FormatterList::Single(
861 Formatter::LanguageServer { name: None },
862 )))
863 } else {
864 let ret: Result<FormatterList, _> =
865 Deserialize::deserialize(v.into_deserializer());
866 ret.map(SelectedFormatter::List)
867 }
868 }
869 fn visit_map<A>(self, map: A) -> Result<Self::Value, A::Error>
870 where
871 A: MapAccess<'d>,
872 {
873 let ret: Result<FormatterList, _> =
874 Deserialize::deserialize(de::value::MapAccessDeserializer::new(map));
875 ret.map(SelectedFormatter::List)
876 }
877 fn visit_seq<A>(self, map: A) -> Result<Self::Value, A::Error>
878 where
879 A: SeqAccess<'d>,
880 {
881 let ret: Result<FormatterList, _> =
882 Deserialize::deserialize(de::value::SeqAccessDeserializer::new(map));
883 ret.map(SelectedFormatter::List)
884 }
885 }
886 deserializer.deserialize_any(FormatDeserializer)
887 }
888}
889
890/// Controls which formatters should be used when formatting code.
891#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
892#[serde(untagged)]
893pub enum FormatterList {
894 Single(Formatter),
895 Vec(Vec<Formatter>),
896}
897
898impl AsRef<[Formatter]> for FormatterList {
899 fn as_ref(&self) -> &[Formatter] {
900 match &self {
901 Self::Single(single) => slice::from_ref(single),
902 Self::Vec(v) => v,
903 }
904 }
905}
906
907/// Controls which formatter should be used when formatting code. If there are multiple formatters, they are executed in the order of declaration.
908#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
909#[serde(rename_all = "snake_case")]
910pub enum Formatter {
911 /// Format code using the current language server.
912 LanguageServer { name: Option<String> },
913 /// Format code using Zed's Prettier integration.
914 Prettier,
915 /// Format code using an external command.
916 External {
917 /// The external program to run.
918 command: Arc<str>,
919 /// The arguments to pass to the program.
920 arguments: Option<Arc<[String]>>,
921 },
922 /// Files should be formatted using code actions executed by language servers.
923 CodeActions(HashMap<String, bool>),
924}
925
926/// The settings for indent guides.
927#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
928pub struct IndentGuideSettings {
929 /// Whether to display indent guides in the editor.
930 ///
931 /// Default: true
932 #[serde(default = "default_true")]
933 pub enabled: bool,
934 /// The width of the indent guides in pixels, between 1 and 10.
935 ///
936 /// Default: 1
937 #[serde(default = "line_width")]
938 pub line_width: u32,
939 /// The width of the active indent guide in pixels, between 1 and 10.
940 ///
941 /// Default: 1
942 #[serde(default = "active_line_width")]
943 pub active_line_width: u32,
944 /// Determines how indent guides are colored.
945 ///
946 /// Default: Fixed
947 #[serde(default)]
948 pub coloring: IndentGuideColoring,
949 /// Determines how indent guide backgrounds are colored.
950 ///
951 /// Default: Disabled
952 #[serde(default)]
953 pub background_coloring: IndentGuideBackgroundColoring,
954}
955
956fn line_width() -> u32 {
957 1
958}
959
960fn active_line_width() -> u32 {
961 line_width()
962}
963
964/// Determines how indent guides are colored.
965#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
966#[serde(rename_all = "snake_case")]
967pub enum IndentGuideColoring {
968 /// Do not render any lines for indent guides.
969 Disabled,
970 /// Use the same color for all indentation levels.
971 #[default]
972 Fixed,
973 /// Use a different color for each indentation level.
974 IndentAware,
975}
976
977/// Determines how indent guide backgrounds are colored.
978#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
979#[serde(rename_all = "snake_case")]
980pub enum IndentGuideBackgroundColoring {
981 /// Do not render any background for indent guides.
982 #[default]
983 Disabled,
984 /// Use a different color for each indentation level.
985 IndentAware,
986}
987
988/// The settings for inlay hints.
989#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
990pub struct InlayHintSettings {
991 /// Global switch to toggle hints on and off.
992 ///
993 /// Default: false
994 #[serde(default)]
995 pub enabled: bool,
996 /// Global switch to toggle inline values on and off when debugging.
997 ///
998 /// Default: true
999 #[serde(default = "default_true")]
1000 pub show_value_hints: bool,
1001 /// Whether type hints should be shown.
1002 ///
1003 /// Default: true
1004 #[serde(default = "default_true")]
1005 pub show_type_hints: bool,
1006 /// Whether parameter hints should be shown.
1007 ///
1008 /// Default: true
1009 #[serde(default = "default_true")]
1010 pub show_parameter_hints: bool,
1011 /// Whether other hints should be shown.
1012 ///
1013 /// Default: true
1014 #[serde(default = "default_true")]
1015 pub show_other_hints: bool,
1016 /// Whether to show a background for inlay hints.
1017 ///
1018 /// If set to `true`, the background will use the `hint.background` color
1019 /// from the current theme.
1020 ///
1021 /// Default: false
1022 #[serde(default)]
1023 pub show_background: bool,
1024 /// Whether or not to debounce inlay hints updates after buffer edits.
1025 ///
1026 /// Set to 0 to disable debouncing.
1027 ///
1028 /// Default: 700
1029 #[serde(default = "edit_debounce_ms")]
1030 pub edit_debounce_ms: u64,
1031 /// Whether or not to debounce inlay hints updates after buffer scrolls.
1032 ///
1033 /// Set to 0 to disable debouncing.
1034 ///
1035 /// Default: 50
1036 #[serde(default = "scroll_debounce_ms")]
1037 pub scroll_debounce_ms: u64,
1038 /// Toggles inlay hints (hides or shows) when the user presses the modifiers specified.
1039 /// If only a subset of the modifiers specified is pressed, hints are not toggled.
1040 /// If no modifiers are specified, this is equivalent to `None`.
1041 ///
1042 /// Default: None
1043 #[serde(default)]
1044 pub toggle_on_modifiers_press: Option<Modifiers>,
1045}
1046
1047fn edit_debounce_ms() -> u64 {
1048 700
1049}
1050
1051fn scroll_debounce_ms() -> u64 {
1052 50
1053}
1054
1055/// The task settings for a particular language.
1056#[derive(Debug, Clone, Deserialize, PartialEq, Serialize, JsonSchema)]
1057pub struct LanguageTaskConfig {
1058 /// Extra task variables to set for a particular language.
1059 #[serde(default)]
1060 pub variables: HashMap<String, String>,
1061 #[serde(default = "default_true")]
1062 pub enabled: bool,
1063 /// Use LSP tasks over Zed language extension ones.
1064 /// If no LSP tasks are returned due to error/timeout or regular execution,
1065 /// Zed language extension tasks will be used instead.
1066 ///
1067 /// Other Zed tasks will still be shown:
1068 /// * Zed task from either of the task config file
1069 /// * Zed task from history (e.g. one-off task was spawned before)
1070 #[serde(default = "default_true")]
1071 pub prefer_lsp: bool,
1072}
1073
1074impl InlayHintSettings {
1075 /// Returns the kinds of inlay hints that are enabled based on the settings.
1076 pub fn enabled_inlay_hint_kinds(&self) -> HashSet<Option<InlayHintKind>> {
1077 let mut kinds = HashSet::default();
1078 if self.show_type_hints {
1079 kinds.insert(Some(InlayHintKind::Type));
1080 }
1081 if self.show_parameter_hints {
1082 kinds.insert(Some(InlayHintKind::Parameter));
1083 }
1084 if self.show_other_hints {
1085 kinds.insert(None);
1086 }
1087 kinds
1088 }
1089}
1090
1091impl AllLanguageSettings {
1092 /// Returns the [`LanguageSettings`] for the language with the specified name.
1093 pub fn language<'a>(
1094 &'a self,
1095 location: Option<SettingsLocation<'a>>,
1096 language_name: Option<&LanguageName>,
1097 cx: &'a App,
1098 ) -> Cow<'a, LanguageSettings> {
1099 let settings = language_name
1100 .and_then(|name| self.languages.get(name))
1101 .unwrap_or(&self.defaults);
1102
1103 let editorconfig_properties = location.and_then(|location| {
1104 cx.global::<SettingsStore>()
1105 .editorconfig_properties(location.worktree_id, location.path)
1106 });
1107 if let Some(editorconfig_properties) = editorconfig_properties {
1108 let mut settings = settings.clone();
1109 merge_with_editorconfig(&mut settings, &editorconfig_properties);
1110 Cow::Owned(settings)
1111 } else {
1112 Cow::Borrowed(settings)
1113 }
1114 }
1115
1116 /// Returns whether edit predictions are enabled for the given path.
1117 pub fn edit_predictions_enabled_for_file(&self, file: &Arc<dyn File>, cx: &App) -> bool {
1118 self.edit_predictions.enabled_for_file(file, cx)
1119 }
1120
1121 /// Returns whether edit predictions are enabled for the given language and path.
1122 pub fn show_edit_predictions(&self, language: Option<&Arc<Language>>, cx: &App) -> bool {
1123 self.language(None, language.map(|l| l.name()).as_ref(), cx)
1124 .show_edit_predictions
1125 }
1126
1127 /// Returns the edit predictions preview mode for the given language and path.
1128 pub fn edit_predictions_mode(&self) -> EditPredictionsMode {
1129 self.edit_predictions.mode
1130 }
1131}
1132
1133fn merge_with_editorconfig(settings: &mut LanguageSettings, cfg: &EditorconfigProperties) {
1134 let tab_size = cfg.get::<IndentSize>().ok().and_then(|v| match v {
1135 IndentSize::Value(u) => NonZeroU32::new(u as u32),
1136 IndentSize::UseTabWidth => cfg.get::<TabWidth>().ok().and_then(|w| match w {
1137 TabWidth::Value(u) => NonZeroU32::new(u as u32),
1138 }),
1139 });
1140 let hard_tabs = cfg
1141 .get::<IndentStyle>()
1142 .map(|v| v.eq(&IndentStyle::Tabs))
1143 .ok();
1144 let ensure_final_newline_on_save = cfg
1145 .get::<FinalNewline>()
1146 .map(|v| match v {
1147 FinalNewline::Value(b) => b,
1148 })
1149 .ok();
1150 let remove_trailing_whitespace_on_save = cfg
1151 .get::<TrimTrailingWs>()
1152 .map(|v| match v {
1153 TrimTrailingWs::Value(b) => b,
1154 })
1155 .ok();
1156 fn merge<T>(target: &mut T, value: Option<T>) {
1157 if let Some(value) = value {
1158 *target = value;
1159 }
1160 }
1161 merge(&mut settings.tab_size, tab_size);
1162 merge(&mut settings.hard_tabs, hard_tabs);
1163 merge(
1164 &mut settings.remove_trailing_whitespace_on_save,
1165 remove_trailing_whitespace_on_save,
1166 );
1167 merge(
1168 &mut settings.ensure_final_newline_on_save,
1169 ensure_final_newline_on_save,
1170 );
1171}
1172
1173/// The kind of an inlay hint.
1174#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1175pub enum InlayHintKind {
1176 /// An inlay hint for a type.
1177 Type,
1178 /// An inlay hint for a parameter.
1179 Parameter,
1180}
1181
1182impl InlayHintKind {
1183 /// Returns the [`InlayHintKind`] from the given name.
1184 ///
1185 /// Returns `None` if `name` does not match any of the expected
1186 /// string representations.
1187 pub fn from_name(name: &str) -> Option<Self> {
1188 match name {
1189 "type" => Some(InlayHintKind::Type),
1190 "parameter" => Some(InlayHintKind::Parameter),
1191 _ => None,
1192 }
1193 }
1194
1195 /// Returns the name of this [`InlayHintKind`].
1196 pub fn name(&self) -> &'static str {
1197 match self {
1198 InlayHintKind::Type => "type",
1199 InlayHintKind::Parameter => "parameter",
1200 }
1201 }
1202}
1203
1204impl settings::Settings for AllLanguageSettings {
1205 const KEY: Option<&'static str> = None;
1206
1207 type FileContent = AllLanguageSettingsContent;
1208
1209 fn load(sources: SettingsSources<Self::FileContent>, _: &mut App) -> Result<Self> {
1210 let default_value = sources.default;
1211
1212 // A default is provided for all settings.
1213 let mut defaults: LanguageSettings =
1214 serde_json::from_value(serde_json::to_value(&default_value.defaults)?)?;
1215
1216 let mut languages = HashMap::default();
1217 for (language_name, settings) in &default_value.languages.0 {
1218 let mut language_settings = defaults.clone();
1219 merge_settings(&mut language_settings, settings);
1220 languages.insert(language_name.clone(), language_settings);
1221 }
1222
1223 let mut edit_prediction_provider = default_value
1224 .features
1225 .as_ref()
1226 .and_then(|f| f.edit_prediction_provider);
1227 let mut edit_predictions_mode = default_value
1228 .edit_predictions
1229 .as_ref()
1230 .map(|edit_predictions| edit_predictions.mode)
1231 .ok_or_else(Self::missing_default)?;
1232
1233 let mut completion_globs: HashSet<&String> = default_value
1234 .edit_predictions
1235 .as_ref()
1236 .and_then(|c| c.disabled_globs.as_ref())
1237 .map(|globs| globs.iter().collect())
1238 .ok_or_else(Self::missing_default)?;
1239
1240 let mut copilot_settings = default_value
1241 .edit_predictions
1242 .as_ref()
1243 .map(|settings| CopilotSettings {
1244 proxy: settings.copilot.proxy.clone(),
1245 proxy_no_verify: settings.copilot.proxy_no_verify,
1246 enterprise_uri: settings.copilot.enterprise_uri.clone(),
1247 })
1248 .unwrap_or_default();
1249
1250 let mut enabled_in_text_threads = default_value
1251 .edit_predictions
1252 .as_ref()
1253 .map(|settings| settings.enabled_in_text_threads)
1254 .unwrap_or(true);
1255
1256 let mut file_types: FxHashMap<Arc<str>, GlobSet> = FxHashMap::default();
1257
1258 for (language, patterns) in &default_value.file_types {
1259 let mut builder = GlobSetBuilder::new();
1260
1261 for pattern in patterns {
1262 builder.add(Glob::new(pattern)?);
1263 }
1264
1265 file_types.insert(language.clone(), builder.build()?);
1266 }
1267
1268 for user_settings in sources.customizations() {
1269 if let Some(provider) = user_settings
1270 .features
1271 .as_ref()
1272 .and_then(|f| f.edit_prediction_provider)
1273 {
1274 edit_prediction_provider = Some(provider);
1275 }
1276
1277 if let Some(edit_predictions) = user_settings.edit_predictions.as_ref() {
1278 edit_predictions_mode = edit_predictions.mode;
1279 enabled_in_text_threads = edit_predictions.enabled_in_text_threads;
1280
1281 if let Some(disabled_globs) = edit_predictions.disabled_globs.as_ref() {
1282 completion_globs.extend(disabled_globs.iter());
1283 }
1284 }
1285
1286 if let Some(proxy) = user_settings
1287 .edit_predictions
1288 .as_ref()
1289 .and_then(|settings| settings.copilot.proxy.clone())
1290 {
1291 copilot_settings.proxy = Some(proxy);
1292 }
1293
1294 if let Some(proxy_no_verify) = user_settings
1295 .edit_predictions
1296 .as_ref()
1297 .and_then(|settings| settings.copilot.proxy_no_verify)
1298 {
1299 copilot_settings.proxy_no_verify = Some(proxy_no_verify);
1300 }
1301
1302 if let Some(enterprise_uri) = user_settings
1303 .edit_predictions
1304 .as_ref()
1305 .and_then(|settings| settings.copilot.enterprise_uri.clone())
1306 {
1307 copilot_settings.enterprise_uri = Some(enterprise_uri);
1308 }
1309
1310 // A user's global settings override the default global settings and
1311 // all default language-specific settings.
1312 merge_settings(&mut defaults, &user_settings.defaults);
1313 for language_settings in languages.values_mut() {
1314 merge_settings(language_settings, &user_settings.defaults);
1315 }
1316
1317 // A user's language-specific settings override default language-specific settings.
1318 for (language_name, user_language_settings) in &user_settings.languages.0 {
1319 merge_settings(
1320 languages
1321 .entry(language_name.clone())
1322 .or_insert_with(|| defaults.clone()),
1323 user_language_settings,
1324 );
1325 }
1326
1327 for (language, patterns) in &user_settings.file_types {
1328 let mut builder = GlobSetBuilder::new();
1329
1330 let default_value = default_value.file_types.get(&language.clone());
1331
1332 // Merge the default value with the user's value.
1333 if let Some(patterns) = default_value {
1334 for pattern in patterns {
1335 builder.add(Glob::new(pattern)?);
1336 }
1337 }
1338
1339 for pattern in patterns {
1340 builder.add(Glob::new(pattern)?);
1341 }
1342
1343 file_types.insert(language.clone(), builder.build()?);
1344 }
1345 }
1346
1347 Ok(Self {
1348 edit_predictions: EditPredictionSettings {
1349 provider: if let Some(provider) = edit_prediction_provider {
1350 provider
1351 } else {
1352 EditPredictionProvider::None
1353 },
1354 disabled_globs: completion_globs
1355 .iter()
1356 .filter_map(|g| {
1357 let expanded_g = shellexpand::tilde(g).into_owned();
1358 Some(DisabledGlob {
1359 matcher: globset::Glob::new(&expanded_g).ok()?.compile_matcher(),
1360 is_absolute: Path::new(&expanded_g).is_absolute(),
1361 })
1362 })
1363 .collect(),
1364 mode: edit_predictions_mode,
1365 copilot: copilot_settings,
1366 enabled_in_text_threads,
1367 },
1368 defaults,
1369 languages,
1370 file_types,
1371 })
1372 }
1373
1374 fn import_from_vscode(vscode: &settings::VsCodeSettings, current: &mut Self::FileContent) {
1375 let d = &mut current.defaults;
1376 if let Some(size) = vscode
1377 .read_value("editor.tabSize")
1378 .and_then(|v| v.as_u64())
1379 .and_then(|n| NonZeroU32::new(n as u32))
1380 {
1381 d.tab_size = Some(size);
1382 }
1383 if let Some(v) = vscode.read_bool("editor.insertSpaces") {
1384 d.hard_tabs = Some(!v);
1385 }
1386
1387 vscode.enum_setting("editor.wordWrap", &mut d.soft_wrap, |s| match s {
1388 "on" => Some(SoftWrap::EditorWidth),
1389 "wordWrapColumn" => Some(SoftWrap::PreferLine),
1390 "bounded" => Some(SoftWrap::Bounded),
1391 "off" => Some(SoftWrap::None),
1392 _ => None,
1393 });
1394 vscode.u32_setting("editor.wordWrapColumn", &mut d.preferred_line_length);
1395
1396 if let Some(arr) = vscode
1397 .read_value("editor.rulers")
1398 .and_then(|v| v.as_array())
1399 .map(|v| v.iter().map(|n| n.as_u64().map(|n| n as usize)).collect())
1400 {
1401 d.wrap_guides = arr;
1402 }
1403 if let Some(b) = vscode.read_bool("editor.guides.indentation") {
1404 if let Some(guide_settings) = d.indent_guides.as_mut() {
1405 guide_settings.enabled = b;
1406 } else {
1407 d.indent_guides = Some(IndentGuideSettings {
1408 enabled: b,
1409 ..Default::default()
1410 });
1411 }
1412 }
1413
1414 if let Some(b) = vscode.read_bool("editor.guides.formatOnSave") {
1415 d.format_on_save = Some(if b {
1416 FormatOnSave::On
1417 } else {
1418 FormatOnSave::Off
1419 });
1420 }
1421 vscode.bool_setting(
1422 "editor.trimAutoWhitespace",
1423 &mut d.remove_trailing_whitespace_on_save,
1424 );
1425 vscode.bool_setting(
1426 "files.insertFinalNewline",
1427 &mut d.ensure_final_newline_on_save,
1428 );
1429 vscode.bool_setting("editor.inlineSuggest.enabled", &mut d.show_edit_predictions);
1430 vscode.enum_setting("editor.renderWhitespace", &mut d.show_whitespaces, |s| {
1431 Some(match s {
1432 "boundary" => ShowWhitespaceSetting::Boundary,
1433 "trailing" => ShowWhitespaceSetting::Trailing,
1434 "selection" => ShowWhitespaceSetting::Selection,
1435 "all" => ShowWhitespaceSetting::All,
1436 _ => ShowWhitespaceSetting::None,
1437 })
1438 });
1439 vscode.enum_setting(
1440 "editor.autoSurround",
1441 &mut d.use_auto_surround,
1442 |s| match s {
1443 "languageDefined" | "quotes" | "brackets" => Some(true),
1444 "never" => Some(false),
1445 _ => None,
1446 },
1447 );
1448 vscode.bool_setting("editor.formatOnType", &mut d.use_on_type_format);
1449 vscode.bool_setting("editor.linkedEditing", &mut d.linked_edits);
1450 vscode.bool_setting("editor.formatOnPaste", &mut d.auto_indent_on_paste);
1451 vscode.bool_setting(
1452 "editor.suggestOnTriggerCharacters",
1453 &mut d.show_completions_on_input,
1454 );
1455 if let Some(b) = vscode.read_bool("editor.suggest.showWords") {
1456 let mode = if b {
1457 WordsCompletionMode::Enabled
1458 } else {
1459 WordsCompletionMode::Disabled
1460 };
1461 if let Some(completion_settings) = d.completions.as_mut() {
1462 completion_settings.words = mode;
1463 } else {
1464 d.completions = Some(CompletionSettings {
1465 words: mode,
1466 lsp: true,
1467 lsp_fetch_timeout_ms: 0,
1468 lsp_insert_mode: LspInsertMode::ReplaceSuffix,
1469 });
1470 }
1471 }
1472 // TODO: pull ^ out into helper and reuse for per-language settings
1473
1474 // vscodes file association map is inverted from ours, so we flip the mapping before merging
1475 let mut associations: HashMap<Arc<str>, Vec<String>> = HashMap::default();
1476 if let Some(map) = vscode
1477 .read_value("files.associations")
1478 .and_then(|v| v.as_object())
1479 {
1480 for (k, v) in map {
1481 let Some(v) = v.as_str() else { continue };
1482 associations.entry(v.into()).or_default().push(k.clone());
1483 }
1484 }
1485
1486 // TODO: do we want to merge imported globs per filetype? for now we'll just replace
1487 current.file_types.extend(associations);
1488
1489 // cursor global ignore list applies to cursor-tab, so transfer it to edit_predictions.disabled_globs
1490 if let Some(disabled_globs) = vscode
1491 .read_value("cursor.general.globalCursorIgnoreList")
1492 .and_then(|v| v.as_array())
1493 {
1494 current
1495 .edit_predictions
1496 .get_or_insert_default()
1497 .disabled_globs
1498 .get_or_insert_default()
1499 .extend(
1500 disabled_globs
1501 .iter()
1502 .filter_map(|glob| glob.as_str())
1503 .map(|s| s.to_string()),
1504 );
1505 }
1506 }
1507}
1508
1509fn merge_settings(settings: &mut LanguageSettings, src: &LanguageSettingsContent) {
1510 fn merge<T>(target: &mut T, value: Option<T>) {
1511 if let Some(value) = value {
1512 *target = value;
1513 }
1514 }
1515
1516 merge(&mut settings.tab_size, src.tab_size);
1517 settings.tab_size = settings
1518 .tab_size
1519 .clamp(NonZeroU32::new(1).unwrap(), NonZeroU32::new(16).unwrap());
1520
1521 merge(&mut settings.hard_tabs, src.hard_tabs);
1522 merge(&mut settings.soft_wrap, src.soft_wrap);
1523 merge(&mut settings.use_autoclose, src.use_autoclose);
1524 merge(&mut settings.use_auto_surround, src.use_auto_surround);
1525 merge(&mut settings.use_on_type_format, src.use_on_type_format);
1526 merge(&mut settings.auto_indent, src.auto_indent);
1527 merge(&mut settings.auto_indent_on_paste, src.auto_indent_on_paste);
1528 merge(
1529 &mut settings.always_treat_brackets_as_autoclosed,
1530 src.always_treat_brackets_as_autoclosed,
1531 );
1532 merge(&mut settings.show_wrap_guides, src.show_wrap_guides);
1533 merge(&mut settings.wrap_guides, src.wrap_guides.clone());
1534 merge(&mut settings.indent_guides, src.indent_guides);
1535 merge(
1536 &mut settings.code_actions_on_format,
1537 src.code_actions_on_format.clone(),
1538 );
1539 merge(&mut settings.linked_edits, src.linked_edits);
1540 merge(&mut settings.tasks, src.tasks.clone());
1541
1542 merge(
1543 &mut settings.preferred_line_length,
1544 src.preferred_line_length,
1545 );
1546 merge(&mut settings.formatter, src.formatter.clone());
1547 merge(&mut settings.prettier, src.prettier.clone());
1548 merge(
1549 &mut settings.jsx_tag_auto_close,
1550 src.jsx_tag_auto_close.clone(),
1551 );
1552 merge(&mut settings.format_on_save, src.format_on_save.clone());
1553 merge(
1554 &mut settings.remove_trailing_whitespace_on_save,
1555 src.remove_trailing_whitespace_on_save,
1556 );
1557 merge(
1558 &mut settings.ensure_final_newline_on_save,
1559 src.ensure_final_newline_on_save,
1560 );
1561 merge(
1562 &mut settings.enable_language_server,
1563 src.enable_language_server,
1564 );
1565 merge(&mut settings.language_servers, src.language_servers.clone());
1566 merge(&mut settings.allow_rewrap, src.allow_rewrap);
1567 merge(
1568 &mut settings.show_edit_predictions,
1569 src.show_edit_predictions,
1570 );
1571 merge(
1572 &mut settings.edit_predictions_disabled_in,
1573 src.edit_predictions_disabled_in.clone(),
1574 );
1575 merge(&mut settings.show_whitespaces, src.show_whitespaces);
1576 merge(
1577 &mut settings.extend_comment_on_newline,
1578 src.extend_comment_on_newline,
1579 );
1580 merge(&mut settings.inlay_hints, src.inlay_hints);
1581 merge(
1582 &mut settings.show_completions_on_input,
1583 src.show_completions_on_input,
1584 );
1585 merge(
1586 &mut settings.show_completion_documentation,
1587 src.show_completion_documentation,
1588 );
1589 merge(&mut settings.completions, src.completions);
1590}
1591
1592/// Allows to enable/disable formatting with Prettier
1593/// and configure default Prettier, used when no project-level Prettier installation is found.
1594/// Prettier formatting is disabled by default.
1595#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
1596pub struct PrettierSettings {
1597 /// Enables or disables formatting with Prettier for a given language.
1598 #[serde(default)]
1599 pub allowed: bool,
1600
1601 /// Forces Prettier integration to use a specific parser name when formatting files with the language.
1602 #[serde(default)]
1603 pub parser: Option<String>,
1604
1605 /// Forces Prettier integration to use specific plugins when formatting files with the language.
1606 /// The default Prettier will be installed with these plugins.
1607 #[serde(default)]
1608 pub plugins: HashSet<String>,
1609
1610 /// Default Prettier options, in the format as in package.json section for Prettier.
1611 /// If project installs Prettier via its package.json, these options will be ignored.
1612 #[serde(flatten)]
1613 pub options: HashMap<String, serde_json::Value>,
1614}
1615
1616#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
1617pub struct JsxTagAutoCloseSettings {
1618 /// Enables or disables auto-closing of JSX tags.
1619 #[serde(default)]
1620 pub enabled: bool,
1621}
1622
1623#[cfg(test)]
1624mod tests {
1625 use gpui::TestAppContext;
1626
1627 use super::*;
1628
1629 #[test]
1630 fn test_formatter_deserialization() {
1631 let raw_auto = "{\"formatter\": \"auto\"}";
1632 let settings: LanguageSettingsContent = serde_json::from_str(raw_auto).unwrap();
1633 assert_eq!(settings.formatter, Some(SelectedFormatter::Auto));
1634 let raw = "{\"formatter\": \"language_server\"}";
1635 let settings: LanguageSettingsContent = serde_json::from_str(raw).unwrap();
1636 assert_eq!(
1637 settings.formatter,
1638 Some(SelectedFormatter::List(FormatterList::Single(
1639 Formatter::LanguageServer { name: None }
1640 )))
1641 );
1642 let raw = "{\"formatter\": [{\"language_server\": {\"name\": null}}]}";
1643 let settings: LanguageSettingsContent = serde_json::from_str(raw).unwrap();
1644 assert_eq!(
1645 settings.formatter,
1646 Some(SelectedFormatter::List(FormatterList::Vec(vec![
1647 Formatter::LanguageServer { name: None }
1648 ])))
1649 );
1650 let raw = "{\"formatter\": [{\"language_server\": {\"name\": null}}, \"prettier\"]}";
1651 let settings: LanguageSettingsContent = serde_json::from_str(raw).unwrap();
1652 assert_eq!(
1653 settings.formatter,
1654 Some(SelectedFormatter::List(FormatterList::Vec(vec![
1655 Formatter::LanguageServer { name: None },
1656 Formatter::Prettier
1657 ])))
1658 );
1659 }
1660
1661 #[test]
1662 fn test_formatter_deserialization_invalid() {
1663 let raw_auto = "{\"formatter\": {}}";
1664 let result: Result<LanguageSettingsContent, _> = serde_json::from_str(raw_auto);
1665 assert!(result.is_err());
1666 }
1667
1668 #[gpui::test]
1669 fn test_edit_predictions_enabled_for_file(cx: &mut TestAppContext) {
1670 use crate::TestFile;
1671 use std::path::PathBuf;
1672
1673 let cx = cx.app.borrow_mut();
1674
1675 let build_settings = |globs: &[&str]| -> EditPredictionSettings {
1676 EditPredictionSettings {
1677 disabled_globs: globs
1678 .iter()
1679 .map(|glob_str| {
1680 #[cfg(windows)]
1681 let glob_str = {
1682 let mut g = String::new();
1683
1684 if glob_str.starts_with('/') {
1685 g.push_str("C:");
1686 }
1687
1688 g.push_str(&glob_str.replace('/', "\\"));
1689 g
1690 };
1691 #[cfg(windows)]
1692 let glob_str = glob_str.as_str();
1693 let expanded_glob_str = shellexpand::tilde(glob_str).into_owned();
1694 DisabledGlob {
1695 matcher: globset::Glob::new(&expanded_glob_str)
1696 .unwrap()
1697 .compile_matcher(),
1698 is_absolute: Path::new(&expanded_glob_str).is_absolute(),
1699 }
1700 })
1701 .collect(),
1702 ..Default::default()
1703 }
1704 };
1705
1706 const WORKTREE_NAME: &str = "project";
1707 let make_test_file = |segments: &[&str]| -> Arc<dyn File> {
1708 let mut path_buf = PathBuf::new();
1709 path_buf.extend(segments);
1710
1711 Arc::new(TestFile {
1712 path: path_buf.as_path().into(),
1713 root_name: WORKTREE_NAME.to_string(),
1714 local_root: Some(PathBuf::from(if cfg!(windows) {
1715 "C:\\absolute\\"
1716 } else {
1717 "/absolute/"
1718 })),
1719 })
1720 };
1721
1722 let test_file = make_test_file(&["src", "test", "file.rs"]);
1723
1724 // Test relative globs
1725 let settings = build_settings(&["*.rs"]);
1726 assert!(!settings.enabled_for_file(&test_file, &cx));
1727 let settings = build_settings(&["*.txt"]);
1728 assert!(settings.enabled_for_file(&test_file, &cx));
1729
1730 // Test absolute globs
1731 let settings = build_settings(&["/absolute/**/*.rs"]);
1732 assert!(!settings.enabled_for_file(&test_file, &cx));
1733 let settings = build_settings(&["/other/**/*.rs"]);
1734 assert!(settings.enabled_for_file(&test_file, &cx));
1735
1736 // Test exact path match relative
1737 let settings = build_settings(&["src/test/file.rs"]);
1738 assert!(!settings.enabled_for_file(&test_file, &cx));
1739 let settings = build_settings(&["src/test/otherfile.rs"]);
1740 assert!(settings.enabled_for_file(&test_file, &cx));
1741
1742 // Test exact path match absolute
1743 let settings = build_settings(&[&format!("/absolute/{}/src/test/file.rs", WORKTREE_NAME)]);
1744 assert!(!settings.enabled_for_file(&test_file, &cx));
1745 let settings = build_settings(&["/other/test/otherfile.rs"]);
1746 assert!(settings.enabled_for_file(&test_file, &cx));
1747
1748 // Test * glob
1749 let settings = build_settings(&["*"]);
1750 assert!(!settings.enabled_for_file(&test_file, &cx));
1751 let settings = build_settings(&["*.txt"]);
1752 assert!(settings.enabled_for_file(&test_file, &cx));
1753
1754 // Test **/* glob
1755 let settings = build_settings(&["**/*"]);
1756 assert!(!settings.enabled_for_file(&test_file, &cx));
1757 let settings = build_settings(&["other/**/*"]);
1758 assert!(settings.enabled_for_file(&test_file, &cx));
1759
1760 // Test directory/** glob
1761 let settings = build_settings(&["src/**"]);
1762 assert!(!settings.enabled_for_file(&test_file, &cx));
1763
1764 let test_file_root: Arc<dyn File> = Arc::new(TestFile {
1765 path: PathBuf::from("file.rs").as_path().into(),
1766 root_name: WORKTREE_NAME.to_string(),
1767 local_root: Some(PathBuf::from("/absolute/")),
1768 });
1769 assert!(settings.enabled_for_file(&test_file_root, &cx));
1770
1771 let settings = build_settings(&["other/**"]);
1772 assert!(settings.enabled_for_file(&test_file, &cx));
1773
1774 // Test **/directory/* glob
1775 let settings = build_settings(&["**/test/*"]);
1776 assert!(!settings.enabled_for_file(&test_file, &cx));
1777 let settings = build_settings(&["**/other/*"]);
1778 assert!(settings.enabled_for_file(&test_file, &cx));
1779
1780 // Test multiple globs
1781 let settings = build_settings(&["*.rs", "*.txt", "src/**"]);
1782 assert!(!settings.enabled_for_file(&test_file, &cx));
1783 let settings = build_settings(&["*.txt", "*.md", "other/**"]);
1784 assert!(settings.enabled_for_file(&test_file, &cx));
1785
1786 // Test dot files
1787 let dot_file = make_test_file(&[".config", "settings.json"]);
1788 let settings = build_settings(&[".*/**"]);
1789 assert!(!settings.enabled_for_file(&dot_file, &cx));
1790
1791 let dot_env_file = make_test_file(&[".env"]);
1792 let settings = build_settings(&[".env"]);
1793 assert!(!settings.enabled_for_file(&dot_env_file, &cx));
1794
1795 // Test tilde expansion
1796 let home = shellexpand::tilde("~").into_owned();
1797 let home_file = make_test_file(&[&home, "test.rs"]);
1798 let settings = build_settings(&["~/test.rs"]);
1799 assert!(!settings.enabled_for_file(&home_file, &cx));
1800 }
1801
1802 #[test]
1803 fn test_resolve_language_servers() {
1804 fn language_server_names(names: &[&str]) -> Vec<LanguageServerName> {
1805 names
1806 .iter()
1807 .copied()
1808 .map(|name| LanguageServerName(name.to_string().into()))
1809 .collect::<Vec<_>>()
1810 }
1811
1812 let available_language_servers = language_server_names(&[
1813 "typescript-language-server",
1814 "biome",
1815 "deno",
1816 "eslint",
1817 "tailwind",
1818 ]);
1819
1820 // A value of just `["..."]` is the same as taking all of the available language servers.
1821 assert_eq!(
1822 LanguageSettings::resolve_language_servers(
1823 &[LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()],
1824 &available_language_servers,
1825 ),
1826 available_language_servers
1827 );
1828
1829 // Referencing one of the available language servers will change its order.
1830 assert_eq!(
1831 LanguageSettings::resolve_language_servers(
1832 &[
1833 "biome".into(),
1834 LanguageSettings::REST_OF_LANGUAGE_SERVERS.into(),
1835 "deno".into()
1836 ],
1837 &available_language_servers
1838 ),
1839 language_server_names(&[
1840 "biome",
1841 "typescript-language-server",
1842 "eslint",
1843 "tailwind",
1844 "deno",
1845 ])
1846 );
1847
1848 // Negating an available language server removes it from the list.
1849 assert_eq!(
1850 LanguageSettings::resolve_language_servers(
1851 &[
1852 "deno".into(),
1853 "!typescript-language-server".into(),
1854 "!biome".into(),
1855 LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()
1856 ],
1857 &available_language_servers
1858 ),
1859 language_server_names(&["deno", "eslint", "tailwind"])
1860 );
1861
1862 // Adding a language server not in the list of available language servers adds it to the list.
1863 assert_eq!(
1864 LanguageSettings::resolve_language_servers(
1865 &[
1866 "my-cool-language-server".into(),
1867 LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()
1868 ],
1869 &available_language_servers
1870 ),
1871 language_server_names(&[
1872 "my-cool-language-server",
1873 "typescript-language-server",
1874 "biome",
1875 "deno",
1876 "eslint",
1877 "tailwind",
1878 ])
1879 );
1880 }
1881}