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