1{
2 // The name of the Zed theme to use for the UI
3 "theme": "One Dark",
4 // The name of a base set of key bindings to use.
5 // This setting can take four values, each named after another
6 // text editor:
7 //
8 // 1. "VSCode"
9 // 2. "JetBrains"
10 // 3. "SublimeText"
11 // 4. "Atom"
12 "base_keymap": "VSCode",
13 // Features that can be globally enabled or disabled
14 "features": {
15 // Show Copilot icon in status bar
16 "copilot": true
17 },
18 // The name of a font to use for rendering text in the editor
19 "buffer_font_family": "Zed Mono",
20 // The OpenType features to enable for text in the editor.
21 "buffer_font_features": {
22 // Disable ligatures:
23 // "calt": false
24 },
25 // The default font size for text in the editor
26 "buffer_font_size": 15,
27 // Set the buffer's line height.
28 // May take 3 values:
29 // 1. Use a line height that's comfortable for reading (1.618)
30 // "line_height": "comfortable"
31 // 2. Use a standard line height, (1.3)
32 // "line_height": "standard",
33 // 3. Use a custom line height
34 // "line_height": {
35 // "custom": 2
36 // },
37 "buffer_line_height": "comfortable",
38 // The name of a font to use for rendering text in the UI
39 "ui_font_family": ".SystemUIFont",
40 // The OpenType features to enable for text in the UI
41 "ui_font_features": {
42 // Disable ligatures:
43 "calt": false
44 },
45 // The default font size for text in the UI
46 "ui_font_size": 16,
47 // The factor to grow the active pane by. Defaults to 1.0
48 // which gives the same size as all other panes.
49 "active_pane_magnification": 1.0,
50 // Centered layout related settings.
51 "centered_layout": {
52 // The relative width of the left padding of the central pane from the
53 // workspace when the centered layout is used.
54 "left_padding": 0.2,
55 // The relative width of the right padding of the central pane from the
56 // workspace when the centered layout is used.
57 "right_padding": 0.2
58 },
59 // The key to use for adding multiple cursors
60 // Currently "alt" or "cmd_or_ctrl" (also aliased as
61 // "cmd" and "ctrl") are supported.
62 "multi_cursor_modifier": "alt",
63 // Whether to enable vim modes and key bindings.
64 "vim_mode": false,
65 // Whether to show the informational hover box when moving the mouse
66 // over symbols in the editor.
67 "hover_popover_enabled": true,
68 // Whether to confirm before quitting Zed.
69 "confirm_quit": false,
70 // Whether to restore last closed project when fresh Zed instance is opened.
71 "restore_on_startup": "last_workspace",
72 // Size of the drop target in the editor.
73 "drop_target_size": 0.2,
74 // Whether the cursor blinks in the editor.
75 "cursor_blink": true,
76 // Whether to pop the completions menu while typing in an editor without
77 // explicitly requesting it.
78 "show_completions_on_input": true,
79 // Whether to display inline and alongside documentation for items in the
80 // completions menu
81 "show_completion_documentation": true,
82 // The debounce delay before re-querying the language server for completion
83 // documentation when not included in original completion list.
84 "completion_documentation_secondary_query_debounce": 300,
85 // Whether to show wrap guides in the editor. Setting this to true will
86 // show a guide at the 'preferred_line_length' value if 'soft_wrap' is set to
87 // 'preferred_line_length', and will show any additional guides as specified
88 // by the 'wrap_guides' setting.
89 "show_wrap_guides": true,
90 // Character counts at which to show wrap guides in the editor.
91 "wrap_guides": [],
92 // Hide the values of in variables from visual display in private files
93 "redact_private_values": false,
94 // Globs to match against file paths to determine if a file is private.
95 "private_files": [
96 "**/.env*",
97 "**/*.pem",
98 "**/*.key",
99 "**/*.cert",
100 "**/*.crt",
101 "**/secrets.yml"
102 ],
103 // Whether to use additional LSP queries to format (and amend) the code after
104 // every "trigger" symbol input, defined by LSP server capabilities.
105 "use_on_type_format": true,
106 // Whether to automatically add matching closing characters when typing
107 // opening parenthesis, bracket, brace, single or double quote characters.
108 // For example, when you type (, Zed will add a closing ) at the correct position.
109 "use_autoclose": true,
110 // Controls how the editor handles the autoclosed characters.
111 // When set to `false`(default), skipping over and auto-removing of the closing characters
112 // happen only for auto-inserted characters.
113 // Otherwise(when `true`), the closing characters are always skipped over and auto-removed
114 // no matter how they were inserted.
115 "always_treat_brackets_as_autoclosed": false,
116 // Controls whether copilot provides suggestion immediately
117 // or waits for a `copilot::Toggle`
118 "show_copilot_suggestions": true,
119 // Whether to show tabs and spaces in the editor.
120 // This setting can take three values:
121 //
122 // 1. Draw tabs and spaces only for the selected text (default):
123 // "selection"
124 // 2. Do not draw any tabs or spaces:
125 // "none"
126 // 3. Draw all invisible symbols:
127 // "all"
128 "show_whitespaces": "selection",
129 // Settings related to calls in Zed
130 "calls": {
131 // Join calls with the microphone live by default
132 "mute_on_join": false,
133 // Share your project when you are the first to join a channel
134 "share_on_join": true
135 },
136 // Toolbar related settings
137 "toolbar": {
138 // Whether to show breadcrumbs.
139 "breadcrumbs": true,
140 // Whether to show quick action buttons.
141 "quick_actions": true
142 },
143 // Scrollbar related settings
144 "scrollbar": {
145 // When to show the scrollbar in the editor.
146 // This setting can take four values:
147 //
148 // 1. Show the scrollbar if there's important information or
149 // follow the system's configured behavior (default):
150 // "auto"
151 // 2. Match the system's configured behavior:
152 // "system"
153 // 3. Always show the scrollbar:
154 // "always"
155 // 4. Never show the scrollbar:
156 // "never"
157 "show": "auto",
158 // Whether to show cursor positions in the scrollbar.
159 "cursors": true,
160 // Whether to show git diff indicators in the scrollbar.
161 "git_diff": true,
162 // Whether to show buffer search results in the scrollbar.
163 "search_results": true,
164 // Whether to show selected symbol occurrences in the scrollbar.
165 "selected_symbol": true,
166 // Whether to show diagnostic indicators in the scrollbar.
167 "diagnostics": true
168 },
169 // What to do when multibuffer is double clicked in some of its excerpts
170 // (parts of singleton buffers).
171 // May take 2 values:
172 // 1. Behave as a regular buffer and select the whole word (default).
173 // "double_click_in_multibuffer": "select"
174 // 2. Open the excerpt clicked as a new buffer in the new tab.
175 // "double_click_in_multibuffer": "open",
176 // For the case of "open", regular selection behavior can be achieved by holding `alt` when double clicking.
177 "double_click_in_multibuffer": "select",
178 "gutter": {
179 // Whether to show line numbers in the gutter.
180 "line_numbers": true,
181 // Whether to show code action buttons in the gutter.
182 "code_actions": true,
183 // Whether to show fold buttons in the gutter.
184 "folds": true
185 },
186 // The number of lines to keep above/below the cursor when scrolling.
187 "vertical_scroll_margin": 3,
188 // Scroll sensitivity multiplier. This multiplier is applied
189 // to both the horizontal and vertical delta values while scrolling.
190 "scroll_sensitivity": 1.0,
191 "relative_line_numbers": false,
192 // When to populate a new search's query based on the text under the cursor.
193 // This setting can take the following three values:
194 //
195 // 1. Always populate the search query with the word under the cursor (default).
196 // "always"
197 // 2. Only populate the search query when there is text selected
198 // "selection"
199 // 3. Never populate the search query
200 // "never"
201 "seed_search_query_from_cursor": "always",
202 // Inlay hint related settings
203 "inlay_hints": {
204 // Global switch to toggle hints on and off, switched off by default.
205 "enabled": false,
206 // Toggle certain types of hints on and off, all switched on by default.
207 "show_type_hints": true,
208 "show_parameter_hints": true,
209 // Corresponds to null/None LSP hint type value.
210 "show_other_hints": true,
211 // Time to wait after editing the buffer, before requesting the hints,
212 // set to 0 to disable debouncing.
213 "edit_debounce_ms": 700,
214 // Time to wait after scrolling the buffer, before requesting the hints,
215 // set to 0 to disable debouncing.
216 "scroll_debounce_ms": 50
217 },
218 "project_panel": {
219 // Whether to show the project panel button in the status bar
220 "button": true,
221 // Default width of the project panel.
222 "default_width": 240,
223 // Where to dock the project panel. Can be 'left' or 'right'.
224 "dock": "left",
225 // Whether to show file icons in the project panel.
226 "file_icons": true,
227 // Whether to show folder icons or chevrons for directories in the project panel.
228 "folder_icons": true,
229 // Whether to show the git status in the project panel.
230 "git_status": true,
231 // Amount of indentation for nested items.
232 "indent_size": 20,
233 // Whether to reveal it in the project panel automatically,
234 // when a corresponding project entry becomes active.
235 // Gitignored entries are never auto revealed.
236 "auto_reveal_entries": true,
237 /// Whether to fold directories automatically
238 /// when a directory has only one directory inside.
239 "auto_fold_dirs": false
240 },
241 "collaboration_panel": {
242 // Whether to show the collaboration panel button in the status bar.
243 "button": true,
244 // Where to dock the collaboration panel. Can be 'left' or 'right'.
245 "dock": "left",
246 // Default width of the collaboration panel.
247 "default_width": 240
248 },
249 "chat_panel": {
250 // Whether to show the chat panel button in the status bar.
251 "button": true,
252 // Where to the chat panel. Can be 'left' or 'right'.
253 "dock": "right",
254 // Default width of the chat panel.
255 "default_width": 240
256 },
257 "message_editor": {
258 // Whether to automatically replace emoji shortcodes with emoji characters.
259 // For example: typing `:wave:` gets replaced with `👋`.
260 "auto_replace_emoji_shortcode": true
261 },
262 "notification_panel": {
263 // Whether to show the notification panel button in the status bar.
264 "button": true,
265 // Where to dock the notification panel. Can be 'left' or 'right'.
266 "dock": "right",
267 // Default width of the notification panel.
268 "default_width": 380
269 },
270 "assistant": {
271 // Version of this setting.
272 "version": "1",
273 // Whether the assistant is enabled.
274 "enabled": true,
275 // Whether to show the assistant panel button in the status bar.
276 "button": true,
277 // Where to dock the assistant panel. Can be 'left', 'right' or 'bottom'.
278 "dock": "right",
279 // Default width when the assistant is docked to the left or right.
280 "default_width": 640,
281 // Default height when the assistant is docked to the bottom.
282 "default_height": 320,
283 // AI provider.
284 "provider": {
285 "name": "openai",
286 // The default model to use when starting new conversations. This
287 // setting can take three values:
288 //
289 // 1. "gpt-3.5-turbo"
290 // 2. "gpt-4"
291 // 3. "gpt-4-turbo-preview"
292 "default_model": "gpt-4-turbo-preview"
293 }
294 },
295 // Whether the screen sharing icon is shown in the os status bar.
296 "show_call_status_icon": true,
297 // Whether to use language servers to provide code intelligence.
298 "enable_language_server": true,
299 // The list of language servers to use (or disable) for all languages.
300 //
301 // This is typically customized on a per-language basis.
302 "language_servers": ["..."],
303 // When to automatically save edited buffers. This setting can
304 // take four values.
305 //
306 // 1. Never automatically save:
307 // "autosave": "off",
308 // 2. Save when changing focus away from the Zed window:
309 // "autosave": "on_window_change",
310 // 3. Save when changing focus away from a specific buffer:
311 // "autosave": "on_focus_change",
312 // 4. Save when idle for a certain amount of time:
313 // "autosave": { "after_delay": {"milliseconds": 500} },
314 "autosave": "off",
315 // Settings related to the editor's tab bar.
316 "tab_bar": {
317 // Whether or not to show the navigation history buttons.
318 "show_nav_history_buttons": true
319 },
320 // Settings related to the editor's tabs
321 "tabs": {
322 // Show git status colors in the editor tabs.
323 "git_status": false,
324 // Position of the close button on the editor tabs.
325 "close_position": "right"
326 },
327 // Settings related to preview tabs.
328 "preview_tabs": {
329 // Whether preview tabs should be enabled.
330 // Preview tabs allow you to open files in preview mode, where they close automatically
331 // when you switch to another file unless you explicitly pin them.
332 // This is useful for quickly viewing files without cluttering your workspace.
333 "enabled": true,
334 // Whether to open files in preview mode when selected from the file finder.
335 "enable_preview_from_file_finder": false
336 },
337 // Whether or not to remove any trailing whitespace from lines of a buffer
338 // before saving it.
339 "remove_trailing_whitespace_on_save": true,
340 // Whether to start a new line with a comment when a previous line is a comment as well.
341 "extend_comment_on_newline": true,
342 // Whether or not to ensure there's a single newline at the end of a buffer
343 // when saving it.
344 "ensure_final_newline_on_save": true,
345 // Whether or not to perform a buffer format before saving
346 "format_on_save": "on",
347 // How to perform a buffer format. This setting can take 4 values:
348 //
349 // 1. Format code using the current language server:
350 // "formatter": "language_server"
351 // 2. Format code using an external command:
352 // "formatter": {
353 // "external": {
354 // "command": "prettier",
355 // "arguments": ["--stdin-filepath", "{buffer_path}"]
356 // }
357 // }
358 // 3. Format code using Zed's Prettier integration:
359 // "formatter": "prettier"
360 // 4. Default. Format files using Zed's Prettier integration (if applicable),
361 // or falling back to formatting via language server:
362 // "formatter": "auto"
363 "formatter": "auto",
364 // How to soft-wrap long lines of text. This setting can take
365 // three values:
366 //
367 // 1. Do not soft wrap.
368 // "soft_wrap": "none",
369 // 2. Soft wrap lines that overflow the editor:
370 // "soft_wrap": "editor_width",
371 // 3. Soft wrap lines at the preferred line length
372 // "soft_wrap": "preferred_line_length",
373 "soft_wrap": "none",
374 // The column at which to soft-wrap lines, for buffers where soft-wrap
375 // is enabled.
376 "preferred_line_length": 80,
377 // Whether to indent lines using tab characters, as opposed to multiple
378 // spaces.
379 "hard_tabs": false,
380 // How many columns a tab should occupy.
381 "tab_size": 4,
382 // Control what info is collected by Zed.
383 "telemetry": {
384 // Send debug info like crash reports.
385 "diagnostics": true,
386 // Send anonymized usage data like what languages you're using Zed with.
387 "metrics": true
388 },
389 // Automatically update Zed
390 "auto_update": true,
391 // Diagnostics configuration.
392 "diagnostics": {
393 // Whether to show warnings or not by default.
394 "include_warnings": true
395 },
396 // Add files or globs of files that will be excluded by Zed entirely:
397 // they will be skipped during FS scan(s), file tree and file search
398 // will lack the corresponding file entries.
399 "file_scan_exclusions": [
400 "**/.git",
401 "**/.svn",
402 "**/.hg",
403 "**/CVS",
404 "**/.DS_Store",
405 "**/Thumbs.db",
406 "**/.classpath",
407 "**/.settings"
408 ],
409 // Git gutter behavior configuration.
410 "git": {
411 // Control whether the git gutter is shown. May take 2 values:
412 // 1. Show the gutter
413 // "git_gutter": "tracked_files"
414 // 2. Hide the gutter
415 // "git_gutter": "hide"
416 "git_gutter": "tracked_files",
417 // Control whether the git blame information is shown inline,
418 // in the currently focused line.
419 "inline_blame": {
420 "enabled": true
421 // Sets a delay after which the inline blame information is shown.
422 // Delay is restarted with every cursor movement.
423 // "delay_ms": 600
424 }
425 },
426 "copilot": {
427 // The set of glob patterns for which copilot should be disabled
428 // in any matching file.
429 "disabled_globs": [".env"]
430 },
431 // Settings specific to journaling
432 "journal": {
433 // The path of the directory where journal entries are stored
434 "path": "~",
435 // What format to display the hours in
436 // May take 2 values:
437 // 1. hour12
438 // 2. hour24
439 "hour_format": "hour12"
440 },
441 // Settings specific to the terminal
442 "terminal": {
443 // What shell to use when opening a terminal. May take 3 values:
444 // 1. Use the system's default terminal configuration in /etc/passwd
445 // "shell": "system"
446 // 2. A program:
447 // "shell": {
448 // "program": "sh"
449 // }
450 // 3. A program with arguments:
451 // "shell": {
452 // "with_arguments": {
453 // "program": "/bin/bash",
454 // "arguments": ["--login"]
455 // }
456 // }
457 "shell": "system",
458 // Where to dock terminals panel. Can be 'left', 'right', 'bottom'.
459 "dock": "bottom",
460 // Default width when the terminal is docked to the left or right.
461 "default_width": 640,
462 // Default height when the terminal is docked to the bottom.
463 "default_height": 320,
464 // What working directory to use when launching the terminal.
465 // May take 4 values:
466 // 1. Use the current file's project directory. Will Fallback to the
467 // first project directory strategy if unsuccessful
468 // "working_directory": "current_project_directory"
469 // 2. Use the first project in this workspace's directory
470 // "working_directory": "first_project_directory"
471 // 3. Always use this platform's home directory (if we can find it)
472 // "working_directory": "always_home"
473 // 4. Always use a specific directory. This value will be shell expanded.
474 // If this path is not a valid directory the terminal will default to
475 // this platform's home directory (if we can find it)
476 // "working_directory": {
477 // "always": {
478 // "directory": "~/zed/projects/"
479 // }
480 // }
481 "working_directory": "current_project_directory",
482 // Set the cursor blinking behavior in the terminal.
483 // May take 3 values:
484 // 1. Never blink the cursor, ignoring the terminal mode
485 // "blinking": "off",
486 // 2. Default the cursor blink to off, but allow the terminal to
487 // set blinking
488 // "blinking": "terminal_controlled",
489 // 3. Always blink the cursor, ignoring the terminal mode
490 // "blinking": "on",
491 "blinking": "terminal_controlled",
492 // Set whether Alternate Scroll mode (code: ?1007) is active by default.
493 // Alternate Scroll mode converts mouse scroll events into up / down key
494 // presses when in the alternate screen (e.g. when running applications
495 // like vim or less). The terminal can still set and unset this mode.
496 // May take 2 values:
497 // 1. Default alternate scroll mode to on
498 // "alternate_scroll": "on",
499 // 2. Default alternate scroll mode to off
500 // "alternate_scroll": "off",
501 "alternate_scroll": "off",
502 // Set whether the option key behaves as the meta key.
503 // May take 2 values:
504 // 1. Rely on default platform handling of option key, on macOS
505 // this means generating certain unicode characters
506 // "option_to_meta": false,
507 // 2. Make the option keys behave as a 'meta' key, e.g. for emacs
508 // "option_to_meta": true,
509 "option_as_meta": false,
510 // Whether or not selecting text in the terminal will automatically
511 // copy to the system clipboard.
512 "copy_on_select": false,
513 // Whether to show the terminal button in the status bar
514 "button": true,
515 // Any key-value pairs added to this list will be added to the terminal's
516 // environment. Use `:` to separate multiple values.
517 "env": {
518 // "KEY": "value1:value2"
519 },
520 // Set the terminal's line height.
521 // May take 3 values:
522 // 1. Use a line height that's comfortable for reading, 1.618
523 // "line_height": "comfortable"
524 // 2. Use a standard line height, 1.3. This option is useful for TUIs,
525 // particularly if they use box characters
526 // "line_height": "standard",
527 // 3. Use a custom line height.
528 // "line_height": {
529 // "custom": 2
530 // },
531 "line_height": "comfortable",
532 // Activate the python virtual environment, if one is found, in the
533 // terminal's working directory (as resolved by the working_directory
534 // setting). Set this to "off" to disable this behavior.
535 "detect_venv": {
536 "on": {
537 // Default directories to search for virtual environments, relative
538 // to the current working directory. We recommend overriding this
539 // in your project's settings, rather than globally.
540 "directories": [".env", "env", ".venv", "venv"],
541 // Can also be 'csh', 'fish', and `nushell`
542 "activate_script": "default"
543 }
544 },
545 "toolbar": {
546 // Whether to display the terminal title in its toolbar.
547 "title": true
548 }
549 // Set the terminal's font size. If this option is not included,
550 // the terminal will default to matching the buffer's font size.
551 // "font_size": 15,
552 // Set the terminal's font family. If this option is not included,
553 // the terminal will default to matching the buffer's font family.
554 // "font_family": "Zed Mono",
555 // Sets the maximum number of lines in the terminal's scrollback buffer.
556 // Default: 10_000, maximum: 100_000 (all bigger values set will be treated as 100_000), 0 disables the scrolling.
557 // Existing terminals will not pick up this change until they are recreated.
558 // "max_scroll_history_lines": 10000,
559 },
560 "code_actions_on_format": {},
561 // An object whose keys are language names, and whose values
562 // are arrays of filenames or extensions of files that should
563 // use those languages.
564 //
565 // For example, to treat files like `foo.notjs` as JavaScript,
566 // and 'Embargo.lock' as TOML:
567 //
568 // {
569 // "JavaScript": ["notjs"],
570 // "TOML": ["Embargo.lock"]
571 // }
572 //
573 "file_types": {},
574 // The extensions that Zed should automatically install on startup.
575 //
576 // If you don't want any of these extensions, add this field to your settings
577 // and change the value to `false`.
578 "auto_install_extensions": {
579 "html": true
580 },
581 // Different settings for specific languages.
582 "languages": {
583 "C++": {
584 "format_on_save": "off"
585 },
586 "C": {
587 "format_on_save": "off"
588 },
589 "Gleam": {
590 "tab_size": 2
591 },
592 "Go": {
593 "code_actions_on_format": {
594 "source.organizeImports": true
595 }
596 },
597 "Make": {
598 "hard_tabs": true
599 },
600 "Prisma": {
601 "tab_size": 2
602 }
603 },
604 // Zed's Prettier integration settings.
605 // If Prettier is enabled, Zed will use this for its Prettier instance for any applicable file, if
606 // project has no other Prettier installed.
607 "prettier": {
608 // Use regular Prettier json configuration:
609 // "trailingComma": "es5",
610 // "tabWidth": 4,
611 // "semi": false,
612 // "singleQuote": true
613 },
614 // LSP Specific settings.
615 "lsp": {
616 // Specify the LSP name as a key here.
617 // "rust-analyzer": {
618 // // These initialization options are merged into Zed's defaults
619 // "initialization_options": {
620 // "check": {
621 // "command": "clippy" // rust-analyzer.check.command (default: "check")
622 // }
623 // }
624 // }
625 },
626 // Vim settings
627 "vim": {
628 "use_system_clipboard": "always",
629 "use_multiline_find": false,
630 "use_smartcase_find": false
631 },
632 // The server to connect to. If the environment variable
633 // ZED_SERVER_URL is set, it will override this setting.
634 "server_url": "https://zed.dev",
635 // Settings overrides to use when using Zed Preview.
636 // Mostly useful for developers who are managing multiple instances of Zed.
637 "preview": {
638 // "theme": "Andromeda"
639 },
640 // Settings overrides to use when using Zed Nightly.
641 // Mostly useful for developers who are managing multiple instances of Zed.
642 "nightly": {
643 // "theme": "Andromeda"
644 },
645 // Settings overrides to use when using Zed Stable.
646 // Mostly useful for developers who are managing multiple instances of Zed.
647 "stable": {
648 // "theme": "Andromeda"
649 },
650 // Settings overrides to use when using Zed Dev.
651 // Mostly useful for developers who are managing multiple instances of Zed.
652 "dev": {
653 // "theme": "Andromeda"
654 },
655 // Task-related settings.
656 "task": {
657 // Whether to show task status indicator in the status bar. Default: true
658 "show_status_indicator": true
659 },
660 // Whether to show full labels in line indicator or short ones
661 //
662 // Values:
663 // - `short`: "2 s, 15 l, 32 c"
664 // - `long`: "2 selections, 15 lines, 32 characters"
665 // Default: long
666 "line_indicator_format": "long"
667}