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