default.json

  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 git diff indicators in the scrollbar.
159    "git_diff": true,
160    // Whether to show buffer search results in the scrollbar.
161    "search_results": true,
162    // Whether to show selected symbol occurrences in the scrollbar.
163    "selected_symbol": true,
164    // Whether to show diagnostic indicators in the scrollbar.
165    "diagnostics": true
166  },
167  // What to do when multibuffer is double clicked in some of its excerpts
168  // (parts of singleton buffers).
169  // May take 2 values:
170  //  1. Behave as a regular buffer and select the whole word (default).
171  //         "double_click_in_multibuffer": "select"
172  //  2. Open the excerpt clicked as a new buffer in the new tab.
173  //         "double_click_in_multibuffer": "open",
174  // For the case of "open", regular selection behavior can be achieved by holding `alt` when double clicking.
175  "double_click_in_multibuffer": "select",
176  "gutter": {
177    // Whether to show line numbers in the gutter.
178    "line_numbers": true,
179    // Whether to show code action buttons in the gutter.
180    "code_actions": true,
181    // Whether to show fold buttons in the gutter.
182    "folds": true
183  },
184  // The number of lines to keep above/below the cursor when scrolling.
185  "vertical_scroll_margin": 3,
186  // Scroll sensitivity multiplier. This multiplier is applied
187  // to both the horizontal and vertical delta values while scrolling.
188  "scroll_sensitivity": 1.0,
189  "relative_line_numbers": false,
190  // When to populate a new search's query based on the text under the cursor.
191  // This setting can take the following three values:
192  //
193  // 1. Always populate the search query with the word under the cursor (default).
194  //    "always"
195  // 2. Only populate the search query when there is text selected
196  //    "selection"
197  // 3. Never populate the search query
198  //    "never"
199  "seed_search_query_from_cursor": "always",
200  // Inlay hint related settings
201  "inlay_hints": {
202    // Global switch to toggle hints on and off, switched off by default.
203    "enabled": false,
204    // Toggle certain types of hints on and off, all switched on by default.
205    "show_type_hints": true,
206    "show_parameter_hints": true,
207    // Corresponds to null/None LSP hint type value.
208    "show_other_hints": true,
209    // Time to wait after editing the buffer, before requesting the hints,
210    // set to 0 to disable debouncing.
211    "edit_debounce_ms": 700,
212    // Time to wait after scrolling the buffer, before requesting the hints,
213    // set to 0 to disable debouncing.
214    "scroll_debounce_ms": 50
215  },
216  "project_panel": {
217    // Whether to show the project panel button in the status bar
218    "button": true,
219    // Default width of the project panel.
220    "default_width": 240,
221    // Where to dock the project panel. Can be 'left' or 'right'.
222    "dock": "left",
223    // Whether to show file icons in the project panel.
224    "file_icons": true,
225    // Whether to show folder icons or chevrons for directories in the project panel.
226    "folder_icons": true,
227    // Whether to show the git status in the project panel.
228    "git_status": true,
229    // Amount of indentation for nested items.
230    "indent_size": 20,
231    // Whether to reveal it in the project panel automatically,
232    // when a corresponding project entry becomes active.
233    // Gitignored entries are never auto revealed.
234    "auto_reveal_entries": true,
235    /// Whether to fold directories automatically
236    /// when a directory has only one directory inside.
237    "auto_fold_dirs": false
238  },
239  "collaboration_panel": {
240    // Whether to show the collaboration panel button in the status bar.
241    "button": true,
242    // Where to dock the collaboration panel. Can be 'left' or 'right'.
243    "dock": "left",
244    // Default width of the collaboration panel.
245    "default_width": 240
246  },
247  "chat_panel": {
248    // Whether to show the chat panel button in the status bar.
249    "button": true,
250    // Where to the chat panel. Can be 'left' or 'right'.
251    "dock": "right",
252    // Default width of the chat panel.
253    "default_width": 240
254  },
255  "message_editor": {
256    // Whether to automatically replace emoji shortcodes with emoji characters.
257    // For example: typing `:wave:` gets replaced with `👋`.
258    "auto_replace_emoji_shortcode": true
259  },
260  "notification_panel": {
261    // Whether to show the notification panel button in the status bar.
262    "button": true,
263    // Where to dock the notification panel. Can be 'left' or 'right'.
264    "dock": "right",
265    // Default width of the notification panel.
266    "default_width": 380
267  },
268  "assistant": {
269    // Version of this setting.
270    "version": "1",
271    // Whether the assistant is enabled.
272    "enabled": true,
273    // Whether to show the assistant panel button in the status bar.
274    "button": true,
275    // Where to dock the assistant panel. Can be 'left', 'right' or 'bottom'.
276    "dock": "right",
277    // Default width when the assistant is docked to the left or right.
278    "default_width": 640,
279    // Default height when the assistant is docked to the bottom.
280    "default_height": 320,
281    // AI provider.
282    "provider": {
283      "name": "openai",
284      // The default model to use when starting new conversations. This
285      // setting can take three values:
286      //
287      // 1. "gpt-3.5-turbo"
288      // 2. "gpt-4"
289      // 3. "gpt-4-turbo-preview"
290      "default_model": "gpt-4-turbo-preview"
291    }
292  },
293  // Whether the screen sharing icon is shown in the os status bar.
294  "show_call_status_icon": true,
295  // Whether to use language servers to provide code intelligence.
296  "enable_language_server": true,
297  // The list of language servers to use (or disable) for all languages.
298  //
299  // This is typically customized on a per-language basis.
300  "language_servers": ["..."],
301  // When to automatically save edited buffers. This setting can
302  // take four values.
303  //
304  // 1. Never automatically save:
305  //     "autosave": "off",
306  // 2. Save when changing focus away from the Zed window:
307  //     "autosave": "on_window_change",
308  // 3. Save when changing focus away from a specific buffer:
309  //     "autosave": "on_focus_change",
310  // 4. Save when idle for a certain amount of time:
311  //     "autosave": { "after_delay": {"milliseconds": 500} },
312  "autosave": "off",
313  // Settings related to the editor's tab bar.
314  "tab_bar": {
315    // Whether or not to show the navigation history buttons.
316    "show_nav_history_buttons": true
317  },
318  // Settings related to the editor's tabs
319  "tabs": {
320    // Show git status colors in the editor tabs.
321    "git_status": false,
322    // Position of the close button on the editor tabs.
323    "close_position": "right"
324  },
325  // Settings related to preview tabs.
326  "preview_tabs": {
327    // Whether preview tabs should be enabled.
328    // Preview tabs allow you to open files in preview mode, where they close automatically
329    // when you switch to another file unless you explicitly pin them.
330    // This is useful for quickly viewing files without cluttering your workspace.
331    "enabled": true,
332    // Whether to open files in preview mode when selected from the file finder.
333    "enable_preview_from_file_finder": false
334  },
335  // Whether or not to remove any trailing whitespace from lines of a buffer
336  // before saving it.
337  "remove_trailing_whitespace_on_save": true,
338  // Whether to start a new line with a comment when a previous line is a comment as well.
339  "extend_comment_on_newline": true,
340  // Whether or not to ensure there's a single newline at the end of a buffer
341  // when saving it.
342  "ensure_final_newline_on_save": true,
343  // Whether or not to perform a buffer format before saving
344  "format_on_save": "on",
345  // How to perform a buffer format. This setting can take 4 values:
346  //
347  // 1. Format code using the current language server:
348  //     "formatter": "language_server"
349  // 2. Format code using an external command:
350  //     "formatter": {
351  //       "external": {
352  //         "command": "prettier",
353  //         "arguments": ["--stdin-filepath", "{buffer_path}"]
354  //       }
355  //     }
356  // 3. Format code using Zed's Prettier integration:
357  //     "formatter": "prettier"
358  // 4. Default. Format files using Zed's Prettier integration (if applicable),
359  //    or falling back to formatting via language server:
360  //     "formatter": "auto"
361  "formatter": "auto",
362  // How to soft-wrap long lines of text. This setting can take
363  // three values:
364  //
365  // 1. Do not soft wrap.
366  //      "soft_wrap": "none",
367  // 2. Soft wrap lines that overflow the editor:
368  //      "soft_wrap": "editor_width",
369  // 3. Soft wrap lines at the preferred line length
370  //      "soft_wrap": "preferred_line_length",
371  "soft_wrap": "none",
372  // The column at which to soft-wrap lines, for buffers where soft-wrap
373  // is enabled.
374  "preferred_line_length": 80,
375  // Whether to indent lines using tab characters, as opposed to multiple
376  // spaces.
377  "hard_tabs": false,
378  // How many columns a tab should occupy.
379  "tab_size": 4,
380  // Control what info is collected by Zed.
381  "telemetry": {
382    // Send debug info like crash reports.
383    "diagnostics": true,
384    // Send anonymized usage data like what languages you're using Zed with.
385    "metrics": true
386  },
387  // Automatically update Zed
388  "auto_update": true,
389  // Diagnostics configuration.
390  "diagnostics": {
391    // Whether to show warnings or not by default.
392    "include_warnings": true
393  },
394  // Add files or globs of files that will be excluded by Zed entirely:
395  // they will be skipped during FS scan(s), file tree and file search
396  // will lack the corresponding file entries.
397  "file_scan_exclusions": [
398    "**/.git",
399    "**/.svn",
400    "**/.hg",
401    "**/CVS",
402    "**/.DS_Store",
403    "**/Thumbs.db",
404    "**/.classpath",
405    "**/.settings"
406  ],
407  // Git gutter behavior configuration.
408  "git": {
409    // Control whether the git gutter is shown. May take 2 values:
410    // 1. Show the gutter
411    //      "git_gutter": "tracked_files"
412    // 2. Hide the gutter
413    //      "git_gutter": "hide"
414    "git_gutter": "tracked_files",
415    // Control whether the git blame information is shown inline,
416    // in the currently focused line.
417    "inline_blame": {
418      "enabled": true
419      // Sets a delay after which the inline blame information is shown.
420      // Delay is restarted with every cursor movement.
421      // "delay_ms": 600
422    }
423  },
424  "copilot": {
425    // The set of glob patterns for which copilot should be disabled
426    // in any matching file.
427    "disabled_globs": [".env"]
428  },
429  // Settings specific to journaling
430  "journal": {
431    // The path of the directory where journal entries are stored
432    "path": "~",
433    // What format to display the hours in
434    // May take 2 values:
435    // 1. hour12
436    // 2. hour24
437    "hour_format": "hour12"
438  },
439  // Settings specific to the terminal
440  "terminal": {
441    // What shell to use when opening a terminal. May take 3 values:
442    // 1. Use the system's default terminal configuration in /etc/passwd
443    //      "shell": "system"
444    // 2. A program:
445    //      "shell": {
446    //        "program": "sh"
447    //      }
448    // 3. A program with arguments:
449    //     "shell": {
450    //         "with_arguments": {
451    //           "program": "/bin/bash",
452    //           "arguments": ["--login"]
453    //         }
454    //     }
455    "shell": "system",
456    // Where to dock terminals panel. Can be 'left', 'right', 'bottom'.
457    "dock": "bottom",
458    // Default width when the terminal is docked to the left or right.
459    "default_width": 640,
460    // Default height when the terminal is docked to the bottom.
461    "default_height": 320,
462    // What working directory to use when launching the terminal.
463    // May take 4 values:
464    // 1. Use the current file's project directory.  Will Fallback to the
465    //    first project directory strategy if unsuccessful
466    //      "working_directory": "current_project_directory"
467    // 2. Use the first project in this workspace's directory
468    //      "working_directory": "first_project_directory"
469    // 3. Always use this platform's home directory (if we can find it)
470    //     "working_directory": "always_home"
471    // 4. Always use a specific directory. This value will be shell expanded.
472    //    If this path is not a valid directory the terminal will default to
473    //    this platform's home directory  (if we can find it)
474    //      "working_directory": {
475    //        "always": {
476    //          "directory": "~/zed/projects/"
477    //        }
478    //      }
479    "working_directory": "current_project_directory",
480    // Set the cursor blinking behavior in the terminal.
481    // May take 3 values:
482    //  1. Never blink the cursor, ignoring the terminal mode
483    //         "blinking": "off",
484    //  2. Default the cursor blink to off, but allow the terminal to
485    //     set blinking
486    //         "blinking": "terminal_controlled",
487    //  3. Always blink the cursor, ignoring the terminal mode
488    //         "blinking": "on",
489    "blinking": "terminal_controlled",
490    // Set whether Alternate Scroll mode (code: ?1007) is active by default.
491    // Alternate Scroll mode converts mouse scroll events into up / down key
492    // presses when in the alternate screen (e.g. when running applications
493    // like vim or  less). The terminal can still set and unset this mode.
494    // May take 2 values:
495    //  1. Default alternate scroll mode to on
496    //         "alternate_scroll": "on",
497    //  2. Default alternate scroll mode to off
498    //         "alternate_scroll": "off",
499    "alternate_scroll": "off",
500    // Set whether the option key behaves as the meta key.
501    // May take 2 values:
502    //  1. Rely on default platform handling of option key, on macOS
503    //     this means generating certain unicode characters
504    //         "option_to_meta": false,
505    //  2. Make the option keys behave as a 'meta' key, e.g. for emacs
506    //         "option_to_meta": true,
507    "option_as_meta": false,
508    // Whether or not selecting text in the terminal will automatically
509    // copy to the system clipboard.
510    "copy_on_select": false,
511    // Whether to show the terminal button in the status bar
512    "button": true,
513    // Any key-value pairs added to this list will be added to the terminal's
514    // environment. Use `:` to separate multiple values.
515    "env": {
516      // "KEY": "value1:value2"
517    },
518    // Set the terminal's line height.
519    // May take 3 values:
520    //  1. Use a line height that's comfortable for reading, 1.618
521    //         "line_height": "comfortable"
522    //  2. Use a standard line height, 1.3. This option is useful for TUIs,
523    //      particularly if they use box characters
524    //         "line_height": "standard",
525    //  3. Use a custom line height.
526    //         "line_height": {
527    //           "custom": 2
528    //         },
529    "line_height": "comfortable",
530    // Activate the python virtual environment, if one is found, in the
531    // terminal's working directory (as resolved by the working_directory
532    // setting). Set this to "off" to disable this behavior.
533    "detect_venv": {
534      "on": {
535        // Default directories to search for virtual environments, relative
536        // to the current working directory. We recommend overriding this
537        // in your project's settings, rather than globally.
538        "directories": [".env", "env", ".venv", "venv"],
539        // Can also be 'csh', 'fish', and `nushell`
540        "activate_script": "default"
541      }
542    },
543    "toolbar": {
544      // Whether to display the terminal title in its toolbar.
545      "title": true
546    }
547    // Set the terminal's font size. If this option is not included,
548    // the terminal will default to matching the buffer's font size.
549    // "font_size": 15,
550    // Set the terminal's font family. If this option is not included,
551    // the terminal will default to matching the buffer's font family.
552    // "font_family": "Zed Mono",
553    // Sets the maximum number of lines in the terminal's scrollback buffer.
554    // Default: 10_000, maximum: 100_000 (all bigger values set will be treated as 100_000), 0 disables the scrolling.
555    // Existing terminals will not pick up this change until they are recreated.
556    // "max_scroll_history_lines": 10000,
557  },
558  "code_actions_on_format": {},
559  // An object whose keys are language names, and whose values
560  // are arrays of filenames or extensions of files that should
561  // use those languages.
562  //
563  // For example, to treat files like `foo.notjs` as JavaScript,
564  // and 'Embargo.lock' as TOML:
565  //
566  // {
567  //   "JavaScript": ["notjs"],
568  //   "TOML": ["Embargo.lock"]
569  // }
570  //
571  "file_types": {},
572  // The extensions that Zed should automatically install on startup.
573  //
574  // If you don't want any of these extensions, add this field to your settings
575  // and change the value to `false`.
576  "auto_install_extensions": {
577    "html": true
578  },
579  // Different settings for specific languages.
580  "languages": {
581    "C++": {
582      "format_on_save": "off"
583    },
584    "C": {
585      "format_on_save": "off"
586    },
587    "Gleam": {
588      "tab_size": 2
589    },
590    "Go": {
591      "code_actions_on_format": {
592        "source.organizeImports": true
593      }
594    },
595    "Make": {
596      "hard_tabs": true
597    },
598    "Prisma": {
599      "tab_size": 2
600    }
601  },
602  // Zed's Prettier integration settings.
603  // If Prettier is enabled, Zed will use this for its Prettier instance for any applicable file, if
604  // project has no other Prettier installed.
605  "prettier": {
606    // Use regular Prettier json configuration:
607    // "trailingComma": "es5",
608    // "tabWidth": 4,
609    // "semi": false,
610    // "singleQuote": true
611  },
612  // LSP Specific settings.
613  "lsp": {
614    // Specify the LSP name as a key here.
615    // "rust-analyzer": {
616    //     // These initialization options are merged into Zed's defaults
617    //     "initialization_options": {
618    //         "check": {
619    //             "command": "clippy" // rust-analyzer.check.command (default: "check")
620    //         }
621    //     }
622    // }
623  },
624  // Vim settings
625  "vim": {
626    "use_system_clipboard": "always",
627    "use_multiline_find": false,
628    "use_smartcase_find": false
629  },
630  // The server to connect to. If the environment variable
631  // ZED_SERVER_URL is set, it will override this setting.
632  "server_url": "https://zed.dev",
633  // Settings overrides to use when using Zed Preview.
634  // Mostly useful for developers who are managing multiple instances of Zed.
635  "preview": {
636    // "theme": "Andromeda"
637  },
638  // Settings overrides to use when using Zed Nightly.
639  // Mostly useful for developers who are managing multiple instances of Zed.
640  "nightly": {
641    // "theme": "Andromeda"
642  },
643  // Settings overrides to use when using Zed Stable.
644  // Mostly useful for developers who are managing multiple instances of Zed.
645  "stable": {
646    // "theme": "Andromeda"
647  },
648  // Settings overrides to use when using Zed Dev.
649  // Mostly useful for developers who are managing multiple instances of Zed.
650  "dev": {
651    // "theme": "Andromeda"
652  },
653  // Task-related settings.
654  "task": {
655    // Whether to show task status indicator in the status bar. Default: true
656    "show_status_indicator": true
657  },
658  // Whether to show full labels in line indicator or short ones
659  //
660  // Values:
661  //   - `short`: "2 s, 15 l, 32 c"
662  //   - `long`: "2 selections, 15 lines, 32 characters"
663  // Default: long
664  "line_indicator_format": "long"
665}