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