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