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