1{
2 // The name of the Zed theme to use for the UI.
3 //
4 // `mode` is one of:
5 // - "system": Use the theme that corresponds to the system's appearance
6 // - "light": Use the theme indicated by the "light" field
7 // - "dark": Use the theme indicated by the "dark" field
8 "theme": {
9 "mode": "system",
10 "light": "One Light",
11 "dark": "One Dark"
12 },
13 // The name of a base set of key bindings to use.
14 // This setting can take four values, each named after another
15 // text editor:
16 //
17 // 1. "VSCode"
18 // 2. "Atom"
19 // 3. "JetBrains"
20 // 4. "None"
21 // 5. "SublimeText"
22 // 6. "TextMate"
23 "base_keymap": "VSCode",
24 // Features that can be globally enabled or disabled
25 "features": {
26 // Which inline completion provider to use.
27 "inline_completion_provider": "copilot"
28 },
29 // The name of a font to use for rendering text in the editor
30 "buffer_font_family": "Zed Plex Mono",
31 // Set the buffer text's font fallbacks, this will be merged with
32 // the platform's default fallbacks.
33 "buffer_font_fallbacks": null,
34 // The OpenType features to enable for text in the editor.
35 "buffer_font_features": {
36 // Disable ligatures:
37 // "calt": false
38 },
39 // The default font size for text in the editor
40 "buffer_font_size": 15,
41 // The weight of the editor font in standard CSS units from 100 to 900.
42 "buffer_font_weight": 400,
43 // Set the buffer's line height.
44 // May take 3 values:
45 // 1. Use a line height that's comfortable for reading (1.618)
46 // "buffer_line_height": "comfortable"
47 // 2. Use a standard line height, (1.3)
48 // "buffer_line_height": "standard",
49 // 3. Use a custom line height
50 // "buffer_line_height": {
51 // "custom": 2
52 // },
53 "buffer_line_height": "comfortable",
54 // The name of a font to use for rendering text in the UI
55 // You can set this to ".SystemUIFont" to use the system font
56 "ui_font_family": "Zed Plex Sans",
57 // Set the UI's font fallbacks, this will be merged with the platform's
58 // default font fallbacks.
59 "ui_font_fallbacks": null,
60 // The OpenType features to enable for text in the UI
61 "ui_font_features": {
62 // Disable ligatures:
63 "calt": false
64 },
65 // The weight of the UI font in standard CSS units from 100 to 900.
66 "ui_font_weight": 400,
67 // The default font size for text in the UI
68 "ui_font_size": 16,
69 // How much to fade out unused code.
70 "unnecessary_code_fade": 0.3,
71 // Active pane styling settings.
72 "active_pane_modifiers": {
73 // The factor to grow the active pane by. Defaults to 1.0
74 // which gives the same size as all other panes.
75 "magnification": 1.0,
76 // Inset border size of the active pane, in pixels.
77 "border_size": 0.0,
78 // Opacity of the inactive panes. 0 means transparent, 1 means opaque.
79 // Values are clamped to the [0.0, 1.0] range.
80 "inactive_opacity": 1.0
81 },
82 // The direction that you want to split panes horizontally. Defaults to "up"
83 "pane_split_direction_horizontal": "up",
84 // The direction that you want to split panes horizontally. Defaults to "left"
85 "pane_split_direction_vertical": "left",
86 // Centered layout related settings.
87 "centered_layout": {
88 // The relative width of the left padding of the central pane from the
89 // workspace when the centered layout is used.
90 "left_padding": 0.2,
91 // The relative width of the right padding of the central pane from the
92 // workspace when the centered layout is used.
93 "right_padding": 0.2
94 },
95 // The key to use for adding multiple cursors
96 // Currently "alt" or "cmd_or_ctrl" (also aliased as
97 // "cmd" and "ctrl") are supported.
98 "multi_cursor_modifier": "alt",
99 // Whether to enable vim modes and key bindings.
100 "vim_mode": false,
101 // Whether to show the informational hover box when moving the mouse
102 // over symbols in the editor.
103 "hover_popover_enabled": true,
104 // Whether to confirm before quitting Zed.
105 "confirm_quit": false,
106 // Whether to restore last closed project when fresh Zed instance is opened.
107 "restore_on_startup": "last_session",
108 // Size of the drop target in the editor.
109 "drop_target_size": 0.2,
110 // Whether the window should be closed when using 'close active item' on a window with no tabs.
111 // May take 3 values:
112 // 1. Use the current platform's convention
113 // "when_closing_with_no_tabs": "platform_default"
114 // 2. Always close the window:
115 // "when_closing_with_no_tabs": "close_window",
116 // 3. Never close the window
117 // "when_closing_with_no_tabs": "keep_window_open",
118 "when_closing_with_no_tabs": "platform_default",
119 // Whether to use the system provided dialogs for Open and Save As.
120 // When set to false, Zed will use the built-in keyboard-first pickers.
121 "use_system_path_prompts": true,
122 // Whether the cursor blinks in the editor.
123 "cursor_blink": true,
124 // Cursor shape for the default editor.
125 // 1. A vertical bar
126 // "bar"
127 // 2. A block that surrounds the following character
128 // "block"
129 // 3. An underline / underscore that runs along the following character
130 // "underline"
131 // 4. A box drawn around the following character
132 // "hollow"
133 //
134 // Default: not set, defaults to "bar"
135 "cursor_shape": null,
136 // How to highlight the current line in the editor.
137 //
138 // 1. Don't highlight the current line:
139 // "none"
140 // 2. Highlight the gutter area:
141 // "gutter"
142 // 3. Highlight the editor area:
143 // "line"
144 // 4. Highlight the full line (default):
145 // "all"
146 "current_line_highlight": "all",
147 // Whether to pop the completions menu while typing in an editor without
148 // explicitly requesting it.
149 "show_completions_on_input": true,
150 // Whether to display inline and alongside documentation for items in the
151 // completions menu
152 "show_completion_documentation": true,
153 // The debounce delay before re-querying the language server for completion
154 // documentation when not included in original completion list.
155 "completion_documentation_secondary_query_debounce": 300,
156 // Show method signatures in the editor, when inside parentheses.
157 "auto_signature_help": false,
158 /// Whether to show the signature help after completion or a bracket pair inserted.
159 /// If `auto_signature_help` is enabled, this setting will be treated as enabled also.
160 "show_signature_help_after_edits": false,
161 // Whether to show wrap guides (vertical rulers) in the editor.
162 // Setting this to true will show a guide at the 'preferred_line_length' value
163 // if 'soft_wrap' is set to 'preferred_line_length', and will show any
164 // additional guides as specified by the 'wrap_guides' setting.
165 "show_wrap_guides": true,
166 // Character counts at which to show wrap guides in the editor.
167 "wrap_guides": [],
168 // Hide the values of in variables from visual display in private files
169 "redact_private_values": false,
170 // The default number of lines to expand excerpts in the multibuffer by.
171 "expand_excerpt_lines": 3,
172 // Globs to match against file paths to determine if a file is private.
173 "private_files": ["**/.env*", "**/*.pem", "**/*.key", "**/*.cert", "**/*.crt", "**/secrets.yml"],
174 // Whether to use additional LSP queries to format (and amend) the code after
175 // every "trigger" symbol input, defined by LSP server capabilities.
176 "use_on_type_format": true,
177 // Whether to automatically add matching closing characters when typing
178 // opening parenthesis, bracket, brace, single or double quote characters.
179 // For example, when you type (, Zed will add a closing ) at the correct position.
180 "use_autoclose": true,
181 // Whether to automatically surround selected text when typing opening parenthesis,
182 // bracket, brace, single or double quote characters.
183 // For example, when you select text and type (, Zed will surround the text with ().
184 "use_auto_surround": true,
185 // Whether indentation of pasted content should be adjusted based on the context.
186 "auto_indent_on_paste": true,
187 // Controls how the editor handles the autoclosed characters.
188 // When set to `false`(default), skipping over and auto-removing of the closing characters
189 // happen only for auto-inserted characters.
190 // Otherwise(when `true`), the closing characters are always skipped over and auto-removed
191 // no matter how they were inserted.
192 "always_treat_brackets_as_autoclosed": false,
193 // Controls whether inline completions are shown immediately (true)
194 // or manually by triggering `editor::ShowInlineCompletion` (false).
195 "show_inline_completions": true,
196 // Controls whether inline completions are shown in a given language scope.
197 // Example: ["string", "comment"]
198 "inline_completions_disabled_in": [],
199 // Whether to show tabs and spaces in the editor.
200 // This setting can take three values:
201 //
202 // 1. Draw tabs and spaces only for the selected text (default):
203 // "selection"
204 // 2. Do not draw any tabs or spaces:
205 // "none"
206 // 3. Draw all invisible symbols:
207 // "all"
208 // 4. Draw whitespaces at boundaries only:
209 // "boundary"
210 // For a whitespace to be on a boundary, any of the following conditions need to be met:
211 // - It is a tab
212 // - It is adjacent to an edge (start or end)
213 // - It is adjacent to a whitespace (left or right)
214 "show_whitespaces": "selection",
215 // Settings related to calls in Zed
216 "calls": {
217 // Join calls with the microphone live by default
218 "mute_on_join": false,
219 // Share your project when you are the first to join a channel
220 "share_on_join": false
221 },
222 // Toolbar related settings
223 "toolbar": {
224 // Whether to show breadcrumbs.
225 "breadcrumbs": true,
226 // Whether to show quick action buttons.
227 "quick_actions": true,
228 // Whether to show the Selections menu in the editor toolbar
229 "selections_menu": true
230 },
231 // Scrollbar related settings
232 "scrollbar": {
233 // When to show the scrollbar in the editor.
234 // This setting can take four values:
235 //
236 // 1. Show the scrollbar if there's important information or
237 // follow the system's configured behavior (default):
238 // "auto"
239 // 2. Match the system's configured behavior:
240 // "system"
241 // 3. Always show the scrollbar:
242 // "always"
243 // 4. Never show the scrollbar:
244 // "never"
245 "show": "auto",
246 // Whether to show cursor positions in the scrollbar.
247 "cursors": true,
248 // Whether to show git diff indicators in the scrollbar.
249 "git_diff": true,
250 // Whether to show buffer search results in the scrollbar.
251 "search_results": true,
252 // Whether to show selected symbol occurrences in the scrollbar.
253 "selected_symbol": true,
254 // Whether to show diagnostic indicators in the scrollbar.
255 "diagnostics": true
256 },
257 // Enable middle-click paste on Linux.
258 "middle_click_paste": true,
259 // What to do when multibuffer is double clicked in some of its excerpts
260 // (parts of singleton buffers).
261 // May take 2 values:
262 // 1. Behave as a regular buffer and select the whole word (default).
263 // "double_click_in_multibuffer": "select"
264 // 2. Open the excerpt clicked as a new buffer in the new tab.
265 // "double_click_in_multibuffer": "open",
266 // For the case of "open", regular selection behavior can be achieved by holding `alt` when double clicking.
267 "double_click_in_multibuffer": "select",
268 "gutter": {
269 // Whether to show line numbers in the gutter.
270 "line_numbers": true,
271 // Whether to show code action buttons in the gutter.
272 "code_actions": true,
273 // Whether to show runnables buttons in the gutter.
274 "runnables": true,
275 // Whether to show fold buttons in the gutter.
276 "folds": true
277 },
278 "indent_guides": {
279 /// Whether to show indent guides in the editor.
280 "enabled": true,
281 /// The width of the indent guides in pixels, between 1 and 10.
282 "line_width": 1,
283 /// The width of the active indent guide in pixels, between 1 and 10.
284 "active_line_width": 1,
285 /// Determines how indent guides are colored.
286 /// This setting can take the following three values:
287 ///
288 /// 1. "disabled"
289 /// 2. "fixed"
290 /// 3. "indent_aware"
291 "coloring": "fixed",
292 /// Determines how indent guide backgrounds are colored.
293 /// This setting can take the following two values:
294 ///
295 /// 1. "disabled"
296 /// 2. "indent_aware"
297 "background_coloring": "disabled"
298 },
299 // Whether the editor will scroll beyond the last line.
300 "scroll_beyond_last_line": "one_page",
301 // The number of lines to keep above/below the cursor when scrolling.
302 "vertical_scroll_margin": 3,
303 // Scroll sensitivity multiplier. This multiplier is applied
304 // to both the horizontal and vertical delta values while scrolling.
305 "scroll_sensitivity": 1.0,
306 "relative_line_numbers": false,
307 // If 'search_wrap' is disabled, search result do not wrap around the end of the file.
308 "search_wrap": true,
309 // Search options to enable by default when opening new project and buffer searches.
310 "search": {
311 "whole_word": false,
312 "case_sensitive": false,
313 "include_ignored": false,
314 "regex": false
315 },
316 // When to populate a new search's query based on the text under the cursor.
317 // This setting can take the following three values:
318 //
319 // 1. Always populate the search query with the word under the cursor (default).
320 // "always"
321 // 2. Only populate the search query when there is text selected
322 // "selection"
323 // 3. Never populate the search query
324 // "never"
325 "seed_search_query_from_cursor": "always",
326 "use_smartcase_search": false,
327 // Inlay hint related settings
328 "inlay_hints": {
329 // Global switch to toggle hints on and off, switched off by default.
330 "enabled": false,
331 // Toggle certain types of hints on and off, all switched on by default.
332 "show_type_hints": true,
333 "show_parameter_hints": true,
334 // Corresponds to null/None LSP hint type value.
335 "show_other_hints": true,
336 // Whether to show a background for inlay hints.
337 //
338 // If set to `true`, the background will use the `hint.background` color from the current theme.
339 "show_background": false,
340 // Time to wait after editing the buffer, before requesting the hints,
341 // set to 0 to disable debouncing.
342 "edit_debounce_ms": 700,
343 // Time to wait after scrolling the buffer, before requesting the hints,
344 // set to 0 to disable debouncing.
345 "scroll_debounce_ms": 50
346 },
347 "project_panel": {
348 // Whether to show the project panel button in the status bar
349 "button": true,
350 // Default width of the project panel.
351 "default_width": 240,
352 // Where to dock the project panel. Can be 'left' or 'right'.
353 "dock": "left",
354 // Whether to show file icons in the project panel.
355 "file_icons": true,
356 // Whether to show folder icons or chevrons for directories in the project panel.
357 "folder_icons": true,
358 // Whether to show the git status in the project panel.
359 "git_status": true,
360 // Amount of indentation for nested items.
361 "indent_size": 20,
362 // Whether to reveal it in the project panel automatically,
363 // when a corresponding project entry becomes active.
364 // Gitignored entries are never auto revealed.
365 "auto_reveal_entries": true,
366 // Whether to fold directories automatically and show compact folders
367 // (e.g. "a/b/c" ) when a directory has only one subdirectory inside.
368 "auto_fold_dirs": true,
369 /// Scrollbar-related settings
370 "scrollbar": {
371 /// When to show the scrollbar in the project panel.
372 /// This setting can take four values:
373 ///
374 /// 1. null (default): Inherit editor settings
375 /// 2. Show the scrollbar if there's important information or
376 /// follow the system's configured behavior (default):
377 /// "auto"
378 /// 3. Match the system's configured behavior:
379 /// "system"
380 /// 4. Always show the scrollbar:
381 /// "always"
382 /// 5. Never show the scrollbar:
383 /// "never"
384 "show": null
385 },
386 /// Which files containing diagnostic errors/warnings to mark in the project panel.
387 /// This setting can take the following three values:
388 ///
389 /// 1. Do not mark any files:
390 /// "off"
391 /// 2. Only mark files with errors:
392 /// "errors"
393 /// 3. Mark files with errors and warnings:
394 /// "all"
395 "show_diagnostics": "all",
396 // Settings related to indent guides in the project panel.
397 "indent_guides": {
398 // When to show indent guides in the project panel.
399 // This setting can take two values:
400 //
401 // 1. Always show indent guides:
402 // "always"
403 // 2. Never show indent guides:
404 // "never"
405 "show": "always"
406 }
407 },
408 "outline_panel": {
409 // Whether to show the outline panel button in the status bar
410 "button": true,
411 // Default width of the outline panel.
412 "default_width": 300,
413 // Where to dock the outline panel. Can be 'left' or 'right'.
414 "dock": "left",
415 // Whether to show file icons in the outline panel.
416 "file_icons": true,
417 // Whether to show folder icons or chevrons for directories in the outline panel.
418 "folder_icons": true,
419 // Whether to show the git status in the outline panel.
420 "git_status": true,
421 // Amount of indentation for nested items.
422 "indent_size": 20,
423 // Whether to reveal it in the outline panel automatically,
424 // when a corresponding outline entry becomes active.
425 // Gitignored entries are never auto revealed.
426 "auto_reveal_entries": true,
427 /// Whether to fold directories automatically
428 /// when a directory has only one directory inside.
429 "auto_fold_dirs": true,
430 // Settings related to indent guides in the outline panel.
431 "indent_guides": {
432 // When to show indent guides in the outline panel.
433 // This setting can take two values:
434 //
435 // 1. Always show indent guides:
436 // "always"
437 // 2. Never show indent guides:
438 // "never"
439 "show": "always"
440 },
441 /// Scrollbar-related settings
442 "scrollbar": {
443 /// When to show the scrollbar in the project panel.
444 /// This setting can take four values:
445 ///
446 /// 1. null (default): Inherit editor settings
447 /// 2. Show the scrollbar if there's important information or
448 /// follow the system's configured behavior (default):
449 /// "auto"
450 /// 3. Match the system's configured behavior:
451 /// "system"
452 /// 4. Always show the scrollbar:
453 /// "always"
454 /// 5. Never show the scrollbar:
455 /// "never"
456 "show": null
457 }
458 },
459 "collaboration_panel": {
460 // Whether to show the collaboration panel button in the status bar.
461 "button": true,
462 // Where to dock the collaboration panel. Can be 'left' or 'right'.
463 "dock": "left",
464 // Default width of the collaboration panel.
465 "default_width": 240
466 },
467 "chat_panel": {
468 // Whether to show the chat panel button in the status bar.
469 "button": true,
470 // Where to the chat panel. Can be 'left' or 'right'.
471 "dock": "right",
472 // Default width of the chat panel.
473 "default_width": 240
474 },
475 "message_editor": {
476 // Whether to automatically replace emoji shortcodes with emoji characters.
477 // For example: typing `:wave:` gets replaced with `👋`.
478 "auto_replace_emoji_shortcode": true
479 },
480 "notification_panel": {
481 // Whether to show the notification panel button in the status bar.
482 "button": true,
483 // Where to dock the notification panel. Can be 'left' or 'right'.
484 "dock": "right",
485 // Default width of the notification panel.
486 "default_width": 380
487 },
488 "assistant": {
489 // Version of this setting.
490 "version": "2",
491 // Whether the assistant is enabled.
492 "enabled": true,
493 // Whether to show the assistant panel button in the status bar.
494 "button": true,
495 // Where to dock the assistant panel. Can be 'left', 'right' or 'bottom'.
496 "dock": "right",
497 // Default width when the assistant is docked to the left or right.
498 "default_width": 640,
499 // Default height when the assistant is docked to the bottom.
500 "default_height": 320,
501 // The default model to use when creating new chats.
502 "default_model": {
503 // The provider to use.
504 "provider": "zed.dev",
505 // The model to use.
506 "model": "claude-3-5-sonnet"
507 }
508 },
509 // The settings for slash commands.
510 "slash_commands": {
511 // Settings for the `/docs` slash command.
512 "docs": {
513 // Whether `/docs` is enabled.
514 "enabled": false
515 },
516 // Settings for the `/project` slash command.
517 "project": {
518 // Whether `/project` is enabled.
519 "enabled": false
520 }
521 },
522 // Whether the screen sharing icon is shown in the os status bar.
523 "show_call_status_icon": true,
524 // Whether to use language servers to provide code intelligence.
525 "enable_language_server": true,
526 // Whether to perform linked edits of associated ranges, if the language server supports it.
527 // For example, when editing opening <html> tag, the contents of the closing </html> tag will be edited as well.
528 "linked_edits": true,
529 // The list of language servers to use (or disable) for all languages.
530 //
531 // This is typically customized on a per-language basis.
532 "language_servers": ["..."],
533 // When to automatically save edited buffers. This setting can
534 // take four values.
535 //
536 // 1. Never automatically save:
537 // "autosave": "off",
538 // 2. Save when changing focus away from the Zed window:
539 // "autosave": "on_window_change",
540 // 3. Save when changing focus away from a specific buffer:
541 // "autosave": "on_focus_change",
542 // 4. Save when idle for a certain amount of time:
543 // "autosave": { "after_delay": {"milliseconds": 500} },
544 "autosave": "off",
545 // Settings related to the editor's tab bar.
546 "tab_bar": {
547 // Whether or not to show the tab bar in the editor
548 "show": true,
549 // Whether or not to show the navigation history buttons.
550 "show_nav_history_buttons": true
551 },
552 // Settings related to the editor's tabs
553 "tabs": {
554 // Show git status colors in the editor tabs.
555 "git_status": false,
556 // Position of the close button on the editor tabs.
557 "close_position": "right",
558 // Whether to show the file icon for a tab.
559 "file_icons": false,
560 // What to do after closing the current tab.
561 //
562 // 1. Activate the tab that was open previously (default)
563 // "History"
564 // 2. Activate the neighbour tab (prefers the right one, if present)
565 // "Neighbour"
566 "activate_on_close": "history"
567 },
568 // Settings related to preview tabs.
569 "preview_tabs": {
570 // Whether preview tabs should be enabled.
571 // Preview tabs allow you to open files in preview mode, where they close automatically
572 // when you switch to another file unless you explicitly pin them.
573 // This is useful for quickly viewing files without cluttering your workspace.
574 "enabled": true,
575 // Whether to open tabs in preview mode when selected from the file finder.
576 "enable_preview_from_file_finder": false,
577 // Whether a preview tab gets replaced when code navigation is used to navigate away from the tab.
578 "enable_preview_from_code_navigation": false
579 },
580 // Settings related to the file finder.
581 "file_finder": {
582 // Whether to show file icons in the file finder.
583 "file_icons": true,
584 // Determines how much space the file finder can take up in relation to the available window width.
585 // There are 5 possible width values:
586 //
587 // 1. Small: This value is essentially a fixed width.
588 // "modal_width": "small"
589 // 2. Medium:
590 // "modal_width": "medium"
591 // 3. Large:
592 // "modal_width": "large"
593 // 4. Extra Large:
594 // "modal_width": "xlarge"
595 // 5. Fullscreen: This value removes any horizontal padding, as it consumes the whole viewport width.
596 // "modal_width": "full"
597 //
598 // Default: small
599 "modal_max_width": "small"
600 },
601 // Whether or not to remove any trailing whitespace from lines of a buffer
602 // before saving it.
603 "remove_trailing_whitespace_on_save": true,
604 // Whether to start a new line with a comment when a previous line is a comment as well.
605 "extend_comment_on_newline": true,
606 // Whether or not to ensure there's a single newline at the end of a buffer
607 // when saving it.
608 "ensure_final_newline_on_save": true,
609 // Whether or not to perform a buffer format before saving
610 //
611 // Keep in mind, if the autosave with delay is enabled, format_on_save will be ignored
612 "format_on_save": "on",
613 // How to perform a buffer format. This setting can take 4 values:
614 //
615 // 1. Format code using the current language server:
616 // "formatter": "language_server"
617 // 2. Format code using an external command:
618 // "formatter": {
619 // "external": {
620 // "command": "prettier",
621 // "arguments": ["--stdin-filepath", "{buffer_path}"]
622 // }
623 // }
624 // 3. Format code using Zed's Prettier integration:
625 // "formatter": "prettier"
626 // 4. Default. Format files using Zed's Prettier integration (if applicable),
627 // or falling back to formatting via language server:
628 // "formatter": "auto"
629 "formatter": "auto",
630 // How to soft-wrap long lines of text.
631 // Possible values:
632 //
633 // 1. Prefer a single line generally, unless an overly long line is encountered.
634 // "soft_wrap": "none",
635 // "soft_wrap": "prefer_line", // (deprecated, same as "none")
636 // 2. Soft wrap lines that overflow the editor.
637 // "soft_wrap": "editor_width",
638 // 3. Soft wrap lines at the preferred line length.
639 // "soft_wrap": "preferred_line_length",
640 // 4. Soft wrap lines at the preferred line length or the editor width (whichever is smaller).
641 // "soft_wrap": "bounded",
642 "soft_wrap": "none",
643 // The column at which to soft-wrap lines, for buffers where soft-wrap
644 // is enabled.
645 "preferred_line_length": 80,
646 // Whether to indent lines using tab characters, as opposed to multiple
647 // spaces.
648 "hard_tabs": false,
649 // How many columns a tab should occupy.
650 "tab_size": 4,
651 // Control what info is collected by Zed.
652 "telemetry": {
653 // Send debug info like crash reports.
654 "diagnostics": true,
655 // Send anonymized usage data like what languages you're using Zed with.
656 "metrics": true
657 },
658 // Automatically update Zed. This setting may be ignored on Linux if
659 // installed through a package manager.
660 "auto_update": true,
661 // Diagnostics configuration.
662 "diagnostics": {
663 // Whether to show warnings or not by default.
664 "include_warnings": true
665 },
666 // Add files or globs of files that will be excluded by Zed entirely:
667 // they will be skipped during FS scan(s), file tree and file search
668 // will lack the corresponding file entries. Overrides `file_scan_inclusions`.
669 "file_scan_exclusions": [
670 "**/.git",
671 "**/.svn",
672 "**/.hg",
673 "**/CVS",
674 "**/.DS_Store",
675 "**/Thumbs.db",
676 "**/.classpath",
677 "**/.settings"
678 ],
679 // Add files or globs of files that will be included by Zed, even when
680 // ignored by git. This is useful for files that are not tracked by git,
681 // but are still important to your project. Note that globs that are
682 // overly broad can slow down Zed's file scanning. Overridden by `file_scan_exclusions`.
683 "file_scan_inclusions": [".env*"],
684 // Git gutter behavior configuration.
685 "git": {
686 // Control whether the git gutter is shown. May take 2 values:
687 // 1. Show the gutter
688 // "git_gutter": "tracked_files"
689 // 2. Hide the gutter
690 // "git_gutter": "hide"
691 "git_gutter": "tracked_files",
692 // Control whether the git blame information is shown inline,
693 // in the currently focused line.
694 "inline_blame": {
695 "enabled": true
696 // Sets a delay after which the inline blame information is shown.
697 // Delay is restarted with every cursor movement.
698 // "delay_ms": 600
699 //
700 // Whether or not do display the git commit summary on the same line.
701 // "show_commit_summary": false
702 //
703 // The minimum column number to show the inline blame information at
704 // "min_column": 0
705 }
706 },
707 // Configuration for how direnv configuration should be loaded. May take 2 values:
708 // 1. Load direnv configuration using `direnv export json` directly.
709 // "load_direnv": "direct"
710 // 2. Load direnv configuration through the shell hook, works for POSIX shells and fish.
711 // "load_direnv": "shell_hook"
712 "load_direnv": "direct",
713 "inline_completions": {
714 // A list of globs representing files that inline completions should be disabled for.
715 "disabled_globs": [".env"]
716 },
717 // Settings specific to journaling
718 "journal": {
719 // The path of the directory where journal entries are stored
720 "path": "~",
721 // What format to display the hours in
722 // May take 2 values:
723 // 1. hour12
724 // 2. hour24
725 "hour_format": "hour12"
726 },
727 // Settings specific to the terminal
728 "terminal": {
729 // What shell to use when opening a terminal. May take 3 values:
730 // 1. Use the system's default terminal configuration in /etc/passwd
731 // "shell": "system"
732 // 2. A program:
733 // "shell": {
734 // "program": "sh"
735 // }
736 // 3. A program with arguments:
737 // "shell": {
738 // "with_arguments": {
739 // "program": "/bin/bash",
740 // "args": ["--login"]
741 // }
742 // }
743 "shell": "system",
744 // Where to dock terminals panel. Can be `left`, `right`, `bottom`.
745 "dock": "bottom",
746 // Default width when the terminal is docked to the left or right.
747 "default_width": 640,
748 // Default height when the terminal is docked to the bottom.
749 "default_height": 320,
750 // What working directory to use when launching the terminal.
751 // May take 4 values:
752 // 1. Use the current file's project directory. Will Fallback to the
753 // first project directory strategy if unsuccessful
754 // "working_directory": "current_project_directory"
755 // 2. Use the first project in this workspace's directory
756 // "working_directory": "first_project_directory"
757 // 3. Always use this platform's home directory (if we can find it)
758 // "working_directory": "always_home"
759 // 4. Always use a specific directory. This value will be shell expanded.
760 // If this path is not a valid directory the terminal will default to
761 // this platform's home directory (if we can find it)
762 // "working_directory": {
763 // "always": {
764 // "directory": "~/zed/projects/"
765 // }
766 // }
767 "working_directory": "current_project_directory",
768 // Set the cursor blinking behavior in the terminal.
769 // May take 3 values:
770 // 1. Never blink the cursor, ignoring the terminal mode
771 // "blinking": "off",
772 // 2. Default the cursor blink to off, but allow the terminal to
773 // set blinking
774 // "blinking": "terminal_controlled",
775 // 3. Always blink the cursor, ignoring the terminal mode
776 // "blinking": "on",
777 "blinking": "terminal_controlled",
778 // Default cursor shape for the terminal.
779 // 1. A block that surrounds the following character
780 // "block"
781 // 2. A vertical bar
782 // "bar"
783 // 3. An underline / underscore that runs along the following character
784 // "underline"
785 // 4. A box drawn around the following character
786 // "hollow"
787 //
788 // Default: not set, defaults to "block"
789 "cursor_shape": null,
790 // Set whether Alternate Scroll mode (code: ?1007) is active by default.
791 // Alternate Scroll mode converts mouse scroll events into up / down key
792 // presses when in the alternate screen (e.g. when running applications
793 // like vim or less). The terminal can still set and unset this mode.
794 // May take 2 values:
795 // 1. Default alternate scroll mode to on
796 // "alternate_scroll": "on",
797 // 2. Default alternate scroll mode to off
798 // "alternate_scroll": "off",
799 "alternate_scroll": "off",
800 // Set whether the option key behaves as the meta key.
801 // May take 2 values:
802 // 1. Rely on default platform handling of option key, on macOS
803 // this means generating certain unicode characters
804 // "option_as_meta": false,
805 // 2. Make the option keys behave as a 'meta' key, e.g. for emacs
806 // "option_as_meta": true,
807 "option_as_meta": false,
808 // Whether or not selecting text in the terminal will automatically
809 // copy to the system clipboard.
810 "copy_on_select": false,
811 // Whether to show the terminal button in the status bar
812 "button": true,
813 // Any key-value pairs added to this list will be added to the terminal's
814 // environment. Use `:` to separate multiple values.
815 "env": {
816 // "KEY": "value1:value2"
817 },
818 // Set the terminal's line height.
819 // May take 3 values:
820 // 1. Use a line height that's comfortable for reading, 1.618
821 // "line_height": "comfortable"
822 // 2. Use a standard line height, 1.3. This option is useful for TUIs,
823 // particularly if they use box characters
824 // "line_height": "standard",
825 // 3. Use a custom line height.
826 // "line_height": {
827 // "custom": 2
828 // },
829 "line_height": "comfortable",
830 // Activate the python virtual environment, if one is found, in the
831 // terminal's working directory (as resolved by the working_directory
832 // setting). Set this to "off" to disable this behavior.
833 "detect_venv": {
834 "on": {
835 // Default directories to search for virtual environments, relative
836 // to the current working directory. We recommend overriding this
837 // in your project's settings, rather than globally.
838 "directories": [".env", "env", ".venv", "venv"],
839 // Can also be `csh`, `fish`, `nushell` and `power_shell`
840 "activate_script": "default"
841 }
842 },
843 "toolbar": {
844 // Whether to display the terminal title in its toolbar's breadcrumbs.
845 // Only shown if the terminal title is not empty.
846 //
847 // The shell running in the terminal needs to be configured to emit the title.
848 // Example: `echo -e "\e]2;New Title\007";`
849 "breadcrumbs": true
850 }
851 // Set the terminal's font size. If this option is not included,
852 // the terminal will default to matching the buffer's font size.
853 // "font_size": 15,
854 // Set the terminal's font family. If this option is not included,
855 // the terminal will default to matching the buffer's font family.
856 // "font_family": "Zed Plex Mono",
857 // Set the terminal's font fallbacks. If this option is not included,
858 // the terminal will default to matching the buffer's font fallbacks.
859 // This will be merged with the platform's default font fallbacks
860 // "font_fallbacks": ["FiraCode Nerd Fonts"],
861 // Sets the maximum number of lines in the terminal's scrollback buffer.
862 // Default: 10_000, maximum: 100_000 (all bigger values set will be treated as 100_000), 0 disables the scrolling.
863 // Existing terminals will not pick up this change until they are recreated.
864 // "max_scroll_history_lines": 10000,
865 },
866 "code_actions_on_format": {},
867 /// Settings related to running tasks.
868 "tasks": {
869 "variables": {}
870 },
871 // An object whose keys are language names, and whose values
872 // are arrays of filenames or extensions of files that should
873 // use those languages.
874 //
875 // For example, to treat files like `foo.notjs` as JavaScript,
876 // and `Embargo.lock` as TOML:
877 //
878 // {
879 // "JavaScript": ["notjs"],
880 // "TOML": ["Embargo.lock"]
881 // }
882 //
883 "file_types": {
884 "Plain Text": ["txt"],
885 "JSONC": ["**/.zed/**/*.json", "**/zed/**/*.json", "**/Zed/**/*.json", "**/.vscode/**/*.json"],
886 "Shell Script": [".env.*"]
887 },
888 /// By default use a recent system version of node, or install our own.
889 /// You can override this to use a version of node that is not in $PATH with:
890 /// {
891 /// "node": {
892 /// "path": "/path/to/node"
893 /// "npm_path": "/path/to/npm" (defaults to node_path/../npm)
894 /// }
895 /// }
896 /// or to ensure Zed always downloads and installs an isolated version of node:
897 /// {
898 /// "node": {
899 /// "ignore_system_version": true,
900 /// }
901 /// NOTE: changing this setting currently requires restarting Zed.
902 "node": {},
903 // The extensions that Zed should automatically install on startup.
904 //
905 // If you don't want any of these extensions, add this field to your settings
906 // and change the value to `false`.
907 "auto_install_extensions": {
908 "html": true
909 },
910 // Different settings for specific languages.
911 "languages": {
912 "Astro": {
913 "language_servers": ["astro-language-server", "..."],
914 "prettier": {
915 "allowed": true,
916 "plugins": ["prettier-plugin-astro"]
917 }
918 },
919 "Blade": {
920 "prettier": {
921 "allowed": true
922 }
923 },
924 "C": {
925 "format_on_save": "off",
926 "use_on_type_format": false
927 },
928 "C++": {
929 "format_on_save": "off",
930 "use_on_type_format": false
931 },
932 "CSS": {
933 "prettier": {
934 "allowed": true
935 }
936 },
937 "Dart": {
938 "tab_size": 2
939 },
940 "Diff": {
941 "remove_trailing_whitespace_on_save": false,
942 "ensure_final_newline_on_save": false
943 },
944 "Elixir": {
945 "language_servers": ["elixir-ls", "!next-ls", "!lexical", "..."]
946 },
947 "Erlang": {
948 "language_servers": ["erlang-ls", "!elp", "..."]
949 },
950 "Go": {
951 "code_actions_on_format": {
952 "source.organizeImports": true
953 }
954 },
955 "GraphQL": {
956 "prettier": {
957 "allowed": true
958 }
959 },
960 "HEEX": {
961 "language_servers": ["elixir-ls", "!next-ls", "!lexical", "..."]
962 },
963 "HTML": {
964 "prettier": {
965 "allowed": true
966 }
967 },
968 "Java": {
969 "prettier": {
970 "allowed": true,
971 "plugins": ["prettier-plugin-java"]
972 }
973 },
974 "JavaScript": {
975 "language_servers": ["!typescript-language-server", "vtsls", "..."],
976 "prettier": {
977 "allowed": true
978 }
979 },
980 "JSON": {
981 "prettier": {
982 "allowed": true
983 }
984 },
985 "JSONC": {
986 "prettier": {
987 "allowed": true
988 }
989 },
990 "Markdown": {
991 "format_on_save": "off",
992 "use_on_type_format": false,
993 "prettier": {
994 "allowed": true
995 }
996 },
997 "PHP": {
998 "language_servers": ["phpactor", "!intelephense", "..."],
999 "prettier": {
1000 "allowed": true,
1001 "plugins": ["@prettier/plugin-php"],
1002 "parser": "php"
1003 }
1004 },
1005 "Ruby": {
1006 "language_servers": ["solargraph", "!ruby-lsp", "!rubocop", "..."]
1007 },
1008 "SCSS": {
1009 "prettier": {
1010 "allowed": true
1011 }
1012 },
1013 "SQL": {
1014 "prettier": {
1015 "allowed": true,
1016 "plugins": ["prettier-plugin-sql"]
1017 }
1018 },
1019 "Starlark": {
1020 "language_servers": ["starpls", "!buck2-lsp", "..."]
1021 },
1022 "Svelte": {
1023 "language_servers": ["svelte-language-server", "..."],
1024 "prettier": {
1025 "allowed": true,
1026 "plugins": ["prettier-plugin-svelte"]
1027 }
1028 },
1029 "TSX": {
1030 "language_servers": ["!typescript-language-server", "vtsls", "..."],
1031 "prettier": {
1032 "allowed": true
1033 }
1034 },
1035 "Twig": {
1036 "prettier": {
1037 "allowed": true
1038 }
1039 },
1040 "TypeScript": {
1041 "language_servers": ["!typescript-language-server", "vtsls", "..."],
1042 "prettier": {
1043 "allowed": true
1044 }
1045 },
1046 "Vue.js": {
1047 "language_servers": ["vue-language-server", "..."],
1048 "prettier": {
1049 "allowed": true
1050 }
1051 },
1052 "XML": {
1053 "prettier": {
1054 "allowed": true,
1055 "plugins": ["@prettier/plugin-xml"]
1056 }
1057 },
1058 "YAML": {
1059 "prettier": {
1060 "allowed": true
1061 }
1062 }
1063 },
1064 // Different settings for specific language models.
1065 "language_models": {
1066 "anthropic": {
1067 "version": "1",
1068 "api_url": "https://api.anthropic.com"
1069 },
1070 "google": {
1071 "api_url": "https://generativelanguage.googleapis.com"
1072 },
1073 "ollama": {
1074 "api_url": "http://localhost:11434"
1075 },
1076 "openai": {
1077 "version": "1",
1078 "api_url": "https://api.openai.com/v1"
1079 }
1080 },
1081 // Zed's Prettier integration settings.
1082 // Allows to enable/disable formatting with Prettier
1083 // and configure default Prettier, used when no project-level Prettier installation is found.
1084 "prettier": {
1085 // // Whether to consider prettier formatter or not when attempting to format a file.
1086 // "allowed": false,
1087 //
1088 // // Use regular Prettier json configuration.
1089 // // If Prettier is allowed, Zed will use this for its Prettier instance for any applicable file, if
1090 // // the project has no other Prettier installed.
1091 // "plugins": [],
1092 //
1093 // // Use regular Prettier json configuration.
1094 // // If Prettier is allowed, Zed will use this for its Prettier instance for any applicable file, if
1095 // // the project has no other Prettier installed.
1096 // "trailingComma": "es5",
1097 // "tabWidth": 4,
1098 // "semi": false,
1099 // "singleQuote": true
1100 },
1101 // LSP Specific settings.
1102 "lsp": {
1103 // Specify the LSP name as a key here.
1104 // "rust-analyzer": {
1105 // // These initialization options are merged into Zed's defaults
1106 // "initialization_options": {
1107 // "check": {
1108 // "command": "clippy" // rust-analyzer.check.command (default: "check")
1109 // }
1110 // }
1111 // }
1112 },
1113 // Jupyter settings
1114 "jupyter": {
1115 "enabled": true
1116 // Specify the language name as the key and the kernel name as the value.
1117 // "kernel_selections": {
1118 // "python": "conda-base"
1119 // "typescript": "deno"
1120 // }
1121 },
1122 // Vim settings
1123 "vim": {
1124 "toggle_relative_line_numbers": false,
1125 "use_system_clipboard": "always",
1126 "use_multiline_find": false,
1127 "use_smartcase_find": false,
1128 "custom_digraphs": {}
1129 },
1130 // The server to connect to. If the environment variable
1131 // ZED_SERVER_URL is set, it will override this setting.
1132 "server_url": "https://zed.dev",
1133 // Settings overrides to use when using Zed Preview.
1134 // Mostly useful for developers who are managing multiple instances of Zed.
1135 "preview": {
1136 // "theme": "Andromeda"
1137 },
1138 // Settings overrides to use when using Zed Nightly.
1139 // Mostly useful for developers who are managing multiple instances of Zed.
1140 "nightly": {
1141 // "theme": "Andromeda"
1142 },
1143 // Settings overrides to use when using Zed Stable.
1144 // Mostly useful for developers who are managing multiple instances of Zed.
1145 "stable": {
1146 // "theme": "Andromeda"
1147 },
1148 // Settings overrides to use when using Zed Dev.
1149 // Mostly useful for developers who are managing multiple instances of Zed.
1150 "dev": {
1151 // "theme": "Andromeda"
1152 },
1153 // Task-related settings.
1154 "task": {
1155 // Whether to show task status indicator in the status bar. Default: true
1156 "show_status_indicator": true
1157 },
1158 // Whether to show full labels in line indicator or short ones
1159 //
1160 // Values:
1161 // - `short`: "2 s, 15 l, 32 c"
1162 // - `long`: "2 selections, 15 lines, 32 characters"
1163 // Default: long
1164 "line_indicator_format": "long",
1165 // Set a proxy to use. The proxy protocol is specified by the URI scheme.
1166 //
1167 // Supported URI scheme: `http`, `https`, `socks4`, `socks4a`, `socks5`,
1168 // `socks5h`. `http` will be used when no scheme is specified.
1169 //
1170 // By default no proxy will be used, or Zed will try get proxy settings from
1171 // environment variables.
1172 //
1173 // Examples:
1174 // - "proxy": "socks5h://localhost:10808"
1175 // - "proxy": "http://127.0.0.1:10809"
1176 "proxy": null,
1177 // Set to configure aliases for the command palette.
1178 // When typing a query which is a key of this object, the value will be used instead.
1179 //
1180 // Examples:
1181 // {
1182 // "W": "workspace::Save"
1183 // }
1184 "command_aliases": {},
1185 // ssh_connections is an array of ssh connections.
1186 // You can configure these from `project: Open Remote` in the command palette.
1187 // Zed's ssh support will pull configuration from your ~/.ssh too.
1188 // Examples:
1189 // [
1190 // {
1191 // "host": "example-box",
1192 // // "port": 22, "username": "test", "args": ["-i", "/home/user/.ssh/id_rsa"]
1193 // "projects": [
1194 // {
1195 // "paths": ["/home/user/code/zed"]
1196 // }
1197 // ]
1198 // }
1199 // ]
1200 "ssh_connections": [],
1201 // Configures context servers for use in the Assistant.
1202 "context_servers": {}
1203}