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