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