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