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